live.banks Reference

Manage Max for Live Device banks for Push controllers.

live.banks

Description

Create, edit and delete Max for Live Device parameter banks, as displayed on Ableton's Push controllers. Banks are saved with the device, but can be modified in real-time to cause updates on the Push display. For instance, you might want to reveal or hide particular parameters within a bank depending on device state.

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]

g/s(set)

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]

g/s(set)

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]

g/s(set)

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

(mouse)

Double-click to open the Parameter Banks window. Only available in the editor, this feature is disabled inside of Live.

delete

Arguments

bank_id [int]
Delete a parameter bank. Deleting a bank will decrement the index of the banks with higher indices.

edit

Arguments

bank_id [int]
bank_name [symbol]
bank_parameters [list]
Edit a parameter bank, specified by bank_id (0-indexed). To change the bank name, pass a new name as bank_name , or pass - (minus) to use the existing name. The optional list of parameters should be a list of index/name pairs in the form parameter_index parameter_name . For instance, edit 0 newname 0 foo 2 bar 4 - 5 bap would change the name of bank 0 to newname and modify parameter slot 0 to use the parameter foo , slot 2 to use the parameter bar , eliminate the parameter in slot 4, and assign slot 5 to the parameter named bap .

getcount

Sends the count message from the outlet, followed by the number of banks.

getname

Arguments

bank_id [int]
Sends the name message from the outlet, followed by the index (int) and name (symbol) of the specified bank.

getparameters

Arguments

bank_id [int]
Sends the parameters message from the outlet, followed by the index (int) of and a list of parameter names (symbol) in the specified bank.

new

Arguments

bank_id [int]
bank_name [symbol]
bank_parameters [list]
Create a bank at the index specified by bank_id (0-indexed). If a bank already exists at that index, the new bank will be inserted at the specified index and all higher-indexed banks will have their indices incremented. The bank requires a name, specified by bank_name . The list of parameters should be a list of up to 8 symbols, specifying the parameter name for bank slots 0-7. A - (minus) can be used to indicate that a slot should have no parameter associated with it. Note: when creating banks, it is possible to specify indices higher than the bank count. That is, one could start with an empty set of banks and create bank 3 first. In that case, dummy banks will be created in slots 0, 1 and 2. Dummy banks are displayed with grey text in the Parameter Banks window. Editing a dummy bank will cause it to become a 'real' bank. Creating a new bank at the index occupied by a dummy bank will replace the dummy bank in-place, rather than performing an insert.

See Also

Name Description
live.arrows Vectorized arrow(s) user interface object
live.button Flash on any message, send a bang
live.dial Output numbers by moving a dial onscreen
live.drop Define a region for dragging and dropping a file
live.gain
live.line Straight line
live.numbox Display and output a number
live.slider Output numbers by moving a slider onscreen
live.tab A user interface tab/multiple button object
live.toggle Switch between off and on (0/1)