`Live.RackDevice` (runtime)¶

Live 9, Live Object Model & framework reference (descriptions and signatures).

Live Object Model, from the Live 9 API XML documentation.

Classes¶

class `RackDevice`¶

This class represents a Rack device.

Properties¶

_live_ptr
can_have_chains - Returns true if the device is a rack.
can_have_drum_pads - Returns true if the device is a drum rack.
canonical_parent - Get the canonical parent of the Device.
chains - Return const access to the list of chains in this device. Throws an exception if can_have_chains is false.
class_display_name - Return const access to the name of the device's class name as displayed in Live's browser and device chain
class_name - Return const access to the name of the device's class.
drum_pads - Return const access to the list of drum pads in this device. Throws an exception if can_have_drum_pads is false.
has_drum_pads - Returns true if the device is a drum rack which has drum pads. Throws an exception if can_have_drum_pads is false.
has_macro_mappings - Returns true if any of the rack's macros are mapped to a parameter.
is_active - Return const access to whether this device is active. This will be false bothwhen the device is off and when it's inside a rack device which is off.
name - Return access to the name of the device.
parameters - Const access to the list of available automatable parameters for this device.
return_chains - Return const access to the list of return chains in this device. Throws an exception if can_have_chains is false.
type - Return the type of the device.
view - Representing the view aspects of a device.
visible_drum_pads - Return const access to the list of visible drum pads in this device. Throws an exception if can_have_drum_pads is false.

Methods¶

`_get_parameters(arg1)`¶

`add_chains_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "chains" has changed.

`add_drum_pads_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "drum_pads" has changed.

`add_has_drum_pads_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "has_drum_pads" has changed.

`add_has_macro_mappings_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "has_macro_mappings" has changed.

`add_is_active_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "is_active" has changed.

`add_name_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "name" has changed.

`add_parameters_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "parameters" has changed.

`add_return_chains_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "return_chains" has changed.

`add_visible_drum_pads_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "visible_drum_pads" has changed.

`chains_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "chains".

`copy_pad(arg1,arg2,arg3)`¶

Copies all contents of a drum pad from a source pad into a destination pad. copy_pad(source_index, destination_index) where source_index and destination_index correspond to the note number/index of the drum pad in a drum rack. Throws an exception when the source pad is empty, or when the source or destination indices are not between 0 - 127.

`drum_pads_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "drum_pads".

`has_drum_pads_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "has_drum_pads".

`has_macro_mappings_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "has_macro_mappings".

`is_active_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "is_active".

`name_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "name".

`parameters_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "parameters".

`remove_chains_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "chains".

`remove_drum_pads_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "drum_pads".

`remove_has_drum_pads_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "has_drum_pads".

`remove_has_macro_mappings_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "has_macro_mappings".

`remove_is_active_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "is_active".

`remove_name_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "name".

`remove_parameters_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "parameters".

`remove_return_chains_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "return_chains".

`remove_visible_drum_pads_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "visible_drum_pads".

`return_chains_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "return_chains".

`store_chosen_bank(arg1,arg2,arg3)`¶

Set the selected bank in the device for persistency.

`visible_drum_pads_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "visible_drum_pads".

class `RackDevice.View`¶

Representing the view aspects of a rack device.

Properties¶

_live_ptr
canonical_parent - Get the canonical parent of the View.
drum_pads_scroll_position - Access to the index of the lowest visible row of pads. Throws an exception if can_have_drum_pads is false.
is_collapsed - Get/Set/Listen if the device is shown collapsed in the device chain.
is_showing_chain_devices - Return whether the devices in the currently selected chain are visible. Throws an exception if can_have_chains is false.
selected_chain - Return access to the currently selected chain.
selected_drum_pad - Return access to the currently selected drum pad. Throws an exception if can_have_drum_pads is false.

Methods¶

`add_drum_pads_scroll_position_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "drum_pads_scroll_position" has changed.

`add_is_collapsed_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "is_collapsed" has changed.

`add_is_showing_chain_devices_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "is_showing_chain_devices" has changed.

`add_selected_chain_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "selected_chain" has changed.

`add_selected_drum_pad_listener(arg1,arg2)`¶

Add a listener function or method, which will be called as soon as the property "selected_drum_pad" has changed.

`drum_pads_scroll_position_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "drum_pads_scroll_position".

`is_collapsed_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "is_collapsed".

`is_showing_chain_devices_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "is_showing_chain_devices".

`remove_drum_pads_scroll_position_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "drum_pads_scroll_position".

`remove_is_collapsed_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "is_collapsed".

`remove_is_showing_chain_devices_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "is_showing_chain_devices".

`remove_selected_chain_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "selected_chain".

`remove_selected_drum_pad_listener(arg1,arg2)`¶

Remove a previously set listener function or method from property "selected_drum_pad".

