live.adsr~ Reference

ADSR envelope generator

live.adsr~

Examples

Arguments

attack time [number]

Optional

The initial attack time of the envelope in milliseconds.

decay time [number]

Optional

The initial decay time of the envelope in milliseconds.

sustain [number]

Optional

The sustain of the envelope, as a factor of the amplitude. For example, a value of 0.5 means the sustain level will be half of the amplitude height.

release time [number]

Optional

The initial release time of the envelope in milliseconds.

Attributes

decay_slope [float64]

The shape of the decay envelope segment. Ranging from -1 to 1., positive and negative values create curves. A value of 0 is linear.

release_time [float64]

The length of time taken to arrive at the final value after the trigger is turned off (e.g. a MIDI noteoff message is received).

decay_time [float64]

The length of time taken between the peak value and the sustain level.

attack_slope [float64]

The shape of the attack envelope segment. Ranging from -1 to 1., positive and negative values create curves. A value of 0 is linear.

attack_time [float64]

The initial attack time of the envelope in milliseconds.

sustain [float64]

The level reached at the end of the decay stage, as a factor of the amplitude. For example, a value of 0.5 means the sustain level will be half of the amplitude height. The value will remain at this level until triggered off (e.g. by a MIDI noteoff) unless it is in loop, sync, or beat mode.

release_slope [float64]

The shape of the release envelope segment. Ranging from -1 to 1., positive and negative values create curves. A value of 0 is linear.

final [float64]

The value of the envelope at the end of the release stage.

peak [float64]

The value at end of the attack stage, and the beginning of the decay stage.

initial [float64]

The value the ADSR starts at.

loop_mode [long]

The envelope loop behavior. Modes include:

  • none: No looping, just attack, decay, sustain, and release
  • trigger: No looping and skip the sustain - a one-shot trigger. Trigger mode cannot be released early, i.e. releasing during attack will have no effect - the envelope will continue to play the decay and release.
  • loop: Loop through attack, decay, and release - a looping trigger. Releases like a normal envelope, i.e. releasing during an attack will start the release stage before finishing.

Common Box Attributes

Messages

list

Sending a list to the leftmost inlet sets all ADSR envelope values simultaneously.

float

A number sets the attribute associated with the inlet.

See Also

Name Description
live.adsrui
adsr~