Skip to content

module node liveosc Track.API

Tom edited this page Jul 17, 2014 · 6 revisions

Class: Track

node-liveosc~ Track

new Track(liveosc, id)

Track object, represents an audio or midi track in the Ableton Live set.

Parameters:
Name Type Description
liveosc Object

LiveOSC instance

id Number

id of the track

Source:

Members

arm :Number

Track armed (audio only)

Type:
  • Number
Source:

audio :Number

0 = MIDI track, 1 = Audio track

Type:
  • Number
Source:

clips :Array

Clips in this track

Type:
  • Array
Source:

devices :Array

Devices in this track

Type:
  • Array
Source:

eventEmitter :EventEmitter

EventEmitter for track events

Type:
  • EventEmitter
Source:

id :Number

The id of this track

Type:
  • Number
Source:

liveosc :Object

Instance of LiveOSC

Type:
  • Object
Source:

mute :Number

Track muted

Type:
  • Number
Source:

name :String

The name of this track

Type:
  • String
Source:

numScenes :Number

Number of scenes in the track

Type:
  • Number
Source:

pan :Number

Track panning

Type:
  • Number
Source:

sends :Array

Track send levels ex [{id: 0, value: 1.0}]

Type:
  • Array
Source:

solo :Number

Track soloed

Type:
  • Number
Source:

volume :Number

Track volume

Type:
  • Number
Source:

Methods

destroy()

Called when a track is refreshed or destroyed

Source:

emitEvent(ev, params)

Emit a track event

Parameters:
Name Type Description
ev String

event name

params Object

event parameters

Source:

on(ev, cb)

Listen for a track event, current events are:

send solo arm mute volume pan name destroy

Parameters:
Name Type Description
ev String

event name

cb function

callback

Source:

refreshClips()

Refresh the state of all clips in the track

Source:

setArm(arm)

Set the track arm state

Parameters:
Name Type Description
arm Number

0 or 1

Source:

setMute(mute)

Set the track mute state

Parameters:
Name Type Description
mute Number

0 or 1

Source:

setName(name)

Set the name of the track

Parameters:
Name Type Description
name String

the new track name

Source:

setNumScenes(numScenes)

Set number of scenes in the track Called by Song

Parameters:
Name Type Description
numScenes Number

number of scenes in the track

Source:

setPan(pan)

Set the track panning

Parameters:
Name Type Description
pan Number

1.0 - 1.0

Source:

setSend(send, val)

Set track send level

Parameters:
Name Type Description
send Number

send id

val Number

new send level (0.0 - 1.0)

Source:

setSolo(solo)

Set the track solo state

Parameters:
Name Type Description
solo Number

0 or 1

Source:

setVolume(volume)

Set the track volume

Parameters:
Name Type Description
volume Number

0.0 - 1.0

Source:

view()

Focus the track

Source:

<inner> armListener(trackId, arm)

Listen for /live/arm

Parameters:
Name Type Description
trackId Number

the id of the track

arm Number

0 or 1

Source:

<inner> devicelistListener()

Listen for /live/devicelist

Source:

<inner> muteListener(trackId, mute)

Listen for /live/mute

Parameters:
Name Type Description
trackId Number

the id of the track

mute Number

0 or 1

Source:

<inner> nameListener(trackId, name)

Listen for /live/name/track This is called when clips/devices are added or removed

Parameters:
Name Type Description
trackId Number

the id of the track

name String

track name

Source:

<inner> panListener(trackId, pan)

Listen for /live/pan

Parameters:
Name Type Description
trackId Number

the id of the track

pan Number

new track panning

Source:

<inner> sendListener()

Listen for /live/send

Source:

<inner> soloListener(trackId, solo)

Listen for /live/solo

Parameters:
Name Type Description
trackId Number

the id of the track

solo Number

0 or 1

Source:

<inner> trackinfoListener(trackId, arm, solo, mute, audio, volume, pan)

Listen for /live/track/info

Parameters:
Name Type Description
trackId Number

the id of the track

arm Number

0 or 1

solo Number

0 or 1

mute Number

0 or 1

audio Number

0 = midi, 1 = audio

volume Number

current track volume

pan Number

current track panning

Source:

<inner> volumeListener(trackId, volume)

Listen for /live/volume

Parameters:
Name Type Description
trackId Number

the id of the track

volume Number

new track volume

Source:

Generated with wicked.

Clone this wiki locally