live.object

Perform operations on Live objects

Description

The live.object 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.

Arguments

None.

Inlets

Name Description
Left inlet Gets all command messages described below.
Right inlet Gets object id message id nn to select the object to operate upon.
id 0 means no object, i.e. all messages to the left inlet are ignored, which is also the initial state.

Outlets

Name Description
Left outlet Sends responses to get, call, bang, getid, getinfo, gettype and getpath.

Messages

get property [symbol]
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
get list-property [symbol]
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 child [symbol]
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 list-child [symbol]
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
set property [symbol]
value [various types]
Arguments:
property the name of a single-value property of the current object
value the new value for the property

Operation:
Sets 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 -
set list-property [symbol]
value-list [various types]
Arguments:
list-property the name of a list property of the current object
value-list the new values for the property

Operation:
Sets 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 child [symbol]
id nn [id]
Arguments:
child the name of a child of the current object
id nn the new child object for this name

Operation:
Sets the child name to point to the given child.

Remark:
Not all children can be set.

- no output -
set list-child [symbol]
id nn ... id mm [id-list]
Arguments:
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:
Sets the list child to contain the given ids.

Remark:
Not all children can be set.

- no output -
call function [symbol]
parameter-list [list of different types]
Arguments:
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
bang, getid Operation:
Sends the id of the current Live object to the outlet.

Outlet Output Example
left id nn id 5
getinfo Operation:
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
gettype Operation:
Sends the type (a.k.a. class) of the current object.

Outlet Output Example
left type object-type type Song
getpath Operation:
Sends the canonical path of current object.

Outlet Output Example
left path path path live_set return_tracks 0
id nn Operation:
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 -

Information for box attributes common to all objects

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.

Examples

See Also

Name Description
Live API Overview
Live Object Model
live.path Navigate to objects in the Live application
live.observer Monitor changes in Live objects
live.remote~ Realtime control of device parameters
Using the Live API Creating Devices that use the Live API
The LiveAPI JavaScript Object (jsliveapi) The LiveAPI Object