Class Track

This class represents a track in Live. It can either be an audio track, a MIDI track, a return track or the master track. The master track and at least one Audio or MIDI track will be always present. Return tracks are optional.

Not all properties are supported by all types of tracks. The properties are marked accordingly.

Hierarchy

Properties<TrackGetProperties, TrackChildrenProperties, TrackTransformedProperties, TrackSetProperties, TrackObservableProperties>
- Track

Index

Constructors

constructor

new Track(ableton, raw, path?): Track
Creates an instance of Track.

Memberof
Track
Parameters
- ableton: AbletonLive
- raw: RawTrack
- Optional path: string
Returns Track
Overrides Properties< TrackGetProperties, TrackChildrenProperties, TrackTransformedProperties, TrackSetProperties, TrackObservableProperties >.constructor
- Defined in Track.ts:460

Properties

raw

raw: RawTrack

`Static` path

path: string = 'live_set tracks $1'

Accessors

id

get id(): undefined | number
Returns undefined | number
Inherited from Properties.id
- Defined in Properties.ts:20

name

get name(): string
The name of the track

Memberof
Track

Returns string
- Defined in Track.ts:555

type

get type(): TrackType
The type of track

Memberof
Track

Returns TrackType
- Defined in Track.ts:566

Methods

child

child<TName>(child, index, childProps?): Promise<FlatPropertyType<TName, TrackTransformedProperties, TrackChildrenProperties>>
Type Parameters
- TName extends OnlyKeysWithArrayValues<TrackChildrenProperties, TrackTransformedProperties>
Parameters
- child: TName
- index: number
- Optional childProps: string[]
Returns Promise<FlatPropertyType<TName, TrackTransformedProperties, TrackChildrenProperties>>
Inherited from Properties.child
- Defined in Properties.ts:75

children

children<TName>(child, childProps?, index?): Promise<PropertyType<TName, TrackTransformedProperties, TrackChildrenProperties>>
Type Parameters
- TName extends keyof TrackChildrenProperties
Parameters
- child: TName
- Optional childProps: string[]
- Optional index: number
Returns Promise<PropertyType<TName, TrackTransformedProperties, TrackChildrenProperties>>
Inherited from Properties.children
- Defined in Properties.ts:53

deleteDevice

deleteDevice(index): Promise<void>
Delete the device at the given index.

Memberof
Track
Parameters
- index: number
Returns Promise<void>
- Defined in Track.ts:601

duplicateClipSlot

duplicateClipSlot(index): Promise<void>
Works like 'Duplicate' in a clip's context menu.

Memberof
Track
Parameters
- index: number
Returns Promise<void>
- Defined in Track.ts:612

get

get<T>(prop): Promise<T extends keyof TrackTransformedProperties
? TrackTransformedProperties[T]
: TrackGetProperties[T]>
Type Parameters
- T extends keyof TrackGetProperties
Parameters
- prop: T
Returns Promise<T extends keyof TrackTransformedProperties
? TrackTransformedProperties[T]
: TrackGetProperties[T]>
Inherited from Properties.get
- Defined in Properties.ts:37

getClip

getClip(scene): Promise<null | Clip>
Get a specific clip based on Scene number

Memberof
Track
Parameters
- scene: number
Returns Promise<null | Clip>
- Defined in Track.ts:503

getClips

getClips(): Promise<(null | Clip)[]>
Get all clips in a track

Memberof
Track

Returns Promise<(null | Clip)[]>
- Defined in Track.ts:491

getOrCreateClip

getOrCreateClip(scene, length?): Promise<Clip>
Get a specific clip based on Scene number and creates one if there's none

Memberof
Track
Parameters
- scene: number
- Optional length: number = 4
Returns Promise<Clip>
- Defined in Track.ts:521

isGroupTrack

isGroupTrack(): Promise<boolean>
Is the track a group track

Memberof
Track

Returns Promise<boolean>
- Defined in Track.ts:539

observe

observe<T>(prop, listener): Promise<any>
Type Parameters
- T extends keyof TrackChildrenProperties | keyof TrackObservableProperties
Parameters
- prop: T
- listener: ((data) => any)
  - - (data): any
    - Parameters
      
      data: T extends keyof TrackObservableProperties
          ? TrackObservableProperties[T]
          : T extends keyof TrackTransformedProperties
              ? TrackTransformedProperties[T]
              : any
      
      Returns any
Returns Promise<any>
Inherited from Properties.observe
- Defined in Properties.ts:84

panning

panning(): Promise<DeviceParameter>
Get the panning of the track

Memberof
Track

Returns Promise<DeviceParameter>
- Defined in Track.ts:588

set

set<T>(prop, value): Promise<null>
Type Parameters
- T extends keyof TrackSetProperties
Parameters
- prop: T
- value: TrackSetProperties[T]
Returns Promise<null>
Inherited from Properties.set
- Defined in Properties.ts:80

stopAllClips

stopAllClips(): Promise<void>
Stops all playing and fired clips in this track.

Memberof
Track

Returns Promise<void>
- Defined in Track.ts:622

volume

volume(): Promise<DeviceParameter>
Get the volume of the track

Memberof
Track

Returns Promise<DeviceParameter>
- Defined in Track.ts:576

`Static` getPath

getPath(trackNumber): string
Parameters
- trackNumber: number
Returns string
- Defined in Track.ts:436

Class Track

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Memberof

Parameters

ableton: AbletonLive

raw: RawTrack

Optional path: string

Returns Track

Properties

raw

Static path

Accessors

id

Returns undefined | number

name

Memberof

Returns string

type

Memberof

Returns TrackType

Methods

child

Type Parameters

TName extends OnlyKeysWithArrayValues<TrackChildrenProperties, TrackTransformedProperties>

Parameters

child: TName

index: number

Optional childProps: string[]

Returns Promise<FlatPropertyType<TName, TrackTransformedProperties, TrackChildrenProperties>>

children

Type Parameters

TName extends keyof TrackChildrenProperties

Parameters

child: TName

Optional childProps: string[]

Optional index: number

Returns Promise<PropertyType<TName, TrackTransformedProperties, TrackChildrenProperties>>

deleteDevice

Memberof

Parameters

index: number

Returns Promise<void>

duplicateClipSlot

Memberof

Parameters

index: number

Returns Promise<void>

get

Type Parameters

T extends keyof TrackGetProperties

Parameters

prop: T

Returns Promise<T extends keyof TrackTransformedProperties ? TrackTransformedProperties[T] : TrackGetProperties[T]>

getClip

Memberof

Parameters

scene: number

Returns Promise<null | Clip>

getClips

Memberof

Returns Promise<(null | Clip)[]>

getOrCreateClip

Memberof

Parameters

scene: number

Optional length: number = 4

Returns Promise<Clip>

isGroupTrack

Memberof

Returns Promise<boolean>

observe

Type Parameters

T extends keyof TrackChildrenProperties | keyof TrackObservableProperties

`Optional` path: string

`Static` path

`Optional` childProps: string[]

`Optional` childProps: string[]

`Optional` index: number

Returns Promise<T extends keyof TrackTransformedProperties
? TrackTransformedProperties[T]
: TrackGetProperties[T]>

`Optional` length: number = 4

data: T extends keyof TrackObservableProperties
? TrackObservableProperties[T]
: T extends keyof TrackTransformedProperties
? TrackTransformedProperties[T]
: any

`Static` getPath