live.step
Description
live.step displays multiple sequences which have multiple steps composed of pitch, velocity, and duration. Two additional steps (Extra 1 and Extra 2) are available for user-defined display.
Examples
Arguments
None.
Attributes
annotation_name [symbol] (default: )
The string that is prepended to annotations. This shows up in the Info pane in Live, and the clue window in Max.
autoscroll [int] (default: 1)
When set to 1, this attribute lets you expand the scrolling dragging the cursor to the edge of the display or to drag a selected pitch beyond the range of the current visual display.
bgcolor [4 floats]
Sets the background color of the live.step object in RGBA format.
bgcolor2 [4 floats]
Sets the second background color of the live.step object in RGBA format.
bgrulercolor [4 floats]
Sets the ruler background color of the live.step object in RGBA format.
bgunitcolor [4 floats]
Sets the unit background color of the live.step object in RGBA format.
blackkeycolor [4 floats]
Sets the color for the upper (black) keys in RGBA format.
bordercolor [4 floats]
Sets the border color of the live.step object in RGBA format.
display_seq [atom_long] (default: 1)
Sets the sequence to be displayed (index numbering starts at 1).
duration_active [int] (default: 1)
Activates display of the duration layer
editlooponly [int] (default: 0)
When the
attribute is set to 1, the edit messages ( , , , , , , ) are only applied to indices inside the loop selection.extra1_active [int] (default: 1)
Activates display of the user-definable extra1 layer
extra1_max [atom_long] (default: 127)
Sets the maximum value for the user-definable extra1 layer.
extra1_min [atom_long] (default: 0)
Sets the minimum value for the user-definable extra1 layer
extra1_signed [int] (default: 0)
Displays the user-definable extra1 layer as Signed.
extra2_active [int] (default: 1)
Activates display of the user-definable extra2 layer
extra2_max [atom_long] (default: 127)
Sets the maximum value for the user-definable extra2 layer
extra2_min [atom_long] (default: 0)
Sets the minimum value for the user-definable extra2 layer
extra2_signed [int] (default: 0)
Displays the user-definable extra2 layer as Signed.
extra_thickness [float] (default: 0.5)
Sets the thickness of the vertical bars displayed in the extra1 layer. Values should be in the range of 0. (invisible) to 1.0 (full width).
hbgcolor [4 floats]
Sets the highlight background color of the live.step object in RGBA format.
loopbordercolor [4 floats]
Sets the loop border color of the live.step object in RGBA format.
loopruler [int] (default: 1)
Toggles the display of the loop ruler.
mode [int] (default: 0)
An integer or symbol can be used to set the information display mode of the live.step object.
Possible values:
0 = 'All'
(
Set/change the live.step values displayed
)
Display note, velocity, duration, and user-definable extra1 and extra2 values at once.
1 = 'Pitch'
(
Display pitch
)
Display pitch values.
2 = 'Velocity'
(
Display velocity
)
Display velocity bars.
3 = 'Duration'
(
Display duration
)
Display duration bars.
4 = 'Extra1'
(
Display extra1
)
Display extra1 bars.
5 = 'Extra2'
(
Display extra2
)
Display extra2 bars.
nseq [atom_long] (default: 1)
Defines the number of sequences.
pitch_active [int] (default: 1)
Activates display of the pitch layer
stepcolor [4 floats]
Sets the step color of the live.step object in RGBA format.
stepcolor2 [4 floats]
Sets the second step color of the live.step object in RGBA format.
target_seq [atom_long]
Defines the sequence to be edited (index numbering starts at 1).
textcolor [4 floats]
Sets the text color of the live.step object in RGBA format.
unitruler [int] (default: 1)
Toggles the display of the unit ruler.
usestepcolor2 [int] (default: 1)
Toggles the use of a second step color in the display
velocity_active [int] (default: 1)
Activates display of the Velocity layer
whitekeycolor [4 floats]
Sets the color for the lower level (white) keys in RGBA format.
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] (default: 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'
hidden [int] (default: 0)
Toggles whether an object is hidden when the patcher is locked.
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] (default: 0)
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile [symbol]
JS Painter File
patching_rect [4 floats] (default: 0. 0. 100. 0.)
Sets the position and size of the object in the patcher window.
position [2 floats]
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] (default: 0)
Sets whether an object belongs to the patcher's presentation.
presentation_rect [4 floats] (default: 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]
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]
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.
Parameter Attributes
Order
Sets the order of recall of this parameter. Lower numbers are recalled first. The order of recall of parameters with the same order number is undefined.
Parameter Mode Enable
Parameter Mode Enable (not available from Parameters window)
Link to Scripting Name
When checked, the Scripting Name is linked to the Long Name attribute.
Long Name
The long name of the parameter. This name must be unique per patcher hierarchy.
Short Name
Sets the short name for the object's visual display. The maximum length varies according to letter width, but is generally in a range of 5 to 7 characters.
Type
Specifies the data type. The data types used in Max for Live are:
Float
Int
Enum (enumerated list)
Blob
Note: By convention, the Live application uses floating point numbers
for its calculations; the native integer representation is limited to 256
values, with a default range of 0-255 (similar to the char data type used
in Jitter). When working with Live UI objects whose integer values will
exceed this range, the Type attribute should be set to Float,
and the Unit Style attribute should be set to Int.
Range/Enum
When used with an integer or floating point data type, this field is
used to specify the minimum and maximum values of the parameter.
When used with an enumerated list (Enum) data type, this field contains
a space-delimited list of the enumerated values (if list items contain a
space or special characters, the name should be enclosed in double
quotes).
Clip Modulation Mode
Sets the Clip Modulation Mode used by the Live application. The modulation
modes are:
None
Unipolar
Bipolar
Additive
Absolute
Clip Modulation Range
This parameter is only used with the Absolute modulation mode. It specifies defines the range of values used.
Initial Enable
When checked (set to 1), the UI object can store an initialization value. The value is set using the Initial attribute (see below).
Initial
Sets the initial value to be stored and used when the Initial Enable attribute is checked.
Unit Style
Sets the unit style to be used when displaying values. The unit style
values are: Int: displays integer values
Float: displays floating point values
Time: displays time values in milliseconds (ms)
Hertz: displays frequency values (Hz/kHz).
deciBel: displays loudness (dB)
%: Percentage
Pan: displays Left and Right values
Semitones: displays steps (st)
MIDI: displays pitch corresponding to the MIDI note number
Custom: displays custom data type
Native: defaults to floating point values
Custom Units
Sets the units to be used with the 'Custom' unit style (see "Unit Style", above). Custom unit strings may be simple symbols (e.g. "Harmonic(s)"), in which case the parameter's value will be displayed in its 'Native' display mode, followed by the symbol (e.g. "12 Harmonic(s)" for an Int-typed parameter or "12.54 Harmonic(s)" for a Float-typed parameter). For additional control over the numerical component displayed, a sprintf-style string may be used (e.g. "%0.2f Bogon(s)", which would display a value such as ".87 Bogons").
Exponent
When set to a value other than 1., the parameter's input and output values will be exponentially scaled according to the factor entered in this column.
Steps
The number of steps available between the minimum and maximum values of a parameter. For instance, if the parameter has a range from 0.-64., with Steps set to 4, the user can only set the parameter to 0, 21.33, 42.66 and 64.
Parameter Visibility
For automatable parameters (Int, Float, Enum), 'Stored Only' disables automation, although parameter values are stored in presets. 'Hidden' causes the parameter's value to be ignored when storing and recalling data. Non-automatable parameters (Blob) are 'Stored Only' by default, and can be set to 'Hidden', if desired.
Update Limit (ms)
Speed limits values triggered by automation.
Defer Automation Output
Defers values triggered by automation.
Messages
bang
int
Arguments
active
Arguments
If the attribute is set to a value greater than zero, the message deactivates the specified sequence. The word , followed by any non-zero value, will activate the specified sequence.
copy
Arguments
stop-index [int]
dictionary
Arguments
direction
Arguments
: forward
: backward
: back and forth
: Rotate
: random
If the attribute is set to zero, the integer argument sets the direction of all sequences when object's playback is controlled using the message.
If the attribute is set to a value greater than zero, an integer sets the direction of the specified sequence when object's playback is controlled using the message.
doedit
Arguments
: transpose the pitch upward.
: transpose the pitch downward.
: Rotate the steps to the left.
: Rotate the steps to the right
: Randomize steps depending on the attribute. For instance, if the is set to velocity, 4 will only randomize the velocity.
For more advanced editing features, use the , , , , , , and messages.
down
Arguments
An optional argument may be used with the message to specify the parameters to be decreased without having to use the attribute. The optional arguments are:
: decrease all parameters
: transpose pitches downward
: decrease velocities
: decrease durations
: decrease values for the user-definable Extra 1 parameter
: decrease values for the user-definable Extra 2 parameter
dump
dump_to_dict
duration
Arguments
extra1
Arguments
extra2
Arguments
fetch
Arguments
step number [int]
fold
Arguments
Note: Sequence editing messages such as , , and use the list of pitches displayed in fold state when performing operations (i.e., the message will only choose randomly from among the pitches displayed on fold mode. These operations are also dependent on the target sequence, as well). for all sequences.
fold_pitch
Arguments
getactive
getcurrentstep
getdirection
getduration
getextra1
getextra2
getinterval
getloop
getmodelist
getnstep
getpitch
getstep
Arguments
getvelocity
getzoom
init
interval
Arguments
left
Arguments
An optional argument may be used with the message to specify the parameters to be rotated without having to use the attribute. The optional arguments are:
: Rotate all parameters to the left
: Rotate all pitches to the left
: Rotate all velocities to the left
: Rotate all durations to the left
: Rotate all user-definable Extra 1 parameters to the left
: Rotate all user-definable Extra 2 parameters to the left
loop
Arguments
stop-index [int]
(mouse)
0: The pitch, velocity, duration, extra1, or extra2 settings have been modified.
1: The looping portion of the UI has been modified.
2: Edits have been made in the ruler area of the UI.
next
nstep
Arguments
paste
Arguments
start-index [int]
pitch
Arguments
random
Arguments
An optional argument may be used with the message to specify the parameters to be scrambled without having to use the attribute. The optional arguments are:
: Randomize all parameters
: Randomize all pitches
: Randomize all velocities
: Randomize all durations
: Randomize all values for the user-definable Extra 1 parameter
: Randomize all values for the user-definable Extra 2 parameter
reset
right
Arguments
An optional argument may be used with the message to specify the parameters to be rotated without having to use the attribute. The optional arguments are:
: Rotate all parameters to the right
: Rotate all pitches to the right
: Rotate all velocities to the right
: Rotate all durations to the right
: Rotate all values for the user-definable Extra 1 parameter to the right
: Rotate all values for the user-definable Extra 2 parameter to the right
scramble
Arguments
keep-step-sync [int]
An optional argument may be used with the message to specify the parameters to be scrambled without having to use the attribute. The optional arguments are:
: Randomize the order of all parameters
: Randomize the order of all pitches
: Randomize the order of all velocities
: Randomize the order of all durations
: Randomize the order of all user-definable Extra 1 parameters
: Randomize the order of all user-definable Extra 2 parameters
If you are not using all, and that you pass as argument, will keep your steps synchronized. For instance, the message will reorder the pitches, but the other parameters will follow.
set
Arguments
If the attribute is set to a value greater than zero, the word , followed by an integer sets the current step of the currently specified sequence.
setall
Arguments
settimeshift
Arguments
sort
Arguments
keep-step-sync [int]
direction [int]
Optional arguments may be used with the message to specify behavior, synchronization, and direction of sortint. The can be used to set the parameters to be sorted without having to use the attribute. The optional arguments are:
: Sort the order of all parameters
: Sort the order of the pitches
: Sort the order of the velocities
: Sort the order of the durations
: Sort the order of all user-definable Extra 1 parameters
: Sort the order of all user-definable Extra 2 parameters
The first integer argument specifies whether or not to keep the step values synchronized - it only works if the attribute is not set to . For instance, the message will reorder the steps based on the pitch, but the velocity, duration and user-definable extra1 and extra2 values associated to the pitch will be maintained. An optional second integer argument can be used to set the sorting order:
: Ascending (the default) : Descending.
step
Arguments
midi-note [int]
velocity [int]
duration [int]
the index (index numbering starts at 1)
the MIDI note number (0-127)
the note velocity (0-127)
the duration (30, 60, 120, 240, 480, 960, 1920, 3840 ticks)
time
Arguments
beat [int]
unit [int]
resolution [int]
time-sig-numerator [list]
time-sig-denominator [list]
up
Arguments
An optional argument may be used with the message to specify the parameters to be increased without having to use the attribute. The optional arguments are:
: Increase all parameters
: Transpose pitches upward
: Increase velocities
: Increase durations
: Increase the value of all user-definable Extra 1 parameters
: Increase the value of all user-definable Extra 2 parameters
velocity
Arguments
zoom
Arguments
high-pitch [float]
zoom_fit
zoom_in
zoom_out
Output
anything
Out the fourth outlet: The output in response to dumpout messages used to query the live.step object.
int
Out the third outlet: Mouseover information.
Out the fifth outlet: Sequence index out.
list
Out the leftmost outlet: Step values.
Out the second outlet: Current loop points for each sequence.
See Also
Name | Description |
---|---|
Max For Live | Max For Live |
live.grid | A UI grid of steps, with constraints and directions |
multislider | Display data as sliders or a scrolling display |
matrixctrl | Matrix switch control |