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.

Track

Hierarchy

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

Index

Constructors

constructor

new Track(ableton, raw, path?): Track
Creates an instance of Track.
Parameters
- ableton: AbletonLiveBase
- raw: RawTrack
- Optional path: string
Returns Track
Memberof
Track
Overrides Properties< TrackGetProperties, TrackChildrenProperties, TrackTransformedProperties, TrackSetProperties, TrackObservableProperties >.constructor
- Defined in Track.ts:461

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

Returns string
Memberof
Track
- Defined in Track.ts:562

path

get path(): string
Returns string
Inherited from Properties.path
- Defined in Properties.ts:24

type

get type(): TrackType
The type of track

Returns TrackType
Memberof
Track
- Defined in Track.ts:573

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:83

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:57

deleteDevice

deleteDevice(index): Promise<void>
Delete the device at the given index.
Parameters
- index: number
Returns Promise<void>
Memberof
Track
- Defined in Track.ts:608

duplicateClipSlot

duplicateClipSlot(index): Promise<void>
Works like 'Duplicate' in a clip's context menu.
Parameters
- index: number
Returns Promise<void>
Memberof
Track
- Defined in Track.ts:619

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:41

getClip

getClip(scene): Promise<null | Clip>
Get a specific clip based on Scene number
Parameters
- scene: number
Returns Promise<null | Clip>
Memberof
Track
- Defined in Track.ts:508

getClips

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

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

getOrCreateClip

getOrCreateClip(scene, length?): Promise<Clip>
Get a specific clip based on Scene number and creates one if there's none
Parameters
- scene: number
  1 based
- Optional length: number = 4
Returns Promise<Clip>
Memberof
Track
- Defined in Track.ts:526

isGroupTrack

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

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

jumpInRunningSessionClip

jumpInRunningSessionClip(beats): Promise<void>
Jumps to a running session clip in this track.
Parameters
- beats: number
Returns Promise<void>
Memberof
Track
- Defined in Track.ts:669

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:96

panning

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

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

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:92

stopAllClips

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

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

volume

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

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

`Static` getPath

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

Class Track

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Track

Memberof

Properties

raw

Static path

Accessors

id

Returns undefined | number

name

Returns string

Memberof

path

Returns string

type

Returns TrackType

Memberof

Methods

child

Type Parameters

Parameters

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

children

Type Parameters

Parameters

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

deleteDevice

Parameters

Returns Promise<void>

Memberof

duplicateClipSlot

Parameters

Returns Promise<void>

Memberof

get

Type Parameters

Parameters

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

getClip

Parameters

Returns Promise<null | Clip>

Memberof

getClips

Returns Promise<(null | Clip)[]>

Memberof

getOrCreateClip

Parameters

Returns Promise<Clip>

Memberof

isGroupTrack

Returns Promise<boolean>

Memberof

jumpInRunningSessionClip

Parameters

Returns Promise<void>

Memberof

observe

Type Parameters

Parameters

Parameters

Returns any

Returns Promise<any>

panning

Returns Promise<DeviceParameter>

Memberof

set

Type Parameters

Parameters

Returns Promise<null>

stopAllClips

Returns Promise<void>

`Static` path

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

`Static` getPath