module node liveosc Clip.API

Class: Clip

node-liveosc~ Clip

new Clip(liveosc, track, id)

Clip object, represents a clip in the Ableton Live set.

Parameters:

Name	Type	Description
liveosc	Object	LiveOSC instance
track	Object	Track this Clip belongs to
id	Number	id of the clip

Source:

• lib/clip.js , lineno 16

Members

coarse :Number

The coarse pitch of the clip (audio clips only)

Type:

• Number

Source:

• lib/clip.js , lineno 58

eventEmitter :EventEmitter

EventEmitter for clip events

Type:

• EventEmitter

Source:

• lib/clip.js , lineno 108

fine :Number

The fine pitch of the clip (audio clips only)

Type:

• Number

Source:

• lib/clip.js , lineno 64

id :Number

The id of this clip

Type:

• Number

Source:

• lib/clip.js , lineno 34

length :Number

The length of the clip in beats

Type:

• Number

Source:

• lib/clip.js , lineno 102

liveosc :Object

Instance of LiveOSC

Type:

• Object

Source:

• lib/clip.js , lineno 22

loopend :Number

The loop end position of the clip in beats

Type:

• Number

Source:

• lib/clip.js , lineno 76

loopstart :Number

The loop start position of the clip in beats

Type:

• Number

Source:

• lib/clip.js , lineno 70

loopstate :Number

The loop enabled state of the clip

Type:

• Number

Source:

• lib/clip.js , lineno 82

name :String

The name of this clip

Type:

• String

Source:

• lib/clip.js , lineno 40

state :Number

The playing state of this clip

0 = empty (no clip) 1 = stopped 2 = playing 3 = triggered

Type:

• Number

Source:

• lib/clip.js , lineno 52

track :Object

The track this clip belongs to

Type:

• Object

Source:

• lib/clip.js , lineno 28

warping :Number

The warping mode of the clip

0 = Beats 1 = Tones 2 = Texture 3 = Repitch 4 = Complex 5 = Complex Pro

Type:

• Number

Source:

• lib/clip.js , lineno 96

Methods

destroy()

Called when a clip is refreshed or destroyed

Source:

• lib/clip.js , lineno 254

emitEvent(ev, params)

Emit a clip event

Parameters:

Name	Type	Description
ev	String	event name
params	Object	event parameters

Source:

• lib/clip.js , lineno 505

on(ev, cb)

Listen for a clip event, current events are:

state loopstart loopend loopstate warping coarse fine name destroy

Parameters:

Name	Type	Description
ev	string	event name
cb	function	callback

Source:

• lib/clip.js , lineno 496

play()

Trigger the clip to start playing

Source:

• lib/clip.js , lineno 288

refresh()

Refresh the state of the clip

Source:

• lib/clip.js , lineno 270

setLoopend(loopend)

Sets the loop end position of the clip in beats

Parameters:

Name	Type	Description
loopend	Number	the loop end position in beats

Source:

• lib/clip.js , lineno 397

setLoopstart(loopstart)

Sets the loop start position of the clip in beats

Parameters:

Name	Type	Description
loopstart	Number	the loop start position in beats

Source:

• lib/clip.js , lineno 375

setLoopstate(loopstate)

Enable or disable looping of the clip

Parameters:

Name	Type	Description
loopstate	Number	0 to disable, 1 to enable

Source:

• lib/clip.js , lineno 419

setName(name)

Set the name of the clip

Parameters:

Name	Type	Description
name	String	the new clip name

Source:

• lib/clip.js , lineno 323

setPitch(coarse, fine)

Set the pitch of the clip (audio only)

Parameters:

Name	Type	Description
coarse	Number	the coarse pitch of the clip
fine	Number	the fine pitch of the clip

Source:

• lib/clip.js , lineno 346

setWarping(warping)

Set the warping mode of the clip

0 = Beats 1 = Tones 2 = Texture 3 = Repitch 4 = Complex 5 = Complex Pro

Parameters:

Name	Type	Description
warping	Number	the new warping mode

Source:

• lib/clip.js , lineno 449

stop()

Trigger the clip to stop playing

Source:

• lib/clip.js , lineno 305

view()

Focus the clip

Source:

• lib/clip.js , lineno 470

<inner> clipinfoListener(trackId, clipId, state, length)

Listen for /live/clip/info

Parameters:

Name	Type	Description
trackId	Number	the id of the track
clipId	Number	the id of the clip
state	Number	the new playing state of the clip
length	Number	the new length of the clip

Source:

• lib/clip.js , lineno 205

<inner> clipnameListener(trackId, clipId, name)

Listen for /live/clip/name

Parameters:

Name	Type	Description
trackId	Number	the id of the track
clipId	Number	the id of the clip
name	String	the new name of the track

Source:

• lib/clip.js , lineno 228

<inner> loopendListener(trackId, clipId, loopend)

Listen for /live/clip/loopend

Parameters:

Name	Type	Description
trackId	Number	the id of the track
clipId	Number	the id of the clip
loopend	Number	the new loopend position

Source:

• lib/clip.js , lineno 134

<inner> loopstartListener(trackId, clipId, loopstart)

Listen for /live/clip/loopstart

Parameters:

Name	Type	Description
trackId	Number	the id of the track
clipId	Number	the id of the clip
loopstart	Number	the new loopstart position

Source:

• lib/clip.js , lineno 118

<inner> loopstateListener(trackId, clipId, loopstate)

Listen for /live/clip/loopstate

Parameters:

Name	Type	Description
trackId	Number	the id of the track
clipId	Number	the id of the clip
loopstate	Number	the new loop state

Source:

• lib/clip.js , lineno 150

<inner> pitchListener(trackId, clipId, coarse, fine)

Listen for /live/pitch

Parameters:

Name	Type	Description
trackId	Number	the id of the track
clipId	Number	the id of the clip
coarse	Number	the new coarse pitch
fine	Number	the new fine pitch

Source:

• lib/clip.js , lineno 183

<inner> warpingListener(trackId, clipId, warping)

Listen for /live/clip/warping

Parameters:

Name	Type	Description
trackId	Number	the id of the track
clipId	Number	the id of the clip
warping	Number	the new warping state

Source:

• lib/clip.js , lineno 166

Generated with wicked.