RackDevice

Represents a Rack — Instrument, Drum, Audio Effect, or MIDI Effect — as a Device whose chains and macro controls are exposed to the LOM. The RackDevice class extends Device with the chain list, macro mappings, and variation/preset state unique to racks.

RackDevice

This class represents a Rack device. ^{From Live’s runtime docstring.}

Properties

Inherited from LomObject

_live_ptr: int

canonical_parent: Track

Get the canonical parent of the Device. ^{From Live’s runtime docstring.}

Inherited from Device

can_compare_ab: bool

Returns true if the Device has the capability to AB compare. ^{From Live’s runtime docstring.}

can_have_chains: bool

Returns true if the device is a rack. ^{From Live’s runtime docstring.}

can_have_drum_pads: bool

Returns true if the device is a drum rack. ^{From Live’s runtime docstring.}

class_display_name: str

Return const access to the name of the device’s class name as displayed in Live’s browser and device chain ^{From Live’s runtime docstring.}

class_name: str

Return const access to the name of the device’s class. ^{From Live’s runtime docstring.}

is_using_compare_preset_b: bool

Returns whether the Device has loaded the preset in compare slot B. Only relevant if can_compare_ab, otherwise errors. ^{From Live’s runtime docstring.}

type: DeviceType

Return the type of the device. ^{From Live’s runtime docstring.}

can_show_chains: bool

return True, if this Rack contains a rack instrument device that is capable of showing its chains in session view. ^{From Live’s runtime docstring.}

chain_selector: DeviceParameter

Const access to the chain selector parameter. ^{From Live’s runtime docstring.}

chains: Vector

Return const access to the list of chains in this device. Throws an exception if can_have_chains is false. ^{From Live’s runtime docstring.}

drum_pads: Vector[DrumPad]

Return const access to the list of drum pads in this device. Throws an exception if can_have_drum_pads is false. ^{From Live’s runtime docstring.}

has_drum_pads: bool

Returns true if the device is a drum rack which has drum pads. Throws an exception if can_have_drum_pads is false. ^{From Live’s runtime docstring.}

has_macro_mappings: bool

Returns true if any of the rack’s macros are mapped to a parameter. ^{From Live’s runtime docstring.}

is_active: bool

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. ^{From Live’s runtime docstring.}

is_showing_chains: bool

Returns True, if it is showing chains. ^{From Live’s runtime docstring.}

latency_in_ms: float

Returns the latency of the device in ms. ^{From Live’s runtime docstring.}

latency_in_samples: int

Returns the latency of the device in samples. ^{From Live’s runtime docstring.}

macros_mapped: tuple[bool, …]

A list of booleans, one for each macro parameter, which is True iffthat macro is mapped to something ^{From Live’s runtime docstring.}

name: str

Return access to the name of the device. ^{From Live’s runtime docstring.}

parameters: ATimeableValueVector

Const access to the list of available automatable parameters for this device. ^{From Live’s runtime docstring.}

return_chains: Vector

Return const access to the list of return chains in this device. Throws an exception if can_have_chains is false. ^{From Live’s runtime docstring.}

selected_variation_index: int

Access to the index of the currently selected macro variation.Throws an exception if the index is out of range. ^{From Live’s runtime docstring.}

variation_count: int

Access to the number of macro variations currently stored. ^{From Live’s runtime docstring.}

view: View

Representing the view aspects of a device. ^{From Live’s runtime docstring.}

visible_drum_pads: Vector[DrumPad]

Return const access to the list of visible drum pads in this device. Throws an exception if can_have_drum_pads is false. ^{From Live’s runtime docstring.}

visible_macro_count: int

Access to the number of macros that are currently visible. ^{From Live’s runtime docstring.}

Methods

Inherited from Device

save_preset_to_compare_ab_slot()

Saves the current state of the device to the compare AB slot. Only relevant if can_compare_ab, otherwise throws. ^{From Live’s runtime docstring.}

store_chosen_bank()

Parameters

• script_index: int
• bank_index: int

Set the selected bank in the device for persistency. ^{From Live’s runtime docstring.}

add_macro()

Increases the number of visible macro controls in the rack. Throws an exception if the maximum number of macro controls is reached. ^{From Live’s runtime docstring.}

copy_pad()

Parameters

• source_index: int
• destination_index: int

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. ^{From Live’s runtime docstring.}

delete_selected_variation()

Deletes the currently selected macro variation.Does nothing if there is no selected variation. ^{From Live’s runtime docstring.}

insert_chain()

Parameters

• index: int = -1

Returns

ChainProbed asLomObjecthigh confidence

• M4L rackdevice.md names the return as Chain.
• docstring “Insert a new empty chain at the given index”.

Inserts a new chain, either at the specified index or, if not index was specified, at the end of the chain sequence. ^{From Live’s runtime docstring.}

randomize_macros()

Randomizes the values for all macro controls not excluded from randomization. ^{From Live’s runtime docstring.}

recall_last_used_variation()

Recalls the macro variation that was recalled most recently.Does nothing if no variation has been recalled yet. ^{From Live’s runtime docstring.}

recall_selected_variation()

Recalls the currently selected macro variation.Does nothing if there are no variations. ^{From Live’s runtime docstring.}

remove_macro()

Decreases the number of visible macro controls in the rack. Throws an exception if the minimum number of macro controls is reached. ^{From Live’s runtime docstring.}

store_variation()

Stores a new variation of the values of all currently mapped macros ^{From Live’s runtime docstring.}

Nested types

• RackDevice.View — Representing the view aspects of a rack device.

Returned by 1 member elsewhere in the LOM

DrumChain

• devices: Vector[RackDevice]

Other classes

RackDevice.View

Representing the view aspects of a rack device. ^{From Live’s runtime docstring.}

Properties

Inherited from LomObject

_live_ptr: int

canonical_parent: RackDevice

Get the canonical parent of the View. ^{From Live’s runtime docstring.}

drum_pads_scroll_position: int

Access to the index of the lowest visible row of pads. Throws an exception if can_have_drum_pads is false. ^{From Live’s runtime docstring.}

is_collapsed: bool

Get/Set/Listen if the device is shown collapsed in the device chain. ^{From Live’s runtime docstring.}

is_showing_chain_devices: bool

Return whether the devices in the currently selected chain are visible. Throws an exception if can_have_chains is false. ^{From Live’s runtime docstring.}

selected_chain: Chain | NoneProbed asNonehigh confidence

• docstring “Return access to the currently selected chain.”
• corpus Ableton’s pushbase / Push2 read and assign Chain values to this property.

Return access to the currently selected chain. ^{From Live’s runtime docstring.}

selected_drum_pad: DrumPad

Return access to the currently selected drum pad. Throws an exception if can_have_drum_pads is false. ^{From Live’s runtime docstring.}

Returned by 1 member elsewhere in the LOM

RackDevice

• view: View