MaxDevice (Module)¶
MaxDevice (Class)¶
Live.MaxDevice.MaxDevice
This class represents a Max for Live device.
Live Object: yes
Properties¶
| Property | Type | Supports |
|---|---|---|
audio_inputs |
Vector[DeviceIO] |
get/listen |
audio_outputs |
Vector[DeviceIO] |
get/listen |
can_compare_ab |
bool |
get |
can_have_chains |
bool |
get |
can_have_drum_pads |
bool |
get |
canonical_parent |
Track |
get |
class_display_name |
str |
get |
class_name |
str |
get |
is_active |
bool |
get |
is_using_compare_preset_b |
bool |
get/set |
latency_in_ms |
float |
get |
latency_in_samples |
int |
get |
midi_inputs |
Vector |
get/listen |
midi_outputs |
Vector |
get/listen |
name |
str |
get/set |
parameters |
ATimeableValueVector |
get |
type |
DeviceType |
get |
view |
Device.View |
get |
audio_inputs¶
- Type:
Vector[DeviceIO] - Settable:
no - Listenable:
yes
Const access to a list of all audio inputs of the device.
audio_outputs¶
- Type:
Vector[DeviceIO] - Settable:
no - Listenable:
yes
Const access to a list of all audio outputs of the device.
can_compare_ab¶
- Type:
bool - Settable:
no - Listenable:
no
Returns true if the Device has the capability to AB compare.
can_have_chains¶
- Type:
bool - Settable:
no - Listenable:
no
Returns true if the device is a rack.
can_have_drum_pads¶
- Type:
bool - Settable:
no - Listenable:
no
Returns true if the device is a drum rack.
canonical_parent¶
- Type:
Track - Settable:
no - Listenable:
no
Get the canonical parent of the Device.
class_display_name¶
- Type:
str - Settable:
no - Listenable:
no
Return const access to the name of the device's class name as displayed in Live's browser and device chain
class_name¶
- Type:
str - Settable:
no - Listenable:
no
Return const access to the name of the device's class.
is_active¶
- Type:
bool - Settable:
no - Listenable:
no
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¶
- Type:
bool - Settable:
yes - Listenable:
no
Returns whether the Device has loaded the preset in compare slot B. Only relevant if can_compare_ab, otherwise errors.
latency_in_ms¶
- Type:
float - Settable:
no - Listenable:
no
Returns the latency of the device in ms.
latency_in_samples¶
- Type:
int - Settable:
no - Listenable:
no
Returns the latency of the device in samples.
midi_inputs¶
- Type:
Vector - Settable:
no - Listenable:
yes
Const access to a list of all midi outputs of the device.
midi_outputs¶
- Type:
Vector - Settable:
no - Listenable:
yes
Const access to a list of all midi outputs of the device.
name¶
- Type:
str - Settable:
yes - Listenable:
no
Return access to the name of the device.
parameters¶
- Type:
ATimeableValueVector - Settable:
no - Listenable:
no
Const access to the list of available automatable parameters for this device.
type¶
- Type:
DeviceType - Settable:
no - Listenable:
no
Return the type of the device.
view¶
- Type:
Device.View - Settable:
no - Listenable:
no
Representing the view aspects of a device.
Methods¶
| Method | Returns |
|---|---|
get_bank_count() |
int |
get_bank_name() |
str |
get_bank_parameters() |
list[int] |
get_value_item_icons() |
list[str] |
get_bank_count()¶
- Returns:
int
Get the number of parameter banks. This is related to hardware control surfaces.
get_bank_name(bank_index: int)¶
- Returns:
str - Args:
bank_index: int
Get the name of a parameter bank given by index. This is related to hardware control surfaces.
get_bank_parameters(bank_index: int)¶
- Returns:
list[int] - Args:
bank_index: int
Get the indices of parameters of the given bank index. Empty slots are marked as -1. Bank index -1 refers to the best-of bank. This function is related to hardware control surfaces.
get_value_item_icons(device_parameter: DeviceParameter)¶
- Returns:
list[str] - Args:
device_parameter: DeviceParameter
Get a list of icon identifier strings for a list parameter's values.An empty string is given where no icon should be displayed.An empty list is given when no icons should be displayed.This is related to hardware control surfaces.