index :: fx

fx.tremolo~

tremolo effect from guitarix project

available since version: 0.9.7

---

arguments:

• FREQ tremolo frequency
  type: float
  units: Hz
  

• DEPTH effect depth
  type: float
  

methods:

• reset reset to initial state
  

properties:

• @freq Get/set tremolo frequency
  type: float
  units: Hz
  range: 0.1..50
  default: 5
  

• @depth Get/set effect depth
  type: float
  range: 0..1
  default: 1
  

• @src Get/set modulation source: 0 (triangle), 1 (sin) or 2 (square)
  type: int
  range: 0..2
  default: 0
  

• @drywet Get/set proportion of mix between the original (dry) and 'effected' (wet) signals. 0 - dry signal, 1 - wet
  type: float
  range: 0..1
  default: 0.75
  

• @bypass Get/set bypass flag. If true: bypass 'effected' signal.
  type: bool
  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/fx_tremolo/PROP_NAME osc address, if empty bind to /fx_tremolo/PROP_NAME.
  type: symbol
  

inlets:

• input signal
  type: audio
• set frequency (Hz)
  type: control

outlets:

• output signal
  type: audio

keywords:

fx tremolo

Authors: Serge Poltavsky

License: GPL3 or later