PluginDevice (Module)

PluginDevice (Class)

Live.PluginDevice.PluginDevice

This class represents a plugin device.

Live Object: yes

Properties

Property	Type	Supports
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
name	str	get/set
parameters	ATimeableValueVector	get
presets	StringVector	get/listen
selected_preset_index	int	get/set/listen
type	DeviceType	get
view	Device.View	get

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.

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.

presets

• Type: StringVector
• Settable: no
• Listenable: yes

Get the list of presets the plugin offers.

selected_preset_index

• Type: int
• Settable: yes
• Listenable: yes

Access to the index of the currently selected preset.

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_parameter_names()	StringVector

get_parameter_names(begin: int = 0, end: int = -1)

• Returns: StringVector
• Args:
• begin: int = 0
• end: int = -1

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.