index :: synth

synth.ks~

Karplus-Strong string

available since version: 0.6

---

methods:

• note note on/off message
  parameters:

  • NOTE midi note
    type: float
    required: True
    

  • VEL velocity
    type: float
    required: True
    

properties:

• @pitch Get/set midi pitch
  type: float
  range: 36..84
  default: 48
  

• @freq Get/set frequency
  type: float
  units: Hz
  default: 130.8128
  

• @pos Get/set pluck position (1 is on the bridge)
  type: float
  range: 0..1
  default: 0.7
  

• @mute Get/set mute coefficient (0 for no mute and 1 for instant mute)
  type: float
  range: 0..1
  default: 0
  

• @gain Get/set pluck gain
  type: float
  range: 0..1
  default: 1
  

• @sharp Get/set pluck sharpness
  type: float
  range: 0.01..1
  default: 0.25
  

• @cutoff Get/set cutoff coefficent (for low pass filter)
  type: float
  range: 0.1..1
  default: 1
  

• @mode Get/set excitation mode: 0 - impulse, 1 - pluck, 2 - strike
  type: int
  range: 0..2
  default: 1
  

• @gate Get/set play trigger - 1: on, 0: off
  type: float
  range: 0..1
  default: 0
  

• @active Get/set on/off dsp processing
  type: bool
  default: 1
  

• @osc (initonly) Get/set OSC server name to listen
  type: symbol
  

• @id (initonly) Get/set OSC address id. If specified, bind all properties to /ID/synth_ks/PROP_NAME osc address, if empty bind to /synth_ks/PROP_NAME.
  type: symbol
  

inlets:

• NOTE VEL
  type: control

outlets:

• synth output
  type: audio

keywords:

karplus strong

Authors: Serge Poltavsky

License: GPL3 or later