Skip to content

Live.RackDevice (runtime)

Live 12 — Live Object Model & framework reference (descriptions and signatures).

Classes

class RackDevice(Device)

This class represents a Rack device.

Properties

  • _live_ptr
  • can_compare_ab - Returns true if the Device has the capability to AB compare.
  • can_have_chains - Returns true if the device is a rack.
  • can_have_drum_pads - Returns true if the device is a drum rack.
  • can_show_chains - return True, if this Rack contains a rack instrument device that is capable of showing its chains in session view.
  • canonical_parent - Get the canonical parent of the Device.
  • chain_selector - Const access to the chain selector parameter.
  • 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.
  • is_showing_chains - Returns True, if it is showing chains.
  • is_using_compare_preset_b - Returns whether the Device has loaded the preset in compare slot B. Only relevant if can_compare_ab, otherwise errors.
  • latency_in_ms - Returns the latency of the device in ms.
  • latency_in_samples - Returns the latency of the device in samples.
  • macros_mapped - A list of booleans, one for each macro parameter, which is True iffthat macro is mapped to something
  • 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.
  • selected_variation_index - Access to the index of the currently selected macro variation.Throws an exception if the index is out of range.
  • type - Return the type of the device.
  • variation_count - Access to the number of macro variations currently stored.
  • 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.
  • visible_macro_count - Access to the number of macros that are currently visible.

Methods

View(...)

Representing the view aspects of a rack device.

__init__(...)

Raises an exception This class cannot be instantiated from Python

add_chains_listener(...)

