index :: fx

fx.shimmer~

shimmer reverb effect effect

available since version: 0.9.4

---

arguments:

• DECAY_LOW time to decay 60dB in low-frequency band
  type: float
  units: sec
  

• DECAY_MID time to decay 60dB in mid-frequency band
  type: float
  units: sec
  

methods:

• reset reset to initial state
  

properties:

• @decay_low Get/set time (in seconds) to decay 60dB in low-frequency band
  type: float
  units: sec
  range: 1..8
  default: 3
  

• @decay_mid Get/set time (in seconds) to decay 60dB in mid-frequency band
  type: float
  units: sec
  range: 1..8
  default: 2
  

• @freq_low Get/set Crossover frequency (Hz) separating low and middle frequencies
  type: float
  units: Hz
  range: 50..1000
  default: 200
  

• @damp_hf Get/set Frequency (Hz) at which the high-frequency T60 is half the middle-band's T60
  type: float
  units: Hz
  range: 1500..47040
  default: 6000
  

• @envelope Get/set amplitude-envelope time-constant going down
  type: float
  units: sec
  range: 0.1..3
  default: 1
  

• @shift Get/set frequency shifting
  type: float
  units: semitone
  range: -12..12
  default: 12
  

• @depth Get/set pitchshift modulation amplitude
  type: float
  range: 0..1
  default: 0
  

• @speed Get/set pitchshift modulation frequency
  type: float
  units: Hz
  range: 0.1..10
  default: 0.1
  

• @control Get/set envelope follower to pitch shifter influence coefficient
  type: float
  range: 0..1
  default: 0.5
  

• @ps_drywet Get/set proportion of mix between original and pitchshift signal in shimmer feedback
  type: float
  range: 0..1
  default: 0.5
  

• @mode Get/set correlation between pitchshift
  type: int
  range: -3..3
  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.5
  

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

inlets:

• input signal
  type: audio
• input signal
  type: audio

outlets:

• output signal
  type: audio
• output signal
  type: audio

keywords:

fx echo shimmer reverb

Authors: thedrgreenthumb, Serge Poltavsky

License: GPL3 or later