CompressorDevice

Represents an instance of Live’s Compressor audio effect. The CompressorDevice class extends Device with the metering and visualization values unique to Compressor’s UI.

CompressorDevice

This class represents a Compressor device. ^{From Live’s runtime docstring.}

Properties

Inherited from LomObject

_live_ptr: int

canonical_parent: Track

Get the canonical parent of the Device. ^{From Live’s runtime docstring.}

Inherited from Device

can_compare_ab: bool

Returns true if the Device has the capability to AB compare. ^{From Live’s runtime docstring.}

can_have_chains: bool

Returns true if the device is a rack. ^{From Live’s runtime docstring.}

can_have_drum_pads: bool

Returns true if the device is a drum rack. ^{From Live’s runtime docstring.}

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

Return const access to the name of the device’s class. ^{From Live’s runtime docstring.}

type: DeviceType

Return the type of the device. ^{From Live’s runtime docstring.}

view: View

Representing the view aspects of a device. ^{From Live’s runtime docstring.}

available_input_routing_channels: RoutingChannelVector

Return a list of source channels for input routing in the sidechain. ^{From Live’s runtime docstring.}

available_input_routing_types: RoutingTypeVector

Return a list of source types for input routing in the sidechain. ^{From Live’s runtime docstring.}

input_routing_channel: RoutingChannel

Get and set the current source channel for input routing in the sidechain. Raises ValueError if the channel isn’t one of the current values in available_input_routing_channels. ^{From Live’s runtime docstring.}

input_routing_type: RoutingType

Get and set the current source type for input routing in the sidechain. Raises ValueError if the type isn’t one of the current values in available_input_routing_types. ^{From Live’s runtime docstring.}

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.}

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.}

latency_in_ms: float

Returns the latency of the device in ms. ^{From Live’s runtime docstring.}

latency_in_samples: int

Returns the latency of the device in samples. ^{From Live’s runtime docstring.}

name: str

Return access to the name of the device. ^{From Live’s runtime docstring.}

parameters: ATimeableValueVector

Const access to the list of available automatable parameters for this device. ^{From Live’s runtime docstring.}

Methods

Inherited from Device

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

Parameters

• script_index: int
• bank_index: int

Set the selected bank in the device for persistency. ^{From Live’s runtime docstring.}