Live.RoarDevice (runtime)

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

Classes

class RoarDevice(Device)

This class represents a Roar 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.
• canonical_parent - Get the canonical parent of the Device.
• 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.
• env_listen - Return the Envelope Input Listen toggle state
• 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_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.
• name - Return access to the name of the device.
• parameters - Const access to the list of available automatable parameters for this device.
• routing_mode_index - Return the routing mode index
• routing_mode_list - Return the routing mode list
• type - Return the type of the device.
• view - Representing the view aspects of a device.

Methods

View(...)

Representing the view aspects of a device.

__init__(...)

Raises an exception This class cannot be instantiated from Python

add_env_listen_listener(...)

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

C++ signature :
    void add_env_listen_listener(TRoarDevicePyHandle,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_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_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_routing_mode_index_listener(...)

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

C++ signature :
    void add_routing_mode_index_listener(TRoarDevicePyHandle,boost::python::api::object)

env_listen_has_listener(...)

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

C++ signature :
    bool env_listen_has_listener(TRoarDevicePyHandle,boost::python::api::object)

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_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)

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)

remove_env_listen_listener(...)

remove_env_listen_listener( (RoarDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "env_listen".

C++ signature :
    void remove_env_listen_listener(TRoarDevicePyHandle,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_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_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_routing_mode_index_listener(...)

remove_routing_mode_index_listener( (RoarDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "routing_mode_index".

C++ signature :
    void remove_routing_mode_index_listener(TRoarDevicePyHandle,boost::python::api::object)

routing_mode_index_has_listener(...)

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

C++ signature :
    bool routing_mode_index_has_listener(TRoarDevicePyHandle,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)