module node liveosc Song.API

Class: Song

node-liveosc~ Song

new Song(liveosc)

Song object, represents the current state of the Ableton Live
set. Contains tracks, returns, and devices, as well as master
track properties.

Parameters:

Name	Type	Description
liveosc	Object	LiveOSC instance

Source:

• lib/song.js , lineno 19

Members

beat :Number

Current beat/play position

Type:

• Number

Source:

• lib/song.js , lineno 73

beat :Number

Current beat/play position

Type:

• Number

Source:

• lib/song.js , lineno 73

devices :Array

Current devices

Type:

• Array

Source:

• lib/song.js , lineno 49

devices :Array

Current devices

Type:

• Array

Source:

• lib/song.js , lineno 49

eventEmitter :EventEmitter

EventEmitter for song events

Type:

• EventEmitter

Source:

• lib/song.js , lineno 85

eventEmitter :EventEmitter

EventEmitter for song events

Type:

• EventEmitter

Source:

• lib/song.js , lineno 85

liveosc :Object

LiveOSC instance

Type:

• Object

Source:

• lib/song.js , lineno 25

liveosc :Object

LiveOSC instance

Type:

• Object

Source:

• lib/song.js , lineno 25

pan :Number

Master track panning

Type:

• Number

Source:

• lib/song.js , lineno 61

pan :Number

Master track panning

Type:

• Number

Source:

• lib/song.js , lineno 61

playing :Number

Transport play state, 1 = stopped, 2 = playing

Type:

• Number

Source:

• lib/song.js , lineno 79

playing :Number

Transport play state, 1 = stopped, 2 = playing

Type:

• Number

Source:

• lib/song.js , lineno 79

returns :Array

Current return tracks

Type:

• Array

Source:

• lib/song.js , lineno 43

returns :Array

Current return tracks

Type:

• Array

Source:

• lib/song.js , lineno 43

scene :Number

Currently selected scene

Type:

• Number

Source:

• lib/song.js , lineno 67

scene :Number

Currently selected scene

Type:

• Number

Source:

• lib/song.js , lineno 67

tempo :Number

Current tempo

Type:

• Number

Source:

• lib/song.js , lineno 31

tempo :Number

Current tempo

Type:

• Number

Source:

• lib/song.js , lineno 31

tracks :Array

Current tracks

Type:

• Array

Source:

• lib/song.js , lineno 37

tracks :Array

Current tracks

Type:

• Array

Source:

• lib/song.js , lineno 37

volume :Number

Master track volume

Type:

• Number

Source:

• lib/song.js , lineno 55

volume :Number

Master track volume

Type:

• Number

Source:

• lib/song.js , lineno 55

Methods

continue()

Trigger song continue play

Source:

• lib/song.js , lineno 301

continue()

Trigger song continue play

Source:

• lib/song.js , lineno 301

nextCue()

Move to next cue marker

Source:

• lib/song.js , lineno 308

nextCue()

Move to next cue marker

Source:

• lib/song.js , lineno 308

on(ev, cb)

Listen for a song event, current events are:

ready
play
beat
tempo
scene
volume
pan

Parameters:

Name	Type	Description
ev	String	event name
cb	function	callback

Source:

• lib/song.js , lineno 407

on(ev, cb)

Listen for a song event, current events are:

ready
play
beat
tempo
scene
volume
pan

Parameters:

Name	Type	Description
ev	String	event name
cb	function	callback

Source:

• lib/song.js , lineno 407

play()

Trigger song play

Source:

• lib/song.js , lineno 294

play()

Trigger song play

Source:

• lib/song.js , lineno 294

playScene(scene)

Trigger a scene play button

Parameters:

Name	Type	Description
scene	Number	scene number to play

Source:

• lib/song.js , lineno 344

playScene(scene)

Trigger a scene play button

Parameters:

Name	Type	Description
scene	Number	scene number to play

Source:

• lib/song.js , lineno 344

prevCue()

Move to previous cue marker

Source:

• lib/song.js , lineno 315

prevCue()

Move to previous cue marker

Source:

• lib/song.js , lineno 315

redo()

Trigger redo

