Chain

Represents a single device chain inside an Instrument, Drum, Audio Effect, or MIDI Effect Rack. The Chain class hosts the chain’s nested devices, per-chain ChainMixerDevice, and key/velocity/chain-selector zones.

Chain

This class represents a group device chain in Live. ^{From Live’s runtime docstring.}

Properties

Inherited from LomObject

_live_ptr: int

canonical_parent: RackDevice

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

color: int

Access the color index of the Chain. ^{From Live’s runtime docstring.}

color_index: int

Access the color index of the Chain. ^{From Live’s runtime docstring.}

devices: Vector[Device]Probed asVector[LomObject]high confidence

• C++ signature binding declares the element type as LomObject — wider than what the container actually holds.
• sister method Track.devices is declared Vector[Device].
• docstring “all available Devices” — matches the narrower runtime type.
• corpus treats track.devices and chain.devices interchangeably as Device sequences: Launchpad_Pro/DrumGroupFinderComponent.py:65,74 filters track_or_chain.devices on d.type == DeviceType.instrument (Device.type is a DeviceType enum; only Devices carry it); Push2/device_navigation.py:134,269,511 indexes chain.devices[i] as Device; pushbase/browser_modes.py:84-92 indexes chain.devices as Device.

Return const access to all available Devices that are present in the chains ^{From Live’s runtime docstring.}

has_audio_input: bool

return True, if this Chain can be feed with an Audio signal. This is true for all Audio Chains. ^{From Live’s runtime docstring.}

has_audio_output: bool

return True, if this Chain sends out an Audio signal. This is true for all Audio Chains, and MIDI chains with an Instrument. ^{From Live’s runtime docstring.}

has_midi_input: bool

return True, if this Chain can be feed with an Audio signal. This is true for all MIDI Chains. ^{From Live’s runtime docstring.}

has_midi_output: bool

return True, if this Chain sends out MIDI events. This is true for all MIDI Chains with no Instruments. ^{From Live’s runtime docstring.}

is_auto_colored: bool

Get/set access to the auto color flag of the Chain. If True, the Chain will always have the same color as the containing Track or Chain. ^{From Live’s runtime docstring.}

mixer_device: ChainMixerDevice

Return access to the mixer device that holds the chain’s mixer parameters: the Volume, Pan, and Sendamounts. ^{From Live’s runtime docstring.}

mute: bool

Mute/unmute the chain. ^{From Live’s runtime docstring.}

muted_via_solo: bool

Return const access to whether this chain is muted due to some other chain being soloed. ^{From Live’s runtime docstring.}

name: str

Read/write access to the name of the Chain, as visible in the track header. ^{From Live’s runtime docstring.}

solo: bool

Get/Set the solo status of the chain. Note that this will not disable the solo state of any other Chain in the same rack. If you want exclusive solo, you have to disable the solo state of the other Chains manually. ^{From Live’s runtime docstring.}

Methods

delete_device()

Parameters

• index: int

Remove a device identified by its index from the chain. Throws runtime error if bad index. ^{From Live’s runtime docstring.}

duplicate_device()

Parameters

• index: int

Duplicate the device at the given index in the chain. ^{From Live’s runtime docstring.}

insert_device()

Parameters

• device_name: str
• device_index: int = -1

Returns

DeviceProbed asLomObjecthigh confidence

• C++ signature returns TWeakPtr<TPyHandleBase> (the generic LomObject handle) — no specific type enforced.
• probe chain.devices element_reprs are <class 'Device.Device'> (plus the WavetableDevice subclass) — the runtime returns properly-typed Device instances when iterated, so insert_device returning Device matches the observed instance type.
• docstring + [M4L] confirm semantics (“Add a device at a given index”).

Add a device at a given index in the chain. At end if -1. ^{From Live’s runtime docstring.}

Returned by 3 members elsewhere in the LOM

RackDevice

• insert_chain() → Chain

RackDevice.View

• selected_chain: Chain | None

Song.View

• selected_chain: Chain | None