RNBO Objects & Operators adsr~
Open Help

adsr~

Attack-Decay-Sustain-Release envelope generator

Description

Attack-Decay-Sustain-Release envelope generator

Arguments

attack [auto]

Optional

Attack of the ADSR. The duration in ms of the attack portion of the envelope. This is the time it takes for the incoming signal to go from silence to full volume.

decay [auto]

Optional

Decay of the ADSR. The duration in ms of the decay portion of the envelope. How long it takes for the input signal to reach the gain level specified by the sustain attribute.

sustain [auto]

Optional

The gain (0. - 1.) of the sustain portion of the envelope. This is the gain, or loudness, of the decay that will be maintained after the decay portion of the envelope until the release is triggered.

release [auto]

Optional

Release of the ADSR. The duration in ms of the release portion of the envelope. This is the time it takes to go from the sustain level to silence.

Inlets

trigger [number, signal]

Send a non-zero value to sample accurately trigger an ADSR curve.

attack [auto]

Attack of the ADSR. The duration in ms of the attack portion of the envelope. This is the time it takes for the incoming signal to go from silence to full volume.

decay [auto]

Decay of the ADSR. The duration in ms of the decay portion of the envelope. How long it takes for the input signal to reach the gain level specified by the sustain attribute.

sustain [auto]

The gain (0. - 1.) of the sustain portion of the envelope. This is the gain, or loudness, of the decay that will be maintained after the decay portion of the envelope until the release is triggered.

release [auto]

Release of the ADSR. The duration in ms of the release portion of the envelope. This is the time it takes to go from the sustain level to silence.

Outlets

out [signal]

out

mute [bang]

Bang after envelope finished.

Dynamic Attributes

These attributes can be modified in the code during execution using the set object

attack [auto]

Attack of the ADSR. The duration in ms of the attack portion of the envelope. This is the time it takes for the incoming signal to go from silence to full volume.

decay [auto]

Decay of the ADSR. The duration in ms of the decay portion of the envelope. How long it takes for the input signal to reach the gain level specified by the sustain attribute.

legato [bool] (default: false)

Start retriggered attack on current value.

maxsustain [number] (default: -1)

Sets the maximum amount of time that the envelope will remain in the sustain stage. A negative number sets no maximum; the envelope will remain forever in the sustain stage until a note-off is received. The default is -1. To create a simple three-stage sustainless envelope (an ADR), you can use the message 'maxsustain 0'.

release [auto]

Release of the ADSR. The duration in ms of the release portion of the envelope. This is the time it takes to go from the sustain level to silence.

sustain [auto]

The gain (0. - 1.) of the sustain portion of the envelope. This is the gain, or loudness, of the decay that will be maintained after the decay portion of the envelope until the release is triggered.

trigger [number, signal]

Send a non-zero value to sample accurately trigger an ADSR curve.

See Also

Name Description
adsr~
line~
function~
line~ Linear ramp generator
poke Write a sample into an audio buffer.