Source:

• lib/song.js , lineno 329

redo()

Trigger redo

Source:

• lib/song.js , lineno 329

refresh()

Refresh the current song state
Recreates all tracks/returns/clips

Source:

• lib/song.js , lineno 252

refresh()

Refresh the current song state
Recreates all tracks/returns/clips

Source:

• lib/song.js , lineno 252

setPan(pan)

Sets the master track panning

Parameters:

Name	Type	Description
pan	Number	new panning

Source:

• lib/song.js , lineno 371

setPan(pan)

Sets the master track panning

Parameters:

Name	Type	Description
pan	Number	new panning

Source:

• lib/song.js , lineno 371

setTempo(tempo)

Sets the tempo

Parameters:

Name	Type	Description
tempo	Number	new tempo

Source:

• lib/song.js , lineno 384

setTempo(tempo)

Sets the tempo

Parameters:

Name	Type	Description
tempo	Number	new tempo

Source:

• lib/song.js , lineno 384

setVolume(volume)

Sets the master track volume

Parameters:

Name	Type	Description
volume	Number	new volume

Source:

• lib/song.js , lineno 358

setVolume(volume)

Sets the master track volume

Parameters:

Name	Type	Description
volume	Number	new volume

Source:

• lib/song.js , lineno 358

stop()

Trigger song stop

Source:

• lib/song.js , lineno 287

stop()

Trigger song stop

Source:

• lib/song.js , lineno 287

undo()

Trigger undo

Source:

• lib/song.js , lineno 322

undo()

Trigger undo

Source:

• lib/song.js , lineno 322

view()

Focus the master track

Source:

• lib/song.js , lineno 336

view()

Focus the master track

Source:

• lib/song.js , lineno 336

<inner> beatListener(new)

Respond to /live/beat
Called when a beat is reached in the song timeline

Parameters:

Name	Type	Description
new	Number	beat

Source:

• lib/song.js , lineno 107

<inner> beatListener(new)

Respond to /live/beat
Called when a beat is reached in the song timeline

Parameters:

Name	Type	Description
new	Number	beat

Source:

• lib/song.js , lineno 107

<inner> devicelistListener()

Respond to /live/master/devicelist
Called when device list is received

Source:

• lib/song.js , lineno 207

<inner> devicelistListener()

Respond to /live/master/devicelist
Called when device list is received

Source:

• lib/song.js , lineno 207

<inner> panListener(pan)

Respond to /live/master/pan
Called when master track panning changes

Parameters:

Name	Type	Description
pan	Number	new panning (-1.0 - 1.0)

Source:

• lib/song.js , lineno 159

<inner> panListener(pan)

Respond to /live/master/pan
Called when master track panning changes

Parameters:

Name	Type	Description
pan	Number	new panning (-1.0 - 1.0)

Source:

• lib/song.js , lineno 159

<inner> playListener(play)

Respond to /live/play
Called when the song starts or stops

Parameters:

Name	Type	Description
play	Number	state (1 = stopped, 2 = playing)

Source:

• lib/song.js , lineno 94

<inner> playListener(play)

Respond to /live/play
Called when the song starts or stops

Parameters:

Name	Type	Description
play	Number	state (1 = stopped, 2 = playing)

Source:

• lib/song.js , lineno 94

<inner> refreshListener()

Respond to:
/remix/oscserver/startup
/remix/oscserver/shutdown
/live/refresh
Refreshes the current song state

Source:

• lib/song.js , lineno 223

<inner> refreshListener()

Respond to:
/remix/oscserver/startup
/remix/oscserver/shutdown
/live/refresh
Refreshes the current song state

Source:

• lib/song.js , lineno 223

<inner> returnsListener(numTracks)

Respond to /live/returns
Called when number of returns is reported

Parameters:

Name	Type	Description
numTracks	Number	number of returns

Source:

• lib/song.js , lineno 185

<inner> returnsListener(numTracks)

Respond to /live/returns
Called when number of returns is reported

Parameters:

Name	Type	Description
numTracks	Number	number of returns

Source:

• lib/song.js , lineno 185

<inner> sceneListener(scene)