`selected_chain_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "selected_chain".

`selected_drum_pad_has_listener(arg1,arg2)`¶

Returns true, if the given listener function or method is connected to the property "selected_drum_pad".

Live.RackDevice (runtime)¶

Classes¶

class RackDevice¶

Properties¶

Methods¶

_get_parameters(arg1)¶

add_chains_listener(arg1,arg2)¶

add_drum_pads_listener(arg1,arg2)¶

add_has_drum_pads_listener(arg1,arg2)¶

add_has_macro_mappings_listener(arg1,arg2)¶

add_is_active_listener(arg1,arg2)¶

add_name_listener(arg1,arg2)¶

add_parameters_listener(arg1,arg2)¶

add_return_chains_listener(arg1,arg2)¶

add_visible_drum_pads_listener(arg1,arg2)¶

chains_has_listener(arg1,arg2)¶

copy_pad(arg1,arg2,arg3)¶

drum_pads_has_listener(arg1,arg2)¶

has_drum_pads_has_listener(arg1,arg2)¶

has_macro_mappings_has_listener(arg1,arg2)¶

is_active_has_listener(arg1,arg2)¶

name_has_listener(arg1,arg2)¶

parameters_has_listener(arg1,arg2)¶

remove_chains_listener(arg1,arg2)¶

remove_drum_pads_listener(arg1,arg2)¶

remove_has_drum_pads_listener(arg1,arg2)¶

remove_has_macro_mappings_listener(arg1,arg2)¶

remove_is_active_listener(arg1,arg2)¶

remove_name_listener(arg1,arg2)¶

remove_parameters_listener(arg1,arg2)¶

remove_return_chains_listener(arg1,arg2)¶

remove_visible_drum_pads_listener(arg1,arg2)¶

return_chains_has_listener(arg1,arg2)¶

store_chosen_bank(arg1,arg2,arg3)¶

visible_drum_pads_has_listener(arg1,arg2)¶

class RackDevice.View¶

Properties¶

Methods¶

add_drum_pads_scroll_position_listener(arg1,arg2)¶

add_is_collapsed_listener(arg1,arg2)¶

add_is_showing_chain_devices_listener(arg1,arg2)¶

add_selected_chain_listener(arg1,arg2)¶

add_selected_drum_pad_listener(arg1,arg2)¶

drum_pads_scroll_position_has_listener(arg1,arg2)¶

is_collapsed_has_listener(arg1,arg2)¶

is_showing_chain_devices_has_listener(arg1,arg2)¶

remove_drum_pads_scroll_position_listener(arg1,arg2)¶

remove_is_collapsed_listener(arg1,arg2)¶

remove_is_showing_chain_devices_listener(arg1,arg2)¶

remove_selected_chain_listener(arg1,arg2)¶

remove_selected_drum_pad_listener(arg1,arg2)¶

selected_chain_has_listener(arg1,arg2)¶

selected_drum_pad_has_listener(arg1,arg2)¶

`Live.RackDevice` (runtime)¶

class `RackDevice`¶

`_get_parameters(arg1)`¶

`add_chains_listener(arg1,arg2)`¶

`add_drum_pads_listener(arg1,arg2)`¶

`add_has_drum_pads_listener(arg1,arg2)`¶

`add_has_macro_mappings_listener(arg1,arg2)`¶

`add_is_active_listener(arg1,arg2)`¶

`add_name_listener(arg1,arg2)`¶

`add_parameters_listener(arg1,arg2)`¶

`add_return_chains_listener(arg1,arg2)`¶

`add_visible_drum_pads_listener(arg1,arg2)`¶

`chains_has_listener(arg1,arg2)`¶

`copy_pad(arg1,arg2,arg3)`¶

`drum_pads_has_listener(arg1,arg2)`¶

`has_drum_pads_has_listener(arg1,arg2)`¶

`has_macro_mappings_has_listener(arg1,arg2)`¶

`is_active_has_listener(arg1,arg2)`¶

`name_has_listener(arg1,arg2)`¶

`parameters_has_listener(arg1,arg2)`¶

`remove_chains_listener(arg1,arg2)`¶

`remove_drum_pads_listener(arg1,arg2)`¶

`remove_has_drum_pads_listener(arg1,arg2)`¶

`remove_has_macro_mappings_listener(arg1,arg2)`¶

`remove_is_active_listener(arg1,arg2)`¶

`remove_name_listener(arg1,arg2)`¶

`remove_parameters_listener(arg1,arg2)`¶

`remove_return_chains_listener(arg1,arg2)`¶

`remove_visible_drum_pads_listener(arg1,arg2)`¶

`return_chains_has_listener(arg1,arg2)`¶

`store_chosen_bank(arg1,arg2,arg3)`¶

`visible_drum_pads_has_listener(arg1,arg2)`¶

class `RackDevice.View`¶

`add_drum_pads_scroll_position_listener(arg1,arg2)`¶

`add_is_collapsed_listener(arg1,arg2)`¶

`add_is_showing_chain_devices_listener(arg1,arg2)`¶

`add_selected_chain_listener(arg1,arg2)`¶

`add_selected_drum_pad_listener(arg1,arg2)`¶

`drum_pads_scroll_position_has_listener(arg1,arg2)`¶

`is_collapsed_has_listener(arg1,arg2)`¶

`is_showing_chain_devices_has_listener(arg1,arg2)`¶

`remove_drum_pads_scroll_position_listener(arg1,arg2)`¶

`remove_is_collapsed_listener(arg1,arg2)`¶

`remove_is_showing_chain_devices_listener(arg1,arg2)`¶

`remove_selected_chain_listener(arg1,arg2)`¶

`remove_selected_drum_pad_listener(arg1,arg2)`¶

`selected_chain_has_listener(arg1,arg2)`¶

`selected_drum_pad_has_listener(arg1,arg2)`¶