SynthLab SDK
SynthLab::KSOscParameters Struct Reference

Custom parameter structure for the Karplus-Strong oscillator and its cores. Notable members: More...

#include <synthlabparams.h>

Public Attributes

uint32_t algorithmIndex = 0
 GUI index for KS algorithm.
 
double attackTime_mSec = 0.0
 exciter EG
 
double holdTime_mSec = 0.0
 exciter EG
 
double releaseTime_mSec = 0.0
 exciter EG
 
double octaveDetune = 0.0
 1 = up one octave, -1 = down one octave
 
double coarseDetune = 0.0
 1 = up one octave, -1 = down one octave
 
double fineDetune = 0.0
 1 = up one half-step, -1 = down one half-step
 
double unisonDetune = 0.0
 1 = up one cent, -1 = down one cent
 
double outputAmplitude_dB = 0.0
 dB
 
double oscillatorShape = 0.0
 / [-1, +1]
 
double hardSyncRatio = 1.00
 [1, +4]
 
double phaseModIndex = 1.0
 / [1, +4]
 
double freqModIndex = 1.0
 [1, +4]
 
double panValue = 0.0
 [-1, +1]
 
double decay = 0.9
 [-1, +1]
 
uint32_t pluckPosition = 1
 [+1, +12]
 
double modKnobValue [4] = { 0.5, 0.0, 0.0, 0.0 }
 mod knob values
 
uint32_t moduleIndex = 0
 

Detailed Description

Custom parameter structure for the Karplus-Strong oscillator and its cores. Notable members:

  • algorithmIndex is the index from the GUI selection control for the plucked string algorithm
  • pluckPosition is the fraction of a string for the pluck; at the highest setting the pluck is in the center of the string; as this value is reduced the pluck position moves closer and closer to the bridge. At the minimum position, you are 1/12 the string length from the bridge.
  • includes EG contros for the exciter shaper
  • modKnobValue[4] are the four mod knob values
Author
Will Pirkle http://www.willpirkle.com
Remarks
This object is included in Designing Software Synthesizer Plugins in C++ 2nd Ed. by Will Pirkle
Version
Revision : 1.0
Date
Date : 2021 / 05 / 02

The documentation for this struct was generated from the following file: