index :: fx

fx.distortion3~

simple distortion #3 from Guitarix effects set

available since version: 0.7

---

methods:

• reset reset object
  

properties:

• @gain Get/set total effect gain
  type: float
  units: db
  range: -30..10
  default: 0
  

• @drive Get/set distortion amount
  type: float
  range: 0..1
  default: 0.5
  

• @lp_freq Get/set low pass frequency
  type: float
  units: Hz
  range: 1000..20000
  default: 10000
  

• @hp_freq Get/set high pass frequency
  type: float
  units: Hz
  range: 20..2000
  default: 30
  

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

• @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: 1
  

• @bypass Get/set bypass flag. If true: bypass 'effected' signal.
  type: bool
  default: 0
  

• @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_distortion3/PROP_NAME osc address, if empty bind to /fx_distortion3/PROP_NAME.
  type: symbol
  

inlets:

• input signal
  type: audio

outlets:

• output signal
  type: audio

keywords:

fx distortion

See also: [fx.distortion~] [fx.distortion1~] [fx.distortion2~]

Authors: Serge Poltavsky

License: GPL3 or later