module node liveosc Device.API

Class: Device

node-liveosc~ Device

new Device(liveosc, id, track, type, name)

Device object, represents a device in the Ableton Live set.

Parameters:

Name	Type	Description
liveosc	Object	LiveOSC instance
id	Number	id of the device
track	Object	track the device belongs to
type	String	type of device's track ('track', 'return', 'master')
name	String	name of the device

Source:

• lib/device.js , lineno 18

Members

eventEmitter :EventEmitter

EventEmitter for device events

Type:

• EventEmitter

Source:

• lib/device.js , lineno 74

id :Number

The id of this device

Type:

• Number

Source:

• lib/device.js , lineno 36

liveosc :Object

Instance of LiveOSC

Type:

• Object

Source:

• lib/device.js , lineno 24

name :String

The name of this device

Type:

• String

Source:

• lib/device.js , lineno 30

params :Array

The parameter values of a device, format of a parameter is:

{ id: 0, value: 1, name: 'Device On', min: 0, max: 1 }

Type:

• Array

Source:

• lib/device.js , lineno 68

track :Object

The track this device belongs to

Type:

• Object

Source:

• lib/device.js , lineno 42

type :String

The type of track the device is on, valid types are:

master track return

Type:

• String

Source:

• lib/device.js , lineno 53

Methods

destroy()

Called when a device is refreshed or destroyed

Source:

• lib/device.js , lineno 197

emitEvent(ev, params)

Emit a device event

Parameters:

Name	Type	Description
ev	String	event name
params	Object	event parameters

Source:

• lib/device.js , lineno 275

on(ev, cb)

Listen for a device event, current events are:

param fired on any parameter change listen for a specific parameter destroy

Parameters:

Name	Type	Description
ev	String	event name
cb	function	callback

Source:

• lib/device.js , lineno 266

set(param, value)

Set a device parameter to a value

Parameters:

Name	Type	Description
param	Mixed	id of the parameter or name of the parameter
value	Number	new parameter value

Source:

• lib/device.js , lineno 211

view()

Focus this device

Source:

• lib/device.js , lineno 242

<inner> allParamListener()

Listen for /live/device/allparam

Source:

• lib/device.js , lineno 117

<inner> paramListener()

Listen for /live/device/param

Source:

• lib/device.js , lineno 150

<inner> rangeListener()

Listen for /live/device/range

Source:

• lib/device.js , lineno 96

Generated with wicked.