OSC One Way API Documentation - JupiterBroadcasting/CasterSoundboard GitHub Wiki
The following is a list of open sound control messages that an OSC client can send to manipulate the soundboard into doing various things.
<tab-name>
:= Name of a particular soundboard tab open in CasterSoundboard.
<player-name>
:= Name of player on a particularly selected soundboard tab.
- 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 | ,
- Tab names
<tab-name>
can have almost any character in them, even spaces, but you should avoid using "/
" forward slashes since that character is reserved for the OSC message specification. - Please be aware if CasterSoundboard has more than one tab with the same name open, the API will simply target the first tab from left to right with that name and ignore the others. (This behavior may change in the future).
Kill all soundboards (stop all sounds).
ADDRESS
/castersoundboard/global/modify/all_play_states/stop
VALUE (int)
<1>
Toggle audio ducking.
ADDRESS
/castersoundboard/global/modify/audio_ducking_state
VALUE (int)
<0 or 1>
Change volume.
ADDRESS
/castersoundboard/board/<tab-name>/player/<player-name>/modify/volume
VALUE (float)
<0.0 through 1.0>
Change track position (percentage based).
ADDRESS
/castersoundboard/board/<tab-name>/player/<player-name>/modify/track_position_percent
VALUE (float)
<0.0 through 1.0>
Play a sound from the beginning.
ADDRESS
/castersoundboard/board/<tab-name>/player/<player-name>/modify/play_state/play
VALUE (int)
<1>
Pause.
ADDRESS
/castersoundboard/board/<tab-name>/player/<player-name>/modify/play_state/pause
VALUE (int)
<1>
Play a sound from where you paused.
ADDRESS
/castersoundboard/board/<tab-name>/player/<player-name>/modify/play_state/resume
VALUE (int)
<1>
Stop a sound.
ADDRESS
/castersoundboard/board/<tab-name>/player/<player-name>/modify/play_state/stop
VALUE (int)
<1>
Toggle looping a sound.
ADDRESS
/castersoundboard/board/<tab-name>/player/<player-name>/modify/loop_state
VALUE (int)
<0 or 1>