PluginDevice
Represents a third-party VST, AU, or CLAP plug-in hosted by Live. The
PluginDevice class extends Device with the plug-in’s program list, the
ability to step through factory presets, and the larger parameter surface
exposed by external plug-ins.
PluginDevice
Section titled “PluginDevice”This class represents a plugin device. From Live’s runtime docstring.
Properties
Section titled “Properties”Inherited from LomObject
_live_ptr: int
Section titled “_live_ptr: int”canonical_parent: Track
Section titled “canonical_parent: Track”Get the canonical parent of the Device. From Live’s runtime docstring.
Inherited from Device
can_compare_ab: bool
Section titled “can_compare_ab: bool”Returns true if the Device has the capability to AB compare. From Live’s runtime docstring.
can_have_chains: bool
Section titled “can_have_chains: bool”Returns true if the device is a rack. From Live’s runtime docstring.
can_have_drum_pads: bool
Section titled “can_have_drum_pads: bool”Returns true if the device is a drum rack. From Live’s runtime docstring.
class_display_name: str
Section titled “class_display_name: str”Return const access to the name of the device’s class name as displayed in Live’s browser and device chain From Live’s runtime docstring.
class_name: str
Section titled “class_name: str”Return const access to the name of the device’s class. From Live’s runtime docstring.
is_using_compare_preset_b: bool
Section titled “is_using_compare_preset_b: bool”Returns whether the Device has loaded the preset in compare slot B. Only relevant if can_compare_ab, otherwise errors. From Live’s runtime docstring.
Return the type of the device. From Live’s runtime docstring.
Representing the view aspects of a device. From Live’s runtime docstring.
is_active: bool
Section titled “is_active: bool”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. From Live’s runtime docstring.
latency_in_ms: float
Section titled “latency_in_ms: float”Returns the latency of the device in ms. From Live’s runtime docstring.
latency_in_samples: int
Section titled “latency_in_samples: int”Returns the latency of the device in samples. From Live’s runtime docstring.
name: str
Section titled “name: str”Return access to the name of the device. From Live’s runtime docstring.
Const access to the list of available automatable parameters for this device. From Live’s runtime docstring.
Get the list of presets the plugin offers. From Live’s runtime docstring.
selected_preset_index: int
Section titled “selected_preset_index: int”Access to the index of the currently selected preset. From Live’s runtime docstring.
Methods
Section titled “Methods”Inherited from Device
save_preset_to_compare_ab_slot()
Section titled “save_preset_to_compare_ab_slot()”Saves the current state of the device to the compare AB slot. Only relevant if can_compare_ab, otherwise throws. From Live’s runtime docstring.
store_chosen_bank()
Section titled “store_chosen_bank()”- script_index: int
- bank_index: int
Set the selected bank in the device for persistency. From Live’s runtime docstring.
get_parameter_names()
Section titled “get_parameter_names()”- 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. From Live’s runtime docstring.
This is an independent reference site. Not affiliated with, endorsed by, or sponsored by Ableton AG. “Ableton”, “Live”, “Push”, and related marks are trademarks of Ableton AG.