Live.PluginDevice (runtime)

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

Classes

class PluginDevice(Device)

This class represents a plugin 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.
• 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.
• 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.
• presets - Get the list of presets the plugin offers.
• selected_preset_index - Access to the index of the currently selected preset.
• 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_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)

add_presets_listener(...)

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

C++ signature :
    void add_presets_listener(TPluginDevicePyHandle,boost::python::api::object)

add_selected_preset_index_listener(...)

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

C++ signature :
    void add_selected_preset_index_listener(TPluginDevicePyHandle,boost::python::api::object)

get_parameter_names(...)

get_parameter_names( (PluginDevice)arg1 [, (int)begin=0 [, (int)end=-1]]) -> StringVector : Get the range of plugin parameter names, bound by begin and end. If end is smaller than 0 it is interpreted as the parameter count.

C++ signature :
    std::__1::vector<TString, std::__1::allocator<TString>> get_parameter_names(TPluginDevicePyHandle [,int=0 [,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)

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)

presets_has_listener(...)

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

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

remove_presets_listener(...)

remove_presets_listener( (PluginDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "presets".

C++ signature :
    void remove_presets_listener(TPluginDevicePyHandle,boost::python::api::object)

remove_selected_preset_index_listener(...)

remove_selected_preset_index_listener( (PluginDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "selected_preset_index".

C++ signature :
    void remove_selected_preset_index_listener(TPluginDevicePyHandle,boost::python::api::object)

selected_preset_index_has_listener(...)

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

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