add_chains_listener( (RackDevice)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "chains" has changed.

C++ signature :
    void add_chains_listener(TRackDevicePyHandle,boost::python::api::object)
add_drum_pads_listener(...)

add_drum_pads_listener( (RackDevice)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "drum_pads" has changed.

C++ signature :
    void add_drum_pads_listener(TRackDevicePyHandle,boost::python::api::object)
add_has_drum_pads_listener(...)

add_has_drum_pads_listener( (RackDevice)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "has_drum_pads" has changed.

C++ signature :
    void add_has_drum_pads_listener(TRackDevicePyHandle,boost::python::api::object)
add_has_macro_mappings_listener(...)

add_has_macro_mappings_listener( (RackDevice)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "has_macro_mappings" has changed.

C++ signature :
    void add_has_macro_mappings_listener(TRackDevicePyHandle,boost::python::api::object)
add_is_active_listener(...)

add_is_active_listener( (Device)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "is_active" has changed.

C++ signature :
    void add_is_active_listener(TPyHandle<ADevice>,boost::python::api::object)
add_is_showing_chains_listener(...)

add_is_showing_chains_listener( (RackDevice)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "is_showing_chains" has changed.

C++ signature :
    void add_is_showing_chains_listener(TRackDevicePyHandle,boost::python::api::object)
add_is_using_compare_preset_b_listener(...)

add_is_using_compare_preset_b_listener( (Device)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "is_using_compare_preset_b" has changed.

C++ signature :
    void add_is_using_compare_preset_b_listener(TPyHandle<ADevice>,boost::python::api::object)
add_latency_in_ms_listener(...)

add_latency_in_ms_listener( (Device)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "latency_in_ms" has changed.

C++ signature :
    void add_latency_in_ms_listener(TPyHandle<ADevice>,boost::python::api::object)
add_latency_in_samples_listener(...)

add_latency_in_samples_listener( (Device)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "latency_in_samples" has changed.

C++ signature :
    void add_latency_in_samples_listener(TPyHandle<ADevice>,boost::python::api::object)
add_macro(...)

add_macro( (RackDevice)arg1) -> None : Increases the number of visible macro controls in the rack. Throws an exception if the maximum number of macro controls is reached.

C++ signature :
    void add_macro(TRackDevicePyHandle)
add_macros_mapped_listener(...)

add_macros_mapped_listener( (RackDevice)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "macros_mapped" has changed.

C++ signature :
    void add_macros_mapped_listener(TRackDevicePyHandle,boost::python::api::object)
add_name_listener(...)

add_name_listener( (Device)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "name" has changed.

C++ signature :
    void add_name_listener(TPyHandle<ADevice>,boost::python::api::object)
add_parameters_listener(...)

add_parameters_listener( (Device)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "parameters" has changed.

C++ signature :
    void add_parameters_listener(TPyHandle<ADevice>,boost::python::api::object)
add_return_chains_listener(...)

add_return_chains_listener( (RackDevice)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "return_chains" has changed.

C++ signature :
    void add_return_chains_listener(TRackDevicePyHandle,boost::python::api::object)
add_variation_count_listener(...)

add_variation_count_listener( (RackDevice)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "variation_count" has changed.

C++ signature :
    void add_variation_count_listener(TRackDevicePyHandle,boost::python::api::object)
add_visible_drum_pads_listener(...)

add_visible_drum_pads_listener( (RackDevice)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "visible_drum_pads" has changed.

C++ signature :
    void add_visible_drum_pads_listener(TRackDevicePyHandle,boost::python::api::object)
add_visible_macro_count_listener(...)

add_visible_macro_count_listener( (RackDevice)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "visible_macro_count" has changed.

C++ signature :
    void add_visible_macro_count_listener(TRackDevicePyHandle,boost::python::api::object)
chains_has_listener(...)

chains_has_listener( (RackDevice)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "chains".

C++ signature :
    bool chains_has_listener(TRackDevicePyHandle,boost::python::api::object)
copy_pad(...)

copy_pad( (RackDevice)arg1, (int)arg2, (int)arg3) -> None : 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.

C++ signature :
    void copy_pad(TRackDevicePyHandle,int,int)
delete_selected_variation(...)

delete_selected_variation( (Device)arg1) -> None : Deletes the currently selected macro variation.Does nothing if there is no selected variation.

C++ signature :
    void delete_selected_variation(TPyHandle<ADevice>)
drum_pads_has_listener(...)

drum_pads_has_listener( (RackDevice)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "drum_pads".

C++ signature :
    bool drum_pads_has_listener(TRackDevicePyHandle,boost::python::api::object)
has_drum_pads_has_listener(...)

has_drum_pads_has_listener( (RackDevice)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "has_drum_pads".

C++ signature :
    bool has_drum_pads_has_listener(TRackDevicePyHandle,boost::python::api::object)
has_macro_mappings_has_listener(...)

has_macro_mappings_has_listener( (RackDevice)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "has_macro_mappings".

C++ signature :
    bool has_macro_mappings_has_listener(TRackDevicePyHandle,boost::python::api::object)
insert_chain(...)

insert_chain( (RackDevice)arg1 [, (int)Index=-1]) -> LomObject : Inserts a new chain, either at the specified index or, if not index was specified, at the end of the chain sequence.

C++ signature :
    TWeakPtr<TPyHandleBase> insert_chain(TRackDevicePyHandle [,int=-1])
is_active_has_listener(...)

is_active_has_listener( (Device)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "is_active".

C++ signature :
    bool is_active_has_listener(TPyHandle<ADevice>,boost::python::api::object)
is_showing_chains_has_listener(...)

is_showing_chains_has_listener( (RackDevice)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "is_showing_chains".

C++ signature :
    bool is_showing_chains_has_listener(TRackDevicePyHandle,boost::python::api::object)
is_using_compare_preset_b_has_listener(...)

is_using_compare_preset_b_has_listener( (Device)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "is_using_compare_preset_b".

C++ signature :
    bool is_using_compare_preset_b_has_listener(TPyHandle<ADevice>,boost::python::api::object)
latency_in_ms_has_listener(...)

latency_in_ms_has_listener( (Device)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "latency_in_ms".

C++ signature :
    bool latency_in_ms_has_listener(TPyHandle<ADevice>,boost::python::api::object)
latency_in_samples_has_listener(...)

latency_in_samples_has_listener( (Device)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "latency_in_samples".

C++ signature :
    bool latency_in_samples_has_listener(TPyHandle<ADevice>,boost::python::api::object)
macros_mapped_has_listener(...)

macros_mapped_has_listener( (RackDevice)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "macros_mapped".

C++ signature :
    bool macros_mapped_has_listener(TRackDevicePyHandle,boost::python::api::object)
name_has_listener(...)

name_has_listener( (Device)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "name".

C++ signature :
    bool name_has_listener(TPyHandle<ADevice>,boost::python::api::object)
parameters_has_listener(...)

parameters_has_listener( (Device)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "parameters".

C++ signature :
    bool parameters_has_listener(TPyHandle<ADevice>,boost::python::api::object)
randomize_macros(...)

randomize_macros( (RackDevice)arg1) -> None : Randomizes the values for all macro controls not excluded from randomization.

C++ signature :
    void randomize_macros(TRackDevicePyHandle)
recall_last_used_variation(...)

recall_last_used_variation( (Device)arg1) -> None : Recalls the macro variation that was recalled most recently.Does nothing if no variation has been recalled yet.

C++ signature :
    void recall_last_used_variation(TPyHandle<ADevice>)
recall_selected_variation(...)

recall_selected_variation( (Device)arg1) -> None : Recalls the currently selected macro variation.Does nothing if there are no variations.

C++ signature :
    void recall_selected_variation(TPyHandle<ADevice>)
remove_chains_listener(...)

remove_chains_listener( (RackDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "chains".

C++ signature :
    void remove_chains_listener(TRackDevicePyHandle,boost::python::api::object)
remove_drum_pads_listener(...)

remove_drum_pads_listener( (RackDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "drum_pads".

C++ signature :
    void remove_drum_pads_listener(TRackDevicePyHandle,boost::python::api::object)
remove_has_drum_pads_listener(...)

remove_has_drum_pads_listener( (RackDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "has_drum_pads".

C++ signature :
    void remove_has_drum_pads_listener(TRackDevicePyHandle,boost::python::api::object)
remove_has_macro_mappings_listener(...)

remove_has_macro_mappings_listener( (RackDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "has_macro_mappings".

C++ signature :
    void remove_has_macro_mappings_listener(TRackDevicePyHandle,boost::python::api::object)
remove_is_active_listener(...)

remove_is_active_listener( (Device)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "is_active".

C++ signature :
    void remove_is_active_listener(TPyHandle<ADevice>,boost::python::api::object)
remove_is_showing_chains_listener(...)

remove_is_showing_chains_listener( (RackDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "is_showing_chains".

C++ signature :
    void remove_is_showing_chains_listener(TRackDevicePyHandle,boost::python::api::object)
remove_is_using_compare_preset_b_listener(...)

remove_is_using_compare_preset_b_listener( (Device)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "is_using_compare_preset_b".

C++ signature :
    void remove_is_using_compare_preset_b_listener(TPyHandle<ADevice>,boost::python::api::object)
remove_latency_in_ms_listener(...)

remove_latency_in_ms_listener( (Device)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "latency_in_ms".

C++ signature :
    void remove_latency_in_ms_listener(TPyHandle<ADevice>,boost::python::api::object)
remove_latency_in_samples_listener(...)

remove_latency_in_samples_listener( (Device)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "latency_in_samples".

C++ signature :
    void remove_latency_in_samples_listener(TPyHandle<ADevice>,boost::python::api::object)
remove_macro(...)

remove_macro( (RackDevice)arg1) -> None : Decreases the number of visible macro controls in the rack. Throws an exception if the minimum number of macro controls is reached.

C++ signature :
    void remove_macro(TRackDevicePyHandle)
remove_macros_mapped_listener(...)

remove_macros_mapped_listener( (RackDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "macros_mapped".

C++ signature :
    void remove_macros_mapped_listener(TRackDevicePyHandle,boost::python::api::object)
remove_name_listener(...)

remove_name_listener( (Device)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "name".

C++ signature :
    void remove_name_listener(TPyHandle<ADevice>,boost::python::api::object)
remove_parameters_listener(...)

remove_parameters_listener( (Device)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "parameters".

C++ signature :
    void remove_parameters_listener(TPyHandle<ADevice>,boost::python::api::object)
remove_return_chains_listener(...)

remove_return_chains_listener( (RackDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "return_chains".

C++ signature :
    void remove_return_chains_listener(TRackDevicePyHandle,boost::python::api::object)
remove_variation_count_listener(...)

remove_variation_count_listener( (RackDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "variation_count".

C++ signature :
    void remove_variation_count_listener(TRackDevicePyHandle,boost::python::api::object)
remove_visible_drum_pads_listener(...)

remove_visible_drum_pads_listener( (RackDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "visible_drum_pads".

C++ signature :
    void remove_visible_drum_pads_listener(TRackDevicePyHandle,boost::python::api::object)
remove_visible_macro_count_listener(...)

remove_visible_macro_count_listener( (RackDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "visible_macro_count".

C++ signature :
    void remove_visible_macro_count_listener(TRackDevicePyHandle,boost::python::api::object)
return_chains_has_listener(...)

return_chains_has_listener( (RackDevice)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "return_chains".

C++ signature :
    bool return_chains_has_listener(TRackDevicePyHandle,boost::python::api::object)
save_preset_to_compare_ab_slot(...)

save_preset_to_compare_ab_slot( (Device)arg1) -> None : Saves the current state of the device to the compare AB slot. Only relevant if can_compare_ab, otherwise throws.

C++ signature :
    void save_preset_to_compare_ab_slot(TPyHandle<ADevice>)
store_chosen_bank(...)

store_chosen_bank( (Device)arg1, (int)arg2, (int)arg3) -> None : Set the selected bank in the device for persistency.

C++ signature :
    void store_chosen_bank(TPyHandle<ADevice>,int,int)
store_variation(...)

store_variation( (Device)arg1) -> None : Stores a new variation of the values of all currently mapped macros

C++ signature :
    void store_variation(TPyHandle<ADevice>)
variation_count_has_listener(...)

variation_count_has_listener( (RackDevice)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "variation_count".

C++ signature :
    bool variation_count_has_listener(TRackDevicePyHandle,boost::python::api::object)
visible_drum_pads_has_listener(...)

visible_drum_pads_has_listener( (RackDevice)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "visible_drum_pads".

C++ signature :
    bool visible_drum_pads_has_listener(TRackDevicePyHandle,boost::python::api::object)
visible_macro_count_has_listener(...)

visible_macro_count_has_listener( (RackDevice)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "visible_macro_count".

C++ signature :
    bool visible_macro_count_has_listener(TRackDevicePyHandle,boost::python::api::object)