Skip to content

Open Sound Control APIs

Oscar Cerna-Mandujano edited this page May 16, 2017 · 2 revisions

Open Sound Control (OSC)

Now that CasterSoundboard supports OSC communication, you can now control the soundboard using a variety of hardware and other software that supports the Open Sound Control protocol. This means that you can even control the soundboard with your phone or tablet over a network if you have an app on your device that supports the protocol.

Available APIs

CasterSoundboard supports two types of APIs over OSC. The first one is the "One-Way" api and the second is the "Two-Way" api.

One-Way API

The one-way api is a way for other software/hardware to send commands to the soundboard that don't need to receive feedback from the soundboard itself.

Two-Way API

The two-way api is for when you have software/hardware that needs feedback from soundboard in addition to issuing it commands. This is useful for applications where you need to synchronize software/hardware user interfaces with the soundboard's own user interface. The two-way api returns OSC messages containing data about track names, volume levels, loop states, sound board tab names, track position, song time codes, etc... Essentially, it sends out metadata for OSC client user interfaces as well as data about the positions of faders, labels, toggle buttons, etc... to the client software/hardware so it can adjust and update it's own user interface accordingly.