index :: env

env.adsr~

ADSR (Attack, Decay, Sustain, Release) envelope generator

available since version: 0.7

---

arguments:

• ATTACK attack time
  type: float
  units: ms
  

• DECAY decay time
  type: float
  units: ms
  

• SUSTAIN sustain level (percentage of trigger)
  type: float
  units: %
  

• RELEASE release time
  type: float
  units: ms
  

methods:

• play runs envelope and release it after specified time
  parameters:
  • [DUR] duration
    type: float
    
• reset reset envelope to initial state
  

properties:

• @attack Get/set attack time
  type: float
  units: ms
  range: 0..100000
  default: 10
  

• @decay Get/set decay time
  type: float
  units: ms
  range: 0..100000
  default: 10
  

• @sustain Get/set sustain level - percent from trigger signal
  type: float
  units: %
  range: 0..100
  default: 50
  

• @release Get/set release time
  type: float
  units: ms
  range: 0..100000
  default: 300
  

• @gate Get/set trigger. If > 0 - starts envelope.
  type: float
  range: 0..1
  default: 0
  

• @adsr (readonly) Get attack decay sustain release tuple
  type: list
  

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

inlets:

• input signal
  type: audio

outlets:

• output signal with applied envelope
  type: audio
• outputs 1 when attack/decay phase finished, 0 - when release phase finished
  type: control

keywords:

envelope adsr

Authors: Serge Poltavsky

License: GPL3 or later