Skip to content

Live.DriftDevice (runtime)

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

Classes

class DriftDevice(Device)

This class represents a Drift 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.
  • mod_matrix_filter_source_1_index - Return the filter mod source 1 index
  • mod_matrix_filter_source_1_list - Return the filter mod source 1 list
  • mod_matrix_filter_source_2_index - Return the filter mod source 2 index
  • mod_matrix_filter_source_2_list - Return the filter mod source 2 list
  • mod_matrix_lfo_source_index - Return the lfo mod source index
  • mod_matrix_lfo_source_list - Return the lfo mod source list
  • mod_matrix_pitch_source_1_index - Return the pitch mod source 1 index
  • mod_matrix_pitch_source_1_list - Return the pitch mod source 1 list
  • mod_matrix_pitch_source_2_index - Return the pitch mod source 2 index
  • mod_matrix_pitch_source_2_list - Return the pitch mod source 2 list
  • mod_matrix_shape_source_index - Return the shape mod source index
  • mod_matrix_shape_source_list - Return the shape mod source list
  • mod_matrix_source_1_index - Return the custom mod source 1 index
  • mod_matrix_source_1_list - Return the custom mod source 1 list
  • mod_matrix_source_2_index - Return the custom mod source 2 index
  • mod_matrix_source_2_list - Return the custom mod source 2 list
  • mod_matrix_source_3_index - Return the custom mod source 3 index
  • mod_matrix_source_3_list - Return the custom mod source 3 list
  • mod_matrix_target_1_index - Return the custom mod target 1 index
  • mod_matrix_target_1_list - Return the custom mod target 1 list
  • mod_matrix_target_2_index - Return the custom mod target 2 index
  • mod_matrix_target_2_list - Return the custom mod target 2 list
  • mod_matrix_target_3_index - Return the custom mod target 3 index
  • mod_matrix_target_3_list - Return the custom mod target 3 list
  • name - Return access to the name of the device.
  • parameters - Const access to the list of available automatable parameters for this device.
  • pitch_bend_range - Return the Pitch Bend Range
  • type - Return the type of the device.
  • view - Representing the view aspects of a device.
  • voice_count_index - Return the voice count index
  • voice_count_list - Return the voice count list
  • voice_mode_index - Return the voice mode index
  • voice_mode_list - Return the voice mode list

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

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

C++ signature :
    void add_mod_matrix_filter_source_1_index_listener(TDriftDevicePyHandle,boost::python::api::object)
add_mod_matrix_filter_source_2_index_listener(...)

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

C++ signature :
    void add_mod_matrix_filter_source_2_index_listener(TDriftDevicePyHandle,boost::python::api::object)
add_mod_matrix_lfo_source_index_listener(...)

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

C++ signature :
    void add_mod_matrix_lfo_source_index_listener(TDriftDevicePyHandle,boost::python::api::object)
add_mod_matrix_pitch_source_1_index_listener(...)

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

C++ signature :
    void add_mod_matrix_pitch_source_1_index_listener(TDriftDevicePyHandle,boost::python::api::object)
add_mod_matrix_pitch_source_2_index_listener(...)

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

C++ signature :
    void add_mod_matrix_pitch_source_2_index_listener(TDriftDevicePyHandle,boost::python::api::object)
add_mod_matrix_shape_source_index_listener(...)

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

C++ signature :
    void add_mod_matrix_shape_source_index_listener(TDriftDevicePyHandle,boost::python::api::object)
add_mod_matrix_source_1_index_listener(...)

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

C++ signature :
    void add_mod_matrix_source_1_index_listener(TDriftDevicePyHandle,boost::python::api::object)
add_mod_matrix_source_2_index_listener(...)

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

C++ signature :
    void add_mod_matrix_source_2_index_listener(TDriftDevicePyHandle,boost::python::api::object)
add_mod_matrix_source_3_index_listener(...)

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