Respond to /live/scene
Called when scene changes

Parameters:

Name	Type	Description
scene	Number	new scene number

Source:

• lib/song.js , lineno 133

<inner> sceneListener(scene)

Respond to /live/scene
Called when scene changes

Parameters:

Name	Type	Description
scene	Number	new scene number

Source:

• lib/song.js , lineno 133

<inner> scenesListener(numScenes)

Respond to /live/scenes
Called when number of scenes is reported

Parameters:

Name	Type	Description
numScenes	Number	number of scenes

Source:

• lib/song.js , lineno 196

<inner> scenesListener(numScenes)

Respond to /live/scenes
Called when number of scenes is reported

Parameters:

Name	Type	Description
numScenes	Number	number of scenes

Source:

• lib/song.js , lineno 196

<inner> tempoListener(tempo)

Respond to /live/tempo
Called when tempo changes

Parameters:

Name	Type	Description
tempo	Number	new tempo

Source:

• lib/song.js , lineno 120

<inner> tempoListener(tempo)

Respond to /live/tempo
Called when tempo changes

Parameters:

Name	Type	Description
tempo	Number	new tempo

Source:

• lib/song.js , lineno 120

<inner> tracksListener(numTracks)

Repond to /live/tracks
Called when number of tracks is reported

Parameters:

Name	Type	Description
numTracks	Number	new number of tracks

Source:

• lib/song.js , lineno 172

<inner> tracksListener(numTracks)

Repond to /live/tracks
Called when number of tracks is reported

Parameters:

Name	Type	Description
numTracks	Number	new number of tracks

Source:

• lib/song.js , lineno 172

<inner> volumeListener(volume)

Respond to /live/master/volume
Called when master track volume changes

Parameters:

Name	Type	Description
volume	Number	new volume (0.0 - 1.0)

Source:

• lib/song.js , lineno 146

<inner> volumeListener(volume)

Respond to /live/master/volume
Called when master track volume changes

Parameters:

Name	Type	Description
volume	Number	new volume (0.0 - 1.0)

Source:

• lib/song.js , lineno 146

node-liveosc~ Song

new Song(liveosc)

Song object, represents the current state of the Ableton Live
set. Contains tracks, returns, and devices, as well as master
track properties.

Parameters:

Name	Type	Description
liveosc	Object	LiveOSC instance

Source:

• lib/song.js , lineno 19

Members

beat :Number

Current beat/play position

Type:

• Number

Source:

• lib/song.js , lineno 73

beat :Number

Current beat/play position

Type:

• Number

Source:

• lib/song.js , lineno 73

devices :Array

Current devices

Type:

• Array

Source:

• lib/song.js , lineno 49

devices :Array

Current devices

Type:

• Array

Source:

• lib/song.js , lineno 49

eventEmitter :EventEmitter

EventEmitter for song events

Type:

• EventEmitter

Source:

• lib/song.js , lineno 85

eventEmitter :EventEmitter

EventEmitter for song events

Type:

• EventEmitter

Source:

• lib/song.js , lineno 85

liveosc :Object

LiveOSC instance

Type:

• Object

Source:

• lib/song.js , lineno 25

liveosc :Object

LiveOSC instance

Type:

• Object

Source:

• lib/song.js , lineno 25

pan :Number

Master track panning

Type:

• Number

Source:

• lib/song.js , lineno 61

pan :Number

Master track panning

Type:

• Number

Source:

• lib/song.js , lineno 61

playing :Number

Transport play state, 1 = stopped, 2 = playing

Type:

• Number

Source:

• lib/song.js , lineno 79

playing :Number

Transport play state, 1 = stopped, 2 = playing

Type:

• Number

Source:

• lib/song.js , lineno 79

returns :Array

Current return tracks

Type:

• Array

Source:

• lib/song.js , lineno 43

returns :Array

Current return tracks

Type:

• Array

Source:

• lib/song.js , lineno 43

scene :Number

Currently selected scene

Type:

• Number

Source:

• lib/song.js , lineno 67

scene :Number

Currently selected scene

Type:

• Number

Source:

• lib/song.js , lineno 67

tempo :Number

