-
Notifications
You must be signed in to change notification settings - Fork 17
OSC Two Way API Documentation
The following is a list of open sound control messages that an OSC client can send to manipulate the soundboard into doing various things. Also, a list of open sound control messages sent by CasterSoundboard to the update OSC client's user interface.
-
<player-name>:= Name of player on the currently selected and active soundboard tab. - Inbound := Any OSC commands sent TO CasterSoundboard FROM an OSC client.
- Outbound := Any OSC commands sent FROM CasterSoundboard TO an OSC client.
- All possible
<player-name>names are:
1 | 2 | 3 | 4 | 5 | 6 | 7 | 8
Q | W | E | R | T | Y | U | I
A | S | D | F | G | H | J | K
Z | X | C | V | B | N | M | ,
Kill all soundboards (stop all sounds).
ADDRESS
/glo/m/all_p_s/stop
VALUE (int)
<1>
Toggle audio ducking.
ADDRESS
/glo/m/audio_d_s
VALUE (int)
<0 or 1>
Switch to next tab.
ADDRESS
/glo/m/current_tab/next
VALUE (int)
<1>
Switch to previous tab.
ADDRESS
/glo/m/current_tab/prev
VALUE (int)
<1>
Make CasterSoundboard update/refresh the OSC client's user interface.
ADDRESS
/glo/sync
VALUE (int)
<1>
Change volume.
ADDRESS
/cbp/<player-name>/m/vol
VALUE (float)
<0.0 through 1.0>
Change track position (percentage based).
ADDRESS
/cbp/<player-name>/m/t_p_p
VALUE (float)
<0.0 through 1.0>
Toggle between stopping and playing a sound clip from it's cued start time.
ADDRESS
/cbp/<player-name>/m/p_s/play_stop
VALUE (int)
<1>
Toggle between pausing and playing a sound clip from where you left off. Track will start from cued start time if playing for the first time and after a clip has reached it's cued stop time.
ADDRESS
/cbp/<player-name>/m/p_s/resume_pause
VALUE (int)
<1>
Toggle looping a sound.
ADDRESS
/cbp/<player-name>/m/l_s
VALUE (int)
<0 or 1>
Updates OSC client user interface component that toggles audio ducking.
ADDRESS
/glo/m/audio_d_s
VALUE (int)
<0 or 1>
Updates OSC client user interface component that displays the current tab name.
ADDRESS
/glo/m/label/tab_name
VALUE (string)
<current-tab-name>
Updates OSC client user interface component that changes volume.
ADDRESS
/cbp/<player-name>/m/vol
VALUE (float)
<0.0 through 1.0>
Updates OSC client user interface component that changes the track position (percentage based).
ADDRESS
/cbp/<player-name>/m/t_p_p
VALUE (float)
<0.0 through 1.0>
Updates OSC client user interface component that toggles looping a sound.
ADDRESS
/cbp/<player-name>/m/l_s
VALUE (int)
<0 or 1>
Updates OSC client user interface component that displays the sound clip's track name.
ADDRESS
/cbp/<player-name>/m/label/tr_name
VALUE (string)
<track-name>
Updates OSC client user interface component that displays the sound clip's track position and time remaining. Time format is in minutes and seconds.
ADDRESS
/cbp/<player-name>/m/label/time
VALUE (string)
<track-position-and-time-remaining>
Updates OSC client user interface component that displays the player's current play state (playing, paused, or stopped).
ADDRESS
/cbp/<player-name>/m/label/p_s
VALUE (string)
<"Playing" or "Paused" or "Stopped">