live.adsrui
ADSR User Interface
Description
The live.adsrui object is a user interface for defining the shape of an envelope using the classic Attack, Decay, Sustain, Release model. Each segment has an individually definable length and exponential slope. This object is designed to work seamlessly with its companion object, live.adsr~.
Arguments
None.
Attributes
active[long]
When the active attribute is set to 0, the mouse action does not cause output and the inactive colors are used.
attack_slope[float]
The slope of the attack stage (-1 to 1).
attack_time[float]
The duration of the attack stage in milliseconds. This value is clamped to the attack_domain attribute.
decay_domain[2 floats]
The domain, or range, in which the decay value can move.
decay_slope[float]
The slope of the decay stage (-1 to 1).
decay_time[float]
The duration of the decay stage in milliseconds. This value is clamped to the decay_domain attribute.
domain_exponent[float]
This exponent is applied when drawing the attack/decay/release values. The exponent allows you to tweak the behavior when the user moves the handle with the mouse.
enable_final[long]
When enabled, the final handle can move vertically.
enable_initial[long]
When enabled, the initial handle can move vertically. When disabled, the handle is not drawn.
enable_peak[long]
When enabled, the peak handle can move both horizontally and vertically. When disabled, the peak handle can only move horizontally.
final[float]
The value the ADSR reaches at the end of the release stage.
initial[float]
The value the ADSR starts at.
outputmode[long]
Default on. When enabled, the values stored in the patch are sent out when loading this object. Turn this attribute off when lusing live.adsrui in a Max for Live device, when live.adsrui outputs to objects that store the ADSR values in the set, such as live.numbox, to prevent conflicts.
peak[float]
The value the ADSR reaches at the end of the attack stage.
release_domain[2 floats]
The domain, or range, in which the release value can move.
release_slope[float]
The slope of the release stage (-1 to 1).
release_time[float]
The duration of the release stage in milliseconds. This value is clamped to the release_domain attribute.
show_bounds[long]
When enabled, lines are shown to indicate the object's bounds.
show_slopehandles[long]
When enabled, the slope handles are drawn and can be manipulated with the mouse or keyboard.
sustain[float]
The value the ADSR reaches at the end of the decay stage.
sustain_exponent[float]
The exponent that is applied when drawing the sustain value. The exponent allows you to tweak the behavior when the user moves the handle with the mouse.
tethering[long]
Default on. When enabled, incoming values are sent out from the outlets immediately, without causing a stack overflow when routed back to the inlets. Disable this when connecting live.adsrui to other parameter-enabled objects in Max for Live, to prevent unexpected behavior when automating.
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. background 1 adds the object to the background layer, background 0 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]
You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.
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'
valuepopup[int]: 0
For objects with single values, enabling valuepopup will display the object's current value in a popup caption when the mouse is over the object or it is being changed with the mouse.
valuepopuplabel[int]: 0
Sets the source of a text label shown in a value popup caption.
Possible values:
0 = 'None'
1 = 'Hint'
2 = 'Scripting Name'
3 = 'Parameter Long Name'
4 = 'Parameter Short Name'
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
A list to the leftmost inlet sets all ADSR envelope values simultaneously.
float
A number sets the attribute associated with the inlet.
bang
In any inlet, a bang will refresh the UI display and cause output.
key
Use the arrow keys on the keyboard to nudge handles when this object is selected.
See Also
| Name | Description |
|---|---|
| function | Breakpoint function editor |
| live.adsr~ | ADSR envelope generator |