module node liveosc Return.API

Class: Return

node-liveosc~ Return

new Return(liveosc, id)

Return object, represents a return track in the Ableton Live set.

Parameters:

Name	Type	Description
liveosc	Object	LiveOSC instance
id	Number	id of the return

Source:

• lib/return.js , lineno 16

Members

devices :Array

Devices in this return

Type:

• Array

Source:

• lib/return.js , lineno 64

eventEmitter :EventEmitter

EventEmitter for return events

Type:

• EventEmitter

Source:

• lib/return.js , lineno 77

id :Number

The id of this return

Type:

• Number

Source:

• lib/return.js , lineno 34

liveosc :Object

Instance of LiveOSC

Type:

• Object

Source:

• lib/return.js , lineno 22

mute :Number

Return muted

Type:

• Number

Source:

• lib/return.js , lineno 46

name :String

Name of the return

Type:

• String

Source:

• lib/return.js , lineno 28

pan :Number

Return panning

Type:

• Number

Source:

• lib/return.js , lineno 58

sends :Array

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

Type:

• Array

Source:

• lib/return.js , lineno 71

solo :Number

Return soloed

Type:

• Number

Source:

• lib/return.js , lineno 40

volume :Number

Return volume

Type:

• Number

Source:

• lib/return.js , lineno 52

Methods

destroy()

Called when a return is refreshed or destroyed

Source:

• lib/return.js , lineno 238

emitEvent(ev, params)

Emit a return event

Parameters:

Name	Type	Description
ev	String	event name
params	Object	event parameters

Source:

• lib/return.js , lineno 410

on(ev, cb)

Listen for a return event, current events are:

send solo mute volume pan name destroy

Parameters:

Name	Type	Description
ev	String	event name
cb	function	callback

Source:

• lib/return.js , lineno 401

setMute(mute)

Set the return mute state

Parameters:

Name	Type	Description
mute	Number	0 or 1

Source:

• lib/return.js , lineno 301

setName(name)

Set the name of the return

Parameters:

Name	Type	Description
name	String	the new track name

Source:

• lib/return.js , lineno 264

setPan(pan)

Set the return panning

Parameters:

Name	Type	Description
pan	Number	1.0 - 1.0

Source:

• lib/return.js , lineno 337

setSend(send, val)

Set return send level

Parameters:

Name	Type	Description
send	Number	send id
val	Number	new send level (0.0 - 1.0)

Source:

• lib/return.js , lineno 356

setSolo(solo)

Set the return solo state

Parameters:

Name	Type	Description
solo	Number	0 or 1

Source:

• lib/return.js , lineno 283

setVolume(volume)

Set the return volume

Parameters:

Name	Type	Description
volume	Number	0.0 - 1.0

Source:

• lib/return.js , lineno 319

view()

Focus the return

Source:

• lib/return.js , lineno 377

<inner> devicelistListener()

Listen for /live/return/devicelist

Source:

• lib/return.js , lineno 192

<inner> infoListener(trackId, solo, mute, volume, pan)

Listen for /live/return/info

Parameters:

Name	Type	Description
trackId	Number	the id of the return
solo	Number	0 or 1
mute	Number	0 or 1
volume	Number	current return volume
pan	Number	current return panning

Source:

• lib/return.js , lineno 165

<inner> muteListener(trackId, mute)

Listen for /live/return/mute

Parameters:

Name	Type	Description
trackId	Number	the id of the return
mute	Number	0 or 1

Source:

• lib/return.js , lineno 120

<inner> nameListener(trackId, name)

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

Parameters:

Name	Type	Description
trackId	Number	the id of the return
name	String	the name of the return

Source:

• lib/return.js , lineno 209

<inner> panListener(trackId, pan)

Listen for /live/return/pan

Parameters:

Name	Type	Description
trackId	Number	the id of the return
pan	Number	new return panning

Source:

• lib/return.js , lineno 148

<inner> sendListener()

Listen for /live/return/send

Source:

• lib/return.js , lineno 84

<inner> soloListener(trackId, solo)

Listen for /live/return/solo

Parameters:

Name	Type	Description
trackId	Number	the id of the return
solo	Number	0 or 1

Source:

• lib/return.js , lineno 106

<inner> volumeListener(trackId, volume)

Listen for /live/return/volume

Parameters:

Name	Type	Description
trackId	Number	the id of the return
volume	Number	new return volume

Source:

• lib/return.js , lineno 134

Generated with wicked.