C++ signature :
    void add_mod_matrix_source_3_index_listener(TDriftDevicePyHandle,boost::python::api::object)
add_mod_matrix_target_1_index_listener(...)

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

C++ signature :
    void add_mod_matrix_target_1_index_listener(TDriftDevicePyHandle,boost::python::api::object)
add_mod_matrix_target_2_index_listener(...)

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

C++ signature :
    void add_mod_matrix_target_2_index_listener(TDriftDevicePyHandle,boost::python::api::object)
add_mod_matrix_target_3_index_listener(...)

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

C++ signature :
    void add_mod_matrix_target_3_index_listener(TDriftDevicePyHandle,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_pitch_bend_range_listener(...)

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

C++ signature :
    void add_pitch_bend_range_listener(TDriftDevicePyHandle,boost::python::api::object)
add_voice_count_index_listener(...)

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

C++ signature :
    void add_voice_count_index_listener(TDriftDevicePyHandle,boost::python::api::object)
add_voice_mode_index_listener(...)

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

C++ signature :
    void add_voice_mode_index_listener(TDriftDevicePyHandle,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)
mod_matrix_filter_source_1_index_has_listener(...)

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

C++ signature :
    bool mod_matrix_filter_source_1_index_has_listener(TDriftDevicePyHandle,boost::python::api::object)
mod_matrix_filter_source_2_index_has_listener(...)

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

C++ signature :
    bool mod_matrix_filter_source_2_index_has_listener(TDriftDevicePyHandle,boost::python::api::object)
mod_matrix_lfo_source_index_has_listener(...)

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

C++ signature :
    bool mod_matrix_lfo_source_index_has_listener(TDriftDevicePyHandle,boost::python::api::object)
mod_matrix_pitch_source_1_index_has_listener(...)

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

C++ signature :
    bool mod_matrix_pitch_source_1_index_has_listener(TDriftDevicePyHandle,boost::python::api::object)
mod_matrix_pitch_source_2_index_has_listener(...)

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

C++ signature :
    bool mod_matrix_pitch_source_2_index_has_listener(TDriftDevicePyHandle,boost::python::api::object)
mod_matrix_shape_source_index_has_listener(...)

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

C++ signature :
    bool mod_matrix_shape_source_index_has_listener(TDriftDevicePyHandle,boost::python::api::object)
mod_matrix_source_1_index_has_listener(...)

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

C++ signature :
    bool mod_matrix_source_1_index_has_listener(TDriftDevicePyHandle,boost::python::api::object)
mod_matrix_source_2_index_has_listener(...)

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

C++ signature :
    bool mod_matrix_source_2_index_has_listener(TDriftDevicePyHandle,boost::python::api::object)
mod_matrix_source_3_index_has_listener(...)

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

C++ signature :
    bool mod_matrix_source_3_index_has_listener(TDriftDevicePyHandle,boost::python::api::object)
mod_matrix_target_1_index_has_listener(...)

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

C++ signature :
    bool mod_matrix_target_1_index_has_listener(TDriftDevicePyHandle,boost::python::api::object)
mod_matrix_target_2_index_has_listener(...)

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

C++ signature :
    bool mod_matrix_target_2_index_has_listener(TDriftDevicePyHandle,boost::python::api::object)
mod_matrix_target_3_index_has_listener(...)

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

C++ signature :
    bool mod_matrix_target_3_index_has_listener(TDriftDevicePyHandle,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)
pitch_bend_range_has_listener(...)

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

C++ signature :
    bool pitch_bend_range_has_listener(TDriftDevicePyHandle,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_mod_matrix_filter_source_1_index_listener(...)

remove_mod_matrix_filter_source_1_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "mod_matrix_filter_source_1_index".

C++ signature :
    void remove_mod_matrix_filter_source_1_index_listener(TDriftDevicePyHandle,boost::python::api::object)
remove_mod_matrix_filter_source_2_index_listener(...)

remove_mod_matrix_filter_source_2_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "mod_matrix_filter_source_2_index".

C++ signature :
    void remove_mod_matrix_filter_source_2_index_listener(TDriftDevicePyHandle,boost::python::api::object)
remove_mod_matrix_lfo_source_index_listener(...)

remove_mod_matrix_lfo_source_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "mod_matrix_lfo_source_index".

C++ signature :
    void remove_mod_matrix_lfo_source_index_listener(TDriftDevicePyHandle,boost::python::api::object)
remove_mod_matrix_pitch_source_1_index_listener(...)

remove_mod_matrix_pitch_source_1_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "mod_matrix_pitch_source_1_index".

C++ signature :
    void remove_mod_matrix_pitch_source_1_index_listener(TDriftDevicePyHandle,boost::python::api::object)
remove_mod_matrix_pitch_source_2_index_listener(...)

remove_mod_matrix_pitch_source_2_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "mod_matrix_pitch_source_2_index".

C++ signature :
    void remove_mod_matrix_pitch_source_2_index_listener(TDriftDevicePyHandle,boost::python::api::object)
remove_mod_matrix_shape_source_index_listener(...)

remove_mod_matrix_shape_source_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "mod_matrix_shape_source_index".

C++ signature :
    void remove_mod_matrix_shape_source_index_listener(TDriftDevicePyHandle,boost::python::api::object)
remove_mod_matrix_source_1_index_listener(...)

remove_mod_matrix_source_1_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "mod_matrix_source_1_index".

C++ signature :
    void remove_mod_matrix_source_1_index_listener(TDriftDevicePyHandle,boost::python::api::object)
remove_mod_matrix_source_2_index_listener(...)

remove_mod_matrix_source_2_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "mod_matrix_source_2_index".

C++ signature :
    void remove_mod_matrix_source_2_index_listener(TDriftDevicePyHandle,boost::python::api::object)
remove_mod_matrix_source_3_index_listener(...)

remove_mod_matrix_source_3_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "mod_matrix_source_3_index".

C++ signature :
    void remove_mod_matrix_source_3_index_listener(TDriftDevicePyHandle,boost::python::api::object)
remove_mod_matrix_target_1_index_listener(...)

remove_mod_matrix_target_1_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "mod_matrix_target_1_index".

C++ signature :
    void remove_mod_matrix_target_1_index_listener(TDriftDevicePyHandle,boost::python::api::object)
remove_mod_matrix_target_2_index_listener(...)

remove_mod_matrix_target_2_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "mod_matrix_target_2_index".

C++ signature :
    void remove_mod_matrix_target_2_index_listener(TDriftDevicePyHandle,boost::python::api::object)
remove_mod_matrix_target_3_index_listener(...)

remove_mod_matrix_target_3_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "mod_matrix_target_3_index".

C++ signature :
    void remove_mod_matrix_target_3_index_listener(TDriftDevicePyHandle,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_pitch_bend_range_listener(...)

remove_pitch_bend_range_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "pitch_bend_range".

C++ signature :
    void remove_pitch_bend_range_listener(TDriftDevicePyHandle,boost::python::api::object)
remove_voice_count_index_listener(...)

remove_voice_count_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "voice_count_index".

C++ signature :
    void remove_voice_count_index_listener(TDriftDevicePyHandle,boost::python::api::object)
remove_voice_mode_index_listener(...)

remove_voice_mode_index_listener( (DriftDevice)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "voice_mode_index".

C++ signature :
    void remove_voice_mode_index_listener(TDriftDevicePyHandle,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)
voice_count_index_has_listener(...)

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

C++ signature :
    bool voice_count_index_has_listener(TDriftDevicePyHandle,boost::python::api::object)
voice_mode_index_has_listener(...)

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

C++ signature :
    bool voice_mode_index_has_listener(TDriftDevicePyHandle,boost::python::api::object)