OSC Commands
OSC is a protocol that uses network communication (wired or wireless) to communicate between various audio, video, and lighting devices, and other devices, such as tablets for remote control of your console. For configuration information, see Settings: Network.
The following is a list of the OSC commands, their variables or arguments, if any, and a description of its function.
Note: Arguments are shown following an equal sign (=). For OSC, these are not sent as a part of the OSC string itself, but instead attached as arguments. Configuration will vary depending on the software you are using.
Buttons
/cs/key/recordsnapshot Records a snapshot of the active state in a memory
/cs/key/recordnextcue Records the active state into the next cue
/cs/key/clearall Clears all the selections, active channels, playbacks and cues
/cs/key/clearplaybacks Clears the active playbacks
/cs/key/clearcues Clears the active cue
/cs/key/clearchannels Clears the active channels
/cs/key/clearselection Clears the user's selected channels
/cs/key/blackout Toggles the blackout state
/cs/key/audiomute Toggles audio mute
/cs/key/videooff Toggles video output
/cs/key/mediapause Pauses or plays media
/cs/key/ind1 Toggles Ind1
/cs/key/ind2 Toggles Ind2
Cue
/cs/playback/go Runs the next cue
/cs/playback/gotocue/xx:cue number Goes to the specified cue in the cue list
/cs/playback/goback Runs the previous cue
/cs/playback/pause Pauses an active cue change
Channels
/cs/chan/select/{x}x: channel number Exclusively select channel x
/cs/chan/select=xx: channel number, 1 integer argument Exclusively select channel x
/cs/chan/add/{x} x: channel number Add channel x to selection
/cs/chan/add=xx: channel number, 1 integer argument Add channel x to selection
/cs/chan/subtract/{x}x: channel number Remove channel x from selection
/cs/chan/subtract=xx: channel number, 1 integer argument Remove channel x from selection
/cs/chan/thru/{x}x: channel number Select every channel from the last channel selected 'thru' to channel x
/cs/chan/thru=xx: channel number, 1 integer argument Select every channel from the last channel selected 'thru' to channel x
Groups
/cs/locationGroup/select/{x} x: location group number Selects all the channels in the location group x
/cs/locationGroup/select=x x: location group number,1 integer argument Selects all the channels in the location group x
/cs/tagGroup/select/{x} x: tag group number Selects all the channels in the tag group x
/cs/tagGroup/select=x x: tag group number,1 integer argument Selects all the channels in the tag group x
Level - Params - Color
/cs/chan/at/{x}x: value [0-100] Puts the selected channel at level x
/cs/chan/at=x x: value [0-100],1 integer argument Puts the selected channel at level x
/cs/chan/wheel/{x}x: step amount [0-255] Steps the selected channel's level by x
/cs/chan/wheel=x x: step amount [0-255],1 integer argument Steps the selected channel's level by x
/cs/param/pan/wheel/{x} x: step amount Steps the selected channel's pan value by x
/cs/param/pan/wheel=x x: step amount,1 integer argument Steps the selected channel's pan value by x
/cs/param/panTilt/{x}/{y} x: pan value [0-100]
y: tilt value [0-100]
Steps the selected channel's pan value by x
/cs/param/panTilt = x, y x: pan value [0-100]y: tilt value [0-100], 2 integer arguments – pan, tilt Steps the selected channel's pan value by x and tilt value by y
/cs/param/tilt/wheel/{x}x: step amount Steps the selected channel's tilt value by x
cs/param/tilt/wheel=x x: step amount,1 integer argument Steps the selected channel's tilt value by x
/cs/color/hs/{x}/{y}x: hue value [0-360]
y: saturation value [0-100]
Sets the selected channel's color to hue x and saturation y
/cs/color/hs = x, y x: hue value [0-360]y: saturation value [0-100], 2 integer arguments - hue, saturation Sets the selected channel's color to hue x and saturation y
/cs/color/select/{x}x: color chip number Sets the selected channel's color to the color chip x
/cs/color/select=xx: color chip number, 1 integer argument Sets the selected channel's color to the color chip x
Playbacks
/cs/playback/{x}/activate x: playback number Activates the playback x
/cs/playback/{x}/execute x: playback number Executes the playback x
/cs/playback/{x}/fire/press x: playback number Performs bump button press for playback x
/cs/playback/{x}/fire/{y} x: playback number
y: toggle [0 or 1]
Controls bump button press for playback x, 1 for button pressed, 0 for button released
/cs/playback/x/fire/y No arguments Controls bump button press for playback x, 1 for button pressed, 0 for button released
/cs/playback/x/fire = y 1 argument – button pressed (integer) Controls bump button press for playback x, 1 for button pressed, 0 for button released
/cs/playback = x, “fire”, y 3 arguments – playback number (integer), “fire” (string), button pressed (integer) Controls bump button press for playback x, 1 for button pressed, 0 for button released
/cs/playback/{x}/level/{y}x: playback number
y: level [0.0-1.0]
Sets the level of playback x to value y
/cs/playback/x/level/y No arguments Sets the level of playback x to value y
/cs/playback/x/level = y 1 argument – level (float) Sets the level of playback x to value y (0.0 to 1.0)
/cs/playback = x, “level”, y3 arguments – playback number (integer), “level” (string), level (float) Sets the level of playback x to value y (0.0 to 1.0)
/cs/playbacks/changePage/{x} x: step amount Pages the current playback page by x (typically +1 or -1)
/cs/playbacks/changePage=xx: step amount, 1 integer argument Pages the current playback page by x (typically +1 or -1)
Examples
- /cs/playback/12/fire = 1 Presses the bump button for playback 12
- /cs/playback = 12, “fire”, 1 Presses the bump button for playback 12