Skip to content

OSC API Quick Reference

James F-Robinson edited this page May 29, 2017 · 3 revisions

One-Way OSC address reference

Global OSC Message Commands

Address Value type Value
/castersoundboard/global/modify/all_play_states/stop integer <1>
/castersoundboard/global/modify/audio_ducking_state integer <0 or 1>

Player OSC Message Commands

Address Value type Value
/castersoundboard/board/<tab-name>/player/<player-name>/modify/volume float <0.0 through 1.0>
/castersoundboard/board/<tab-name>/player/<player-name>/modify/track_position_percent float <0.0 through 1.0>
/castersoundboard/board/<tab-name>/player/<player-name>/modify/play_state/play integer <1>
/castersoundboard/board/<tab-name>/player/<player-name>/modify/play_state/pause integer <1>
/castersoundboard/board/<tab-name>/player/<player-name>/modify/play_state/resume integer <1>
/castersoundboard/board/<tab-name>/player/<player-name>/modify/play_state/stop integer <1>
/castersoundboard/board/<tab-name>/player/<player-name>/modify/loop_state integer <1>

Two-Way OSC address reference

Global OSC Message Commands (OSC Client → CasterSoundboard)

Address Value type Value
/glo/m/all_p_s/stop integer <1>
/glo/m/audio_d_s integer <0 or 1>
/glo/m/current_tab/next integer <1>
/glo/m/current_tab/prev integer <1>
/glo/sync integer <1>

Player OSC Message Commands (OSC Client → CasterSoundboard)

Address Value type Value
/cbp/<player-name>/m/vol float <0.0 through 1.0>
/cbp/<player-name>/m/t_p_p float <0.0 through 1.0>
/cbp/<player-name>/m/p_s/play_stop integer <1>
/cbp/<player-name>/m/p_s/resume_pause integer <1>
/cbp/<player-name>/m/l_s integer <0 or 1>

Global OSC Message Commands (CasterSoundboard → OSC Client)

Address Value type Value
/glo/m/audio_d_s integer <0 or 1>
/glo/m/label/tab_name string <current-tab-name>

Player OSC Message Commands (CasterSoundboard → OSC Client)

Address Value type Value
/cbp/<player-name>/m/vol float <0.0 through 1.0>
/cbp/<player-name>/m/t_p_p float <0.0 through 1.0>
/cbp/<player-name>/m/l_s integer <0 or 1>
/cbp/<player-name>/m/label/tr_name string <track-name>
/cbp/<player-name>/m/label/time string <track-position-and-time-remaining>
/cbp/<player-name>/m/label/p_s string <"Playing" or "Paused" or "Stopped">