live.adsr~
ADSR envelope generator
Description
Use the live.adsr~ object to create sample-accurate Attack-Decay-Sustain-Release signal envelopes. Pair live.adsr~ with the live.adsrui object for graphical control over each of its stages.
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
annotation[symbol]
Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.
background[int]: 0
Adds or removes the object from the patcher's background layer.
adds the object to the background layer, removes it. Objects in the background layer are shown behind all objects in the default foreground layer.
color[4 floats]
Sets the color for the object box outline.
fontface[int]
Sets the type style used by the object. The options are:
plain
bold
italic
bold italic
Possible values:
0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'
fontname[symbol]
Sets the object's font.
fontsize[float]
Sets the object's font size (in points).
Possible values:
'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'
hint[symbol]
Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.
ignoreclick[int]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
JS Painter File
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.
presentation[int]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 0. 0. 0. 0.
Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.
rect[4 floats]
write-only
Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).
size[2 floats]
write-only
Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.
textcolor[4 floats]
Sets the color for the object's text in RGBA format.
textjustification[int]
Sets the justification for the object's text.
Possible values:
0 = 'left'
1 = 'center'
2 = 'right'
varname[symbol]
Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.
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 User Interface |
adsr~ | ADSR envelope generator |