Class Song

constructor

• new Song(ableton): Song

• Creates an instance of Song.

  Memberof

  Song

  Parameters

  • ableton: AbletonLive

  Returns Song

Static path

captureAndInsertScene

• captureAndInsertScene(): Promise<void>

• Capture the currently playing clips and insert them as a new scene below the selected scene.

  Memberof

  Song

  Returns Promise<void>

captureMidi

• captureMidi(destination?): Promise<void>

• Capture recently played MIDI material from audible tracks into a Live Clip. If destinaton is not set or it is set to auto, the Clip is inserted into the view currently visible in the focused Live window. Otherwise, it is inserted into the specified view.

  Memberof

  Song

  Parameters

  • destination: number = 0

    0 = auto, 1 = session, 2 = arrangement

  Returns Promise<void>

continuePlaying

• continuePlaying(): Promise<void>

• From the current playback position.

  Memberof

  Song

  Returns Promise<void>

createAudioTrack

• createAudioTrack(index?): Promise<void>

• Index determines where the track is added, it is only valid between 0 and len(song.tracks). Using an index of -1 will add the new track at the end of the list.

  Memberof

  Song

  Parameters

  • index: number = -1

  Returns Promise<void>

createMidiTrack

• createMidiTrack(index?): Promise<void>

• Index determines where the track is added, it is only valid between 0 and len(song.tracks). Using an index of -1 will add the new track at the end of the list.

  Memberof

  Song

  Parameters

  • index: number = -1

  Returns Promise<void>

createReturnTrack

• createReturnTrack(): Promise<void>

• Adds a new return track at the end.

  Memberof

  Song

  Returns Promise<void>

createScene

• createScene(index?): Promise<void>

• Index determines where the scene is added, it is only valid between 0 and len(song.scenes). Using an index of -1 will add the new scene at the end of the list.

  Memberof

  Song

  Parameters

  • index: number = -1

  Returns Promise<void>

deleteReturnTrack

• deleteReturnTrack(index): Promise<void>

• Delete the return track at the given index.

  Memberof

  Song

  Parameters

  • index: number

  Returns Promise<void>

deleteScene

• deleteScene(index): Promise<void>

• Delete the scene at the given index.

  Memberof

  Song

  Parameters

  • index: number

  Returns Promise<void>

deleteTrack

• deleteTrack(index): Promise<void>

• Delete the track at the given index.

  Memberof

  Song

  Parameters

  • index: number

  Returns Promise<void>

duplicateScene

• duplicateScene(index): Promise<void>

• Index determines which scene to duplicate.

  Memberof

  Song

  Parameters

  • index: number

  Returns Promise<void>

duplicateTrack

• duplicateTrack(index): Promise<void>

• Index determines which track to duplicate.

  Memberof

  Song

  Parameters

  • index: number

  Returns Promise<void>

findTrackByName

• findTrackByName(trackName): Promise<undefined | Track>

• Find a track by name

  Memberof

  Song

  Parameters

  • trackName: string

  Returns Promise<undefined | Track>

forceLinkBeatTime

• forceLinkBeatTime(): Promise<void>

• Force the Link timeline to jump to Live's current beat time.

  Memberof

  Song

  Returns Promise<void>

getAudioTracks

• getAudioTracks(): Promise<undefined | Track[]>

• Get all the audio tracks

  Memberof

  Song

  Returns Promise<undefined | Track[]>

getBeatsLoopLength

• getBeatsLoopLength(): Promise<void>

• The Arrangement loop length.

  Memberof

  Song

  Returns Promise<void>

  bars.beats.sixteenths.ticks

getBeatsLoopStart

• getBeatsLoopStart(): Promise<void>

• The Arrangement loop start.

  Memberof

  Song

  Returns Promise<void>

  bars.beats.sixteenths.ticks

getCurrentBeatsSongTime

• getCurrentBeatsSongTime(): Promise<void>

• The current Arrangement playback position.

  Memberof

  Song

  Returns Promise<void>

  bars.beats.sixteenths.ticks

getCurrentSmpteSongTime

• getCurrentSmpteSongTime(format): Promise<void>

• The current Arrangement playback position.

  Memberof

  Song

  Parameters

  • format: SMPTE

  Returns Promise<void>

  hours:min:sec:frames

getMidiTracks

• getMidiTracks(): Promise<undefined | Track[]>

• Get all the midi tracks

  Memberof

  Song

  Returns Promise<undefined | Track[]>

isCuePointSelected

• isCuePointSelected(): Promise<boolean>

• If the current Arrangement playback position is at a cue point

  Memberof

  Song

  Returns Promise<boolean>

jumpBy

• jumpBy(amount): Promise<void>

• Jump by

  Memberof

  Song

  Parameters

  • amount: number

    is the amount to jump relatively to the current position

  Returns Promise<void>

jumpToNextCue

• jumpToNextCue(): Promise<void>

• Jump to the right, if possible.

  Memberof

  Song

  Returns Promise<void>

jumpToPrevCue

• jumpToPrevCue(): Promise<void>

• Jump to the left, if possible.

  Memberof

  Song

  Returns Promise<void>

playScene

• playScene(scene): Promise<void>

• Start playing a specific scene

  Memberof

  Song

  Parameters

  • scene: number

  Returns Promise<void>

playSelection

• playSelection(): Promise<void>

• Do nothing if no selection is set in Arrangement, or play the current selection.

  Memberof

  Song

  Returns Promise<void>

reEnableAutomation

• reEnableAutomation(): Promise<void>

• Trigger 'Re-Enable Automation', re-activating automation in all running Session clips.

  Memberof

  Song

  Returns Promise<void>

redo

• redo(): Promise<void>

• Causes the Live application to redo the last operation.

  Memberof

  Song

  Returns Promise<void>

scrubBy

• scrubBy(amount): Promise<void>

• Same as jump_by , at the moment.

  Memberof

  Song

  Parameters

  • amount: number

    is the amount to scrub relatively to the current position

  Returns Promise<void>

setOrDeleteCue

• setOrDeleteCue(): Promise<void>

• Toggle cue point at current Arrangement playback position.

  Memberof

  Song

  Returns Promise<void>

startPlaying

• startPlaying(): Promise<void>

• Start playback from the insert marker.

  Memberof

  Song

  Returns Promise<void>

stopAllClips

• stopAllClips(quantized?): Promise<void>

• Calling the function with 0 will stop all clips immediately, independent of the launch quantization. The default is '1'.

  Memberof

  Song

  Parameters

  • quantized: boolean = true

  Returns Promise<void>

stopPlaying

• stopPlaying(): Promise<void>

• Stop the playback.

  Memberof

  Song

  Returns Promise<void>

tapTempo

• tapTempo(): Promise<void>

• Same as pressing the Tap Tempo button in the transport bar. The new tempo is calculated based on the time between subsequent calls of this function.

  Memberof

  Song

  Returns Promise<void>

triggerSessionRecord

• triggerSessionRecord(recordLength?): Promise<void>

• Starts recording in either the selected slot or the next empty slot, if the track is armed. If recordLength is provided, the slot will record for the given length in beats.

  If triggered while recording, recording will stop and clip playback will start.

  Memberof

  Song

  Parameters

  • Optional recordLength: number

  Returns Promise<void>

undo

• undo(): Promise<void>

• Causes the Live application to undo the last operation.

  Memberof

  Song

  Returns Promise<void>