Class Chain<Version>

Represents a device chain.

Type Parameters

Version extends ApiVersion

Hierarchy (View Summary)

DataModelObject<Version>
- Chain
  - DrumChain

Index

Properties

handle className

Accessors

devices mixer parent

Methods

deleteDevice duplicateDevice insertDevice

Properties

`Readonly`handle

handle: Handle

`Static` `Readonly`className

className: string = "Chain"

Accessors

devices

get devices(): Device<Version>[]
Returns Device<Version>[]

mixer

get mixer(): ChainMixer<Version>
Returns ChainMixer<Version>

parent

get parent(): DataModelObject<Version> | null
The canonical parent of this object in Live's object hierarchy, or null if it has none.

Returns DataModelObject<Version> | null
Inherited from DataModelObject.parent

Methods

deleteDevice

deleteDevice(device: Device<Version>): Promise<void>
Deletes a device from this chain. Await the returned promise to ensure the deletion has been fully processed.
Parameters
- device: Device<Version>
Returns Promise<void>

duplicateDevice

duplicateDevice(device: Device<Version>): Promise<Device<Version>>
The duplicate is inserted directly after the original in the device chain.
Parameters
- device: Device<Version>
Returns Promise<Device<Version>>

insertDevice

insertDevice(deviceName: string, index: number): Promise<Device<Version>>
Inserts a built-in Live device with its default preset into the chain. Only devices native to Live are supported — third-party plug-ins cannot be loaded this way.
Parameters
- deviceName: string
  The name of the built-in Live device (e.g. "Reverb", "Auto Filter").
- index: number
  Zero-based position in the device chain at which to insert.
Returns Promise<Device<Version>>