index :: fx

fx.distortion~

cubic nonlinearity distortion

available since version: 0.2

---

arguments:

• DRIVE distortion amount
  type: float
  

• OFFSET constant added before nonlinearity to give even harmonics
  type: float
  

methods:

• reset reset object
  

properties:

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

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

• @offset Get/set constant added before nonlinearity to give even harmonics
  type: float
  range: 0..0.5
  default: 0
  

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

inlets:

• input signal
  type: audio

outlets:

• output signal
  type: audio

keywords:

fx distortion

Authors: Serge Poltavsky

License: GPL3 or later