Current tempo

Type:

• Number

Source:

• lib/song.js , lineno 31

tempo :Number

Current tempo

Type:

• Number

Source:

• lib/song.js , lineno 31

tracks :Array

Current tracks

Type:

• Array

Source:

• lib/song.js , lineno 37

tracks :Array

Current tracks

Type:

• Array

Source:

• lib/song.js , lineno 37

volume :Number

Master track volume

Type:

• Number

Source:

• lib/song.js , lineno 55

volume :Number

Master track volume

Type:

• Number

Source:

• lib/song.js , lineno 55

Methods

continue()

Trigger song continue play

Source:

• lib/song.js , lineno 301

continue()

Trigger song continue play

Source:

• lib/song.js , lineno 301

nextCue()

Move to next cue marker

Source:

• lib/song.js , lineno 308

nextCue()

Move to next cue marker

Source:

• lib/song.js , lineno 308

on(ev, cb)

Listen for a song event, current events are:

ready
play
beat
tempo
scene
volume
pan

Parameters:

Name	Type	Description
ev	String	event name
cb	function	callback

Source:

• lib/song.js , lineno 407

on(ev, cb)

Listen for a song event, current events are:

ready
play
beat
tempo
scene
volume
pan

Parameters:

Name	Type	Description
ev	String	event name
cb	function	callback

Source:

• lib/song.js , lineno 407

play()

Trigger song play

Source:

• lib/song.js , lineno 294

play()

Trigger song play

Source:

• lib/song.js , lineno 294

playScene(scene)

Trigger a scene play button

Parameters:

Name	Type	Description
scene	Number	scene number to play

Source:

• lib/song.js , lineno 344

playScene(scene)

Trigger a scene play button

Parameters:

Name	Type	Description
scene	Number	scene number to play

Source:

• lib/song.js , lineno 344

prevCue()

Move to previous cue marker

Source:

• lib/song.js , lineno 315

prevCue()

Move to previous cue marker

Source:

• lib/song.js , lineno 315

redo()

Trigger redo

Source:

• lib/song.js , lineno 329

redo()

Trigger redo

Source:

• lib/song.js , lineno 329

refresh()

Refresh the current song state
Recreates all tracks/returns/clips

Source:

• lib/song.js , lineno 252

refresh()

Refresh the current song state
Recreates all tracks/returns/clips

Source:

• lib/song.js , lineno 252

setPan(pan)

Sets the master track panning

Parameters:

Name	Type	Description
pan	Number	new panning

Source:

• lib/song.js , lineno 371

setPan(pan)

Sets the master track panning

Parameters:

Name	Type	Description
pan	Number	new panning

Source:

• lib/song.js , lineno 371

setTempo(tempo)

Sets the tempo

Parameters:

Name	Type	Description
tempo	Number	new tempo

Source:

• lib/song.js , lineno 384

setTempo(tempo)

Sets the tempo

Parameters:

Name	Type	Description
tempo	Number	new tempo

Source:

• lib/song.js , lineno 384

setVolume(volume)

Sets the master track volume

Parameters:

Name	Type	Description
volume	Number	new volume

Source:

• lib/song.js , lineno 358

setVolume(volume)

Sets the master track volume

Parameters:

Name	Type	Description
volume	Number	new volume

Source:

• lib/song.js , lineno 358

stop()

Trigger song stop

Source:

• lib/song.js , lineno 287

stop()

Trigger song stop

Source:

• lib/song.js , lineno 287

undo()

Trigger undo

Source:

• lib/song.js , lineno 322

undo()

Trigger undo

Source:

• lib/song.js , lineno 322

view()

Focus the master track

Source:

• lib/song.js , lineno 336

view()

Focus the master track

Source:

• lib/song.js , lineno 336

<inner> beatListener(new)

Respond to /live/beat
Called when a beat is reached in the song timeline

Parameters:

Name	Type	Description
new	Number	beat

Source:

• lib/song.js , lineno 107

<inner> beatListener(new)

Respond to /live/beat
Called when a beat is reached in the song timeline

Parameters:

Name	Type	Description
new	Number	beat

Source:

• lib/song.js , lineno 107

<inner> devicelistListener()

Respond to /live/master/devicelist
Called when device list is received

Source:

• lib/song.js , lineno 207

<inner> devicelistListener()

Respond to /live/master/devicelist
Called when device list is received

Source:

• lib/song.js , lineno 207

<inner> panListener(pan)

Respond to /live/master/pan
Called when master track panning changes

Parameters:

Name	Type	Description
pan	Number	new panning (-1.0 - 1.0)

Source:

• lib/song.js , lineno 159

<inner> panListener(pan)

Respond to /live/master/pan
Called when master track panning changes

Parameters:

Name	Type	Description
pan	Number	new panning (-1.0 - 1.0)

Source:

• lib/song.js , lineno 159

<inner> playListener(play)

Respond to /live/play
Called when the song starts or stops

Parameters:

Name	Type	Description
play	Number	state (1 = stopped, 2 = playing)

Source:

• lib/song.js , lineno 94

<inner> playListener(play)

Respond to /live/play
Called when the song starts or stops

Parameters:

Name	Type	Description
play	Number	state (1 = stopped, 2 = playing)

Source:

• lib/song.js , lineno 94

<inner> refreshListener()

Respond to:
/remix/oscserver/startup
/remix/oscserver/shutdown
/live/refresh
Refreshes the current song state

Source:

• lib/song.js , lineno 223

<inner> refreshListener()

Respond to:
/remix/oscserver/startup
/remix/oscserver/shutdown
/live/refresh
Refreshes the current song state

Source:

• lib/song.js , lineno 223

<inner> returnsListener(numTracks)

Respond to /live/returns
Called when number of returns is reported

Parameters:

Name	Type	Description
numTracks	Number	number of returns

Source:

• lib/song.js , lineno 185

<inner> returnsListener(numTracks)

Respond to /live/returns
Called when number of returns is reported

Parameters:

Name	Type	Description
numTracks	Number	number of returns

Source:

• lib/song.js , lineno 185

<inner> sceneListener(scene)

Respond to /live/scene
Called when scene changes

Parameters:

Name	Type	Description
scene	Number	new scene number

Source:

• lib/song.js , lineno 133

<inner> sceneListener(scene)

Respond to /live/scene
Called when scene changes

Parameters:

Name	Type	Description
scene	Number	new scene number

Source:

• lib/song.js , lineno 133

<inner> scenesListener(numScenes)

Respond to /live/scenes
Called when number of scenes is reported

Parameters:

Name	Type	Description
numScenes	Number	number of scenes

Source:

• lib/song.js , lineno 196

<inner> scenesListener(numScenes)

Respond to /live/scenes
Called when number of scenes is reported

Parameters:

Name	Type	Description
numScenes	Number	number of scenes

Source:

• lib/song.js , lineno 196

<inner> tempoListener(tempo)

Respond to /live/tempo
Called when tempo changes

Parameters:

Name	Type	Description
tempo	Number	new tempo

Source:

• lib/song.js , lineno 120

<inner> tempoListener(tempo)

Respond to /live/tempo
Called when tempo changes

Parameters:

Name	Type	Description
tempo	Number	new tempo

Source:

• lib/song.js , lineno 120

<inner> tracksListener(numTracks)

Repond to /live/tracks
Called when number of tracks is reported

Parameters:

Name	Type	Description
numTracks	Number	new number of tracks

Source:

• lib/song.js , lineno 172

<inner> tracksListener(numTracks)

Repond to /live/tracks
Called when number of tracks is reported

Parameters:

Name	Type	Description
numTracks	Number	new number of tracks

Source:

• lib/song.js , lineno 172

<inner> volumeListener(volume)

Respond to /live/master/volume
Called when master track volume changes

Parameters:

Name	Type	Description
volume	Number	new volume (0.0 - 1.0)

Source:

• lib/song.js , lineno 146

<inner> volumeListener(volume)

Respond to /live/master/volume
Called when master track volume changes

Parameters:

Name	Type	Description
volume	Number	new volume (0.0 - 1.0)

Source:

• lib/song.js , lineno 146

Generated with wicked.