live.object
Description
live.object is used to perform operations on Live objects that have been selected using the live.path object. These operations include retrieving information on the current state of the Live API and setting values to control Live.
Note: The Live API runs in the main thread in Live, and that all messages to and from the API are automatically deferred.
Examples
Arguments
None.
Attributes
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. 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'
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.
Inlets
Left inlet
Right inlet
id 0 means no object, i.e. all messages to the left inlet are ignored, which is also the initial state.
Outlets
Left outlet
Messages
getid
id nn
Sets the current object. The message has the same effect if sent to both the right or the left inlet. For clarity it is suggested to always use the right inlet to supply the object id.
- no output -
getpath
Sends the canonical path of current object.
| Outlet | Output | Example |
|---|---|---|
| left | path path | path live_set return_tracks 0 |
gettype
Sends the type (a.k.a. class) of the current object.
| Outlet | Output | Example |
|---|---|---|
| left | type object-type | type Song |
getinfo
Sends a description of the current object.
Output to left outlet (most lines may occur multiple times, last line is info done):
info id nn
info type object-type
info description description
info children list-child object-type
info child child object-type
info property property property-type
info function function
info done
Example output:
info id 3
info type Scene
info description This class represents a series of ClipSlots in Lives session view matrix
info children clip_slots ClipSlot
info child canonical_parent Song
info property is_triggered bool
info property name symbol
info property tempo float
info function fire
info function fire_as_selected
info function set_fire_button_state
info done
bang, getid
Sends the id of the current Live object to the outlet.
| Outlet | Output | Example |
|---|---|---|
| left | id nn | id 5 |
call
Arguments
parameter-list [list of different types]
function the name of the function
parameter-list an optional list of parameters
Operation:
Calls the given function of the current object, optionally with a list of parameters.
Remark:
The types of the parameters are given in the Live Object Model.
| Outlet | Output | Example |
|---|---|---|
| left | function value | get_beats_loop_length 004.00.00.000 |
set
Arguments
id nn ... id mm [id-list]
list-child the name of a list child of the current object
id nn ... id mm the new list of objects for the given name
Operation:
Set the list child to contain the given ids.
Remark:
Not all children can be set.
- no output -
set
Arguments
id nn [id]
child the name of a child of the current object
id nn the new child object for this name
Operation:
Set the child name to point to the given child.
Remark:
Not all children can be set.
- no output -
set
Arguments
value-list [various types]
list-property the name of a list property of the current object
value-list the new values for the property
Operation:
Set the given list property to the value list.
Remark:
Not all properties can be set. The types of the properties are given in the Live Object Model.
- no output -
set
Arguments
value [various types]
property the name of a single-value property of the current object
value the new value for the property
Operation:
Set the value of given property of the current object.
Remark:
Not all properties can be set. The types of the properties are given in the Live Object Model.
- no output -
get
Arguments
list-child the name of a list-child of the current object
Operation:
Sends the ids of the elements of the list-child of the current object.
| Outlet | Output | Example |
|---|---|---|
| left | list-child id nn ... id mm | clip_slots id 4 id 5 |
get
Arguments
child the name of a child of the current object
Operation:
Sends the id of the child of the current object.
| Outlet | Output | Example |
|---|---|---|
| left | child id nn | master_track id 10 |
get
Arguments
list-property the name of a list property of the current object
Operation:
Sends the list of values of given property of the current object.
| Outlet | Output | Example |
|---|---|---|
| left | list-property list of values | input_routings Ext. In Max Resampling 1-Audio A-Return Master No Input |
get
Arguments
property the name of a single-value property of the current object
Operation:
Sends value of given property of the current object.
| Outlet | Output | Example |
|---|---|---|
| left | property value | name base solo 3 |
Inspector
Persistence
The live.object object has a special entry in its inspector labelled "Use Persistent Mapping". This setting, when enabled, causes the id associated with the object to persist when the Live document is saved and restored, and when the Max Device is moved between the Live application and the Max editor, or within the Live Set. Beginning in Live 8.2.2, Live API ids remain persistent between launches of Live, which in conjunction with the Persistence feature of live.object, live.observer and live.remote~, makes it possible to create simpler devices which retain their association with elements in the Live user interface.
See Also
| Name | Description |
|---|---|
| Live API Overview | Live API Overview |
| Live Object Model | LOM - The Live Object Model |
| live.path | Navigate to objects in the Live application |
| live.observer | Monitor changes in Live objects |
| live.remote~ | Realtime control of parameters in Ableton Live and Max for Live. |
| Using the Live API | Creating Devices that use the Live API |
| The LiveAPI JavaScript Object (jsliveapi) | The LiveAPI Object |