source: trunk/LiveOSC/OSCAPI.txt @ 68

Revision 68, 18.1 KB checked in by st8, 2 years ago (diff)

LiveControl: Added Clip sequencer application, doubled resolution of device control. LiveOSC: Added toggles for meter/clip listeners, added transport listener

Line 
1CALLS
2=====
3
4/live/tempo                                                             Request current tempo, replies with /live/tempo (float tempo)
5/live/tempo             (float tempo)                                   Set the tempo, replies with /live/tempo (float tempo)
6/live/time                                                              Request current song time, replies with /live/time (float time)
7/live/time              (float time)                                    Set the time , replies with /live/time (float time)
8/live/overdub           (int on/off)                                    Enables/disables overdub
9/live/state                                                             Returns the current tempo and overdub status
10/live/undo                                                              Requests the song to undo the last action
11/live/redo                                                              Requests the song to redo the last action
12
13/live/next/cue                                                          Jumps to the next cue point
14/live/prev/cue                                                          Jumps to the previous cue point
15/live/play                                                              Starts the song playing
16/live/play/continue                                                     Continues playing the song from the current point
17/live/play/selection                                                    Plays the current selection
18/live/play/clip         (int track, int clip)                           Launches clip number clip in track number track
19/live/play/clipslot     (int track, int clip)                           Launches clip number clip in track number track even if a clip isnt present in the slot (ie stops the slot)
20/live/play/scene        (int scene)                                     Launches scene number scene
21/live/stop                                                              Stops playing the song
22/live/stop/clip         (int track, int clip)                           Stops clip number clip in track number track
23/live/stop/track        (int track)                                     Stops track number track
24
25/live/scenes            blank or ('query')                              Returns the total number of scenes in the form /live/scenes (int)
26/live/tracks            blank or ('query')                              Returns the total number of tracks in the form /live/tracks (int)
27
28/live/scene                                                             Returns the currently selected scene index
29/live/scene             (int scene)                                     Selects the scene with index scene
30
31/live/name/scene        blank or ('query')                              Returns a a series of all the scene names in the form /live/name/scene (int scene, string name)
32/live/name/scene        (int scene)                                     Returns a single scene's name in the form /live/name/scene (int scene, string name)
33/live/name/scene        (int scene, string name)                        Sets scene number scene's name to name
34/live/name/sceneblock   (int track, int size)                           Returns a series of scene name starting at (int scene) of length (int size)
35
36/live/name/track                                                        Returns a a series of all the track names in the form /live/name/track (int track, string name, int color)
37/live/name/track        (int track)                                     Returns a single track's name in the form /live/name/track (int track, string name, int color)
38/live/name/track        (int track, string name)                        Sets track number track's name to name
39/live/name/trackblock   (int track, int size)                           Returns a series of track name starting at (int track) of length (int size)
40
41/live/name/clip                                                         Returns a a series of all the clip names in the form /live/name/clip (int track, int clip, string name)
42/live/name/clip         (int track, int clip)                           Returns a single clip's name in the form /live/name/clip (int clip, string name)
43/live/name/clip         (int track, int clip, string name)              Sets clip number clip in track number track's name to name
44/live/name/clipblock    (int track, int clip, int sizeX, int sizeY)     Returns a series of clip names in a area starting at (int track, int clip) of size (sizeX, sizeY)
45
46/live/arm               (int track)                                     Get arm status for track number track
47/live/arm               (int track, int armed/disarmed)                 Arms/disamrs track number track
48/live/mute              (int track)                                     Get mute status for track number track
49/live/mute              (int track, int mute/unmute)                    Mutes/unmutes track number track
50/live/solo              (int track)                                     Get solo status for track number track
51/live/solo              (int track, int solo/unsolo)                    Solos/unsolos track number track
52/live/volume            (int track)                                     Returns the current volume of track number track as: /live/volume (int track, float volume(0.0 to 1.0))
53/live/volume            (int track, float volume(0.0 to 1.0))           Sets track number track's volume to volume
54/live/pan               (int track)                                     Returns the pan of track number track as: /live/pan (int track, float pan(-1.0 to 1.0))
55/live/pan               (int track, float pan(-1.0 to 1.0))             Sets track number track's pan to pan
56/live/send              (int track)                                     Returns a list of all sends and values on track number track as: /live/send (int track, int send, float level, int send, ...)
57/live/send              (int track, int send)                           Returns the send level of send (send) on track number track as: /live/send (int track, int send, float level(0.0 to 1.0))
58/live/send              (int track, int send, float level(0.0 to 1.0))  Sets the send (send) of track number (track)'s level to (level)
59/live/pitch             (int track, int clip)                           Returns the pan of track number track as: /live/pan (int track, int clip, int coarse(-48 to 48), int fine (-50 to 50))
60/live/pitch             (int track, int clip, int coarse(-48 to 48),
61                        int fine (-50 to 50))                           Sets clip number clip in track number track's pitch to coarse / fine
62
63/live/return/mute       (int track)                                     Get mute status for return track number track
64/live/return/mute       (int track, int mute/unmute)                    Mutes/unmutes return track number track
65/live/return/solo       (int track)                                     Get solo status for return track number track
66/live/return/solo       (int track, int solo/unsolo)                    Solos/unsolos return track number track
67/live/return/volume     (int track)                                     Returns the current volume of return track number track as: /live/volume (int track, float volume(0.0 to 1.0))
68/live/return/volume     (int track, float volume(0.0 to 1.0))           Sets return track number track's volume to volume
69/live/return/pan        (int track)                                     Returns the pan of return track number track as: /live/pan (int track, float pan(-1.0 to 1.0))
70/live/return/pan        (int track, float pan(-1.0 to 1.0))             Sets return track number track's pan to pan
71/live/return/send       (int track)                                     Returns a list of all sends and values on return track number track as: /live/send (int track, int send, float level, int send, ...)
72/live/return/send       (int track, int send)                           Returns the send level of send (send) on return track number track as: /live/send (int track, int send, float level(0.0 to 1.0))
73/live/return/send       (int track, int send, float level(0.0 to 1.0))  Sets the send (send) of return track number (track)'s level to (level)
74
75/live/master/volume     (int track)                                     Returns the current volume of the master track as: /live/master/volume float volume(0.0 to 1.0)
76/live/master/volume     (int track, float volume(0.0 to 1.0))           Sets the master track's volume to volume
77/live/master/pan        (int track)                                     Returns the pan of the master track as: /live/master/pan (int track, float pan(-1.0 to 1.0))
78/live/master/pan        (int track, float pan(-1.0 to 1.0))             Sets master track's pan to pan
79
80/live/track/jump        (int track, float beats)                        Jumps in track's currently running session clip by beats
81/live/track/info        (int track)                                     Returns clip slot status' for all clips in a track in the form /live/track/info (tracknumber, armed  (clipnumber, state, length))
82                                                                        [state: 0 = no clip, 1 = has clip, 2 = playing, 3 = triggered]
83/live/track/view        (int track)                                     Selects a track to view
84/live/return/view       (int track)                                     Selects a return track to view
85/live/master/view                                                       Selects the master track
86
87/live/track/device/view (int track, int device)                         Selects device on track to view
88/live/return/device/view (int track, int device)                        Selects device on return track to view
89/live/master/device/view (int device)                                   Selects device on the master track
90
91/live/clip/view         (int track, int clip)                           Selects a clip on track to view
92
93/live/detail/view       (int)                                           Switches detail view [0 = clip, 1 = track]
94
95/live/clip/info         (int track, int clip)                           Gets the status of a single clip in the form  /live/clip/info (tracknumber, clipnumber, state)
96                                                                        [state: 0 = no clip, 1 = has clip, 2 = playing, 3 = triggered]
97
98/live/devicelist        (int track)                                     Returns a list of all devices and names on track number track as: /live/device (int track, int device, str name, ...)
99/live/device            (int track, int device)                         Returns a list of all parameter values and names on device on track number track
100                                                                        as: /live/deviceall/param (int track, int device, int parameter int value,  str name, ...)
101/live/device            (int track, int device, int parameter)          Returns the name and value of parameter on device on track as: /live/device/param (int track, int device, int paarmeter, int value, str name)
102/live/device            (int track, int device, int parameter,          Sets parameter on device on track number track to value
103                        int value)
104
105/live/device/range      (int track, int device)                         Returns the min and max value of all parameters of device on track in the format /live/device/range (int track, int device, int/float min, int/float max, ...)
106/live/device/range      (int track, int device, int parameter)          Returns the min and max value of parameter of device on track in the format /live/device/range (int track, int device, int/float min, int/float max)
107
108/live/return/devicelist (int track)                                     Returns a list of all devices and names on track number track as: /live/device (int track, int device, str name, ...)
109/live/return/device     (int track, int device)                         Returns a list of all parameter values and names on device on track number track
110                                                                        as: /live/device/allparm (int track, int device, int parameter int value,  str name, ...)
111/live/return/device     (int track, int device, int parameter)          Returns the name and value of parameter on device on track as: /live/device/param (int track, int device, int parameter, int value)
112/live/return/device     (int track, int device, int parameter,          Sets parameter on device on track number track to value
113                        int value)
114
115/live/return/device/range (int track, int device)                       Returns the min and max value of all parameters of device on return track in the format /live/return/device/range (int track, int device, int/float min, int/float max, ...)
116/live/return/device/range (int track, int device, int parameter)        Returns the min and max value of parameter of device on return track in the format /live/return/device/range (int track, int device, int/float min, int/float max)                       
117
118/live/master/devicelist                                                 Returns a list of all devices and names on the master track as: /live/device (int device, str name, ...)
119/live/master/device     (int device)                                    Returns a list of all parameter values and names on device on the master track
120                                                                        as: /live/device (int device, int parameter int value,  str name, ...)
121/live/master/device     (int device, int parameter)                     Returns the name and value of parameter on device on the master track as: /live/device (int device, int parameter, int value)
122/live/master/device     (int device, int parameter, int value)          Sets parameter on device on track number track to value
123
124/live/return/device/range (int device)                                  Returns the min and max value of all parameters of device on the master track in the format /live/master/device/range (int device, int/float min, int/float max, ...)
125/live/return/device/range (int device, int parameter)                   Returns the min and max value of parameter of device on the master track in the format /live/master/device/range (int device, int/float min, int/float max)         
126
127/live/clip/loopstart    (int track, int clip)                           Get the loopstart for clip in track
128/live/clip/loopstart    (int track, int clip, float loopstart)          Set the loop start position for clip in track
129/live/clip/loopend      (int track, int clip)                               Get the loopend for clip in track
130/live/clip/loopend      (int track, int clip, float loopend)            Set the loop end position for clip in track
131/live/clip/loopstate    (int track, int clip)                           Get the loop state of clip on track
132/live/clip/loopstate    (int track, int clip, int on/off)               Set the loop state of clip on track
133
134/live/clip/loopstart_id (int track, int clip)                           Get the loopstart for clip in track with the track and clip id /live/clip/loopstart_id (int track, int clip, float start)
135/live/clip/loopend_id   (int track, int clip)                           Get the loopend for clip in track with the track and clip id /live/clip/loopend_id (int track, int clip, float end)
136/live/clip/loopstate_id (int track, int clip)                           Get the loop state of clip on track with the track and clip id /live/clip/loopstate_id (int track, int clip, int state)
137
138/live/clip/warping      (int track, int clip)                           Gets the warping state of the clip
139/live/clip/warping      (int track, int clip, int state)                Sets the warping state of the clip
140
141/live/clip/signature    (int track, int clip)                           Gets the time signature of a clip returns 4 4 for example
142/live/clip/signature    (int track, int clip, int denom, int num)       Sets the time signature of a clip
143
144/live/master/crossfader                                                 Get the current crossfader position
145/live/master/crossfader (float position)                                Set the crossfader position
146
147/live/quantization (int)                                                Set the global quantization. 0=None, 1=8bars, 2=4bars, 3=2bars, 4=bar, 5=half, 6=half triplet, 7=quarter, 8=quarter triplet, 9=8th, 10=8thT, 11=16th, 12=16T, 13=32nd
148
149/live/track/crossfader  (int track)                                     Gets the current cross fader assignment for track track. 0 = A, 1 = None, 2 = B
150/live/track/crossfader  (int track) (int assign)                        Sets the current cross fader assignment for track track to assign
151/live/return/crossfader (int return)                                    Gets the current cross fader assignment for return track track
152/live/return/crossfader (int return) (int assign)                       Sets the current cross fader assignment for return track track
153
154/live/selection (int tr_offset, int sc_offset, int width, int height)   Sets the dimensions and positions of the highlighted region in session view
155
156LISTENERS
157=========
158
159The following functions will automatically return a value when the specific controller changes in ableton
160without the need for a polling call
161
162/live/play (2 = playing, 1 = stopped)
163
164/live/track/info
165/live/clip/info
166/live/clip/position (int track) (int clip) (float position) (float length) (float loop_start) (float loop_end)
167
168/live/name/return
169/live/name/track
170/live/name/clip (returns on colour and name changes)
171
172/live/arm
173/live/mute
174/live/solo
175/live/volume
176/live/pan
177/live/send
178
179/live/master/volume
180/live/master/pan
181/live/master/crossfader
182
183/live/return/mute
184/live/return/solo
185/live/return/volume
186/live/return/pan
187/live/return/send
188
189/live/overdub
190/live/tempo
191/live/scene
192/live/track
193
194/live/master/meter (int 0=left, 1=right) (float value)
195/live/return/meter (int track) (int 0=left, 1=right) (float value)
196/live/track/meter (int track) (int 0=left, 1=right) (float value)
197
198/live/device/param (int track) (int device) (int param) (int value) (str name)
199/live/return/device/param (int track) (int device) (int param) (int value) (str name)
200/live/master/device/param (int device) (int param) (int value) (str name)
201
202/live/device/selected (int track) (int deviceid)
203/live/return/device/selected (int track) (int device)
204/live/master/device/selected (int device)
205
Note: See TracBrowser for help on using the repository browser.