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.
Arguments may be appended to the OSC command path if your OSC software does not support them.
General
| OSC Method | Purpose |
|---|---|
| /cs/ping | Test / open connection Console replies with /cs/out/ping |
Buttons
| OSC Method | Purpose |
|---|---|
| /cs/key/recordsnapshot | Record a snapshot of the active state in a memory |
| /cs/key/recordnextcue | Record the active state into the next cue |
| /cs/key/clearall | Clear all the selections, active channels, playbacks and cues |
| /cs/key/clearplaybacks | Clear the active playbacks |
| /cs/key/clearcues | Clear the active cue |
| /cs/key/clearchannels | Clear the active channels |
| /cs/key/clearselection | Clear the user's selected channels |
| /cs/key/blackout | Toggle the blackout state |
| /cs/key/audiomute | Toggle audio mute |
| /cs/key/videooff | Toggle video (HDMI) output |
| /cs/key/mediapause | Pause or continue media |
| /cs/key/ind1 | Toggle Independent 1 |
| /cs/key/ind2 | Toggle Independent 2 |
Cues
| OSC Method | Arguments | Purpose |
|---|---|---|
| /cs/playback/go | Run the next cue | |
| /cs/playback/goto /cs/playback/gotocue |
Cue number | Goto the specified cue in the cue list |
| /cs/playback/goback | Run the previous cue | |
| /cs/playback/pause | Pause an active cue fade |
Channels
| OSC Method | Arguments | Purpose |
|---|---|---|
| /cs/chan/select | Channel number | Exclusively select channel |
| /cs/chan/add | Channel number | Add channel to selection |
| /cs/chan/subtract | Channel number | Remove channel from selection |
| /cs/chan/thru | Channel number | Select every channel from the last channel selected 'thru' to channel |
Groups
| OSC Method | Arguments | Purpose |
|---|---|---|
| /cs/locationGroup/select | Location group number | Select all the channels in the location group |
| /cs/tagGroup/select | Tag group number | Select all the channels in the tag group |
Level - Params - Color
| OSC Method | Arguments | Purpose |
|---|---|---|
| /cs/chan/at | Value [0-100] | Set the selected channel to level |
| /cs/chan/wheel | Step amount [+/-] | Step the selected channel's level |
| /cs/param/param_name | Value [0-100] | Set the selected channel's parameter value |
| /cs/param/param_name/wheel | Step amount | Step the selected channel's parameter value by amount |
| /cs/param/pan/wheel /cs/param/tilt/wheel |
Step amount | Step the selected channel's pan or tilt value |
| /cs/param/panTilt | Pan value [0-100] Tilt value [0-100] |
Set the selected channel's pan and tilt values |
| /cs/color/hs | Hue value [0-360] Saturation value [0-100] |
Set the selected channel's color to hue x and saturation y |
| /cs/color/rgb | Red, green, blue values [0-100] | Set the selected channel's color to RGB |
| /cs/color/rgbRaw | Red, green, blue values [0-255] | Set the selected channel's color to RGB |
| /cs/color/select | Color palette number | Set the selected channel's color to the color palette |
Playbacks
| OSC Method | Arguments | Purpose |
|---|---|---|
| /cs/playback/{x}/activate | Activates Playback {x} | |
| /cs/playback/{x}/execute | Executes Playback {x} | |
| /cs/playback/{x}/fire/press | Bump button press & release for playback {x} | |
| /cs/playback/{x}/fire | Press / release [1 or 0] | Bump button for playback {x} 1 for button pressed, 0 for button released |
| /cs/playback/{x}/level | Level [0.0-1.0] | Set the level of playback {x} to value |
| /cs/playbacks/selectPage | Page number [1-10] | Set playback page |
| /cs/playbacks/changePage | Step amount [+/-] | Change the current playback page up or down (typically +1 or -1) |
{x} is the playback number to control. 1-20 or 1-40 depending on your console model
Accepted syntaxes to press and hold the bump button for playback 12:
- /cs/playback/12/fire/1
- /cs/playback/12/fire = 1
- /cs/playback/12 = "fire", 1
- /cs/playback = 12, "fire", 1
OSC Output
ColorSource AV will send the following when the value changes:
| OSC Method | Arguments | Purpose |
|---|---|---|
| /cs/out/ping | Response to /cs/ping | |
| /cs/out/playback/{x}/level | Level [0.0-1.0] | The current level of playback {x} |
| /cs/out/playbacks/page | Page number [1-10] | The current page of playbacks |
| /cs/out/active/cue/text | Cue label (string), cue number (float) | The current cue |
| /cs/out/active/pending/text | Cue label (string), cue number (float) | The next cue |
| /cs/out/playback/go | Cue label (string) | Go has been pressed |
Output is not sent until an OSC packet has been received, eg /cs/ping