Live.CompressorDevice (runtime)

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

Classes

class CompressorDevice(Device)

This class represents a Compressor device.

Properties

• _live_ptr
• available_input_routing_channels - Return a list of source channels for input routing in the sidechain.
• available_input_routing_types - Return a list of source types for input routing in the sidechain.
• 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.
• input_routing_channel - Get and set the current source channel for input routing in the sidechain.
• input_routing_type - Get and set the current source type for input routing in the sidechain.
• 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.
• 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.
• 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_available_input_routing_channels_listener(...)

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

C++ signature :
    void add_available_input_routing_channels_listener(TCompressorDevicePyHandle,boost::python::api::object)

add_available_input_routing_types_listener(...)

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

C++ signature :
    void add_available_input_routing_types_listener(TCompressorDevicePyHandle,boost::python::api::object)

add_input_routing_channel_listener(...)

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

C++ signature :
    void add_input_routing_channel_listener(TCompressorDevicePyHandle,boost::python::api::object)

add_input_routing_type_listener(...)

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

C++ signature :
    void add_input_routing_type_listener(TCompressorDevicePyHandle,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_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)

available_input_routing_channels_has_listener(...)

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

C++ signature :
    bool available_input_routing_channels_has_listener(TCompressorDevicePyHandle,boost::python::api::object)

available_input_routing_types_has_listener(...)

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

C++ signature :
    bool available_input_routing_types_has_listener(TCompressorDevicePyHandle,boost::python::api::object)

input_routing_channel_has_listener(...)

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

C++ signature :
    bool input_routing_channel_has_listener(TCompressorDevicePyHandle,boost::python::api::object)

input_routing_type_has_listener(...)

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

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

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_available_input_routing_channels_listener(...)

remove_available_input_routing_channels_listener( (CompressorDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "available_input_routing_channels".

C++ signature :
    void remove_available_input_routing_channels_listener(TCompressorDevicePyHandle,boost::python::api::object)

remove_available_input_routing_types_listener(...)

remove_available_input_routing_types_listener( (CompressorDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "available_input_routing_types".

C++ signature :
    void remove_available_input_routing_types_listener(TCompressorDevicePyHandle,boost::python::api::object)

remove_input_routing_channel_listener(...)

remove_input_routing_channel_listener( (CompressorDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "input_routing_channel".

C++ signature :
    void remove_input_routing_channel_listener(TCompressorDevicePyHandle,boost::python::api::object)

remove_input_routing_type_listener(...)

remove_input_routing_type_listener( (CompressorDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "input_routing_type".

C++ signature :
    void remove_input_routing_type_listener(TCompressorDevicePyHandle,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_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)

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)