Skip to content
Axolito edited this page Feb 28, 2024 · 1 revision

Introduction

CasparCG Client can be controlled via the OSC protocol. This means you can interact with CasparCG Client in a way other than with the keyboard and mouse, while retaining all the possibilities offered by the software. This complements the traditional keyboard commands via F1, F2, F3, etc...

Not to be confused with OSC messages sent by CasparCG Server to the client to inform it of audio levels or clip playback status, for example.

In some cases, it may be more useful to control CasparCG Server via CasparCG Client via OSC, so that last-minute adjustments to the software interface are always under control.

OSC is unidirectional, so a third-party device or software won't be able to tell whether the messages sent are valid, whether they've been executed or whether they're running.

OSC Messages

All OSC messages below are Boolean in true state.

General control

Note

To use the following messages, the Allow Remote Triggering parameter must be enabled for the current Rundown. Enable Allow Remote Triggering in Rundown menu

  • /control/stop
  • /control/play
  • /control/playnow
  • /control/load
  • /control/pause
  • /control/next
  • /control/update
  • /control/invoke
  • /control/preview
  • /control/clear
  • /control/clearvideolayer
  • /control/clearchannel
  • /control/down
  • /control/up
  • /control/playnowifchannel
  • /control/playandautostep
  • /control/playnowandautostep

Control of a specific item

Note

To use the following messages, the Allow Remote Triggering parameter must be enabled for the each element to be controlled. Enable Allow Remote Triggering in Output section of element

These OSC messages use the element UID to control them, which must be specified for each element:

Enter an UID in Output section of element

  • /control/#UID#/stop
  • /control/#UID#/play
  • /control/#UID#/playnow
  • /control/#UID#/load
  • /control/#UID#/pause
  • /control/#UID#/next
  • /control/#UID#/update
  • /control/#UID#/invoke
  • /control/#UID#/preview
  • /control/#UID#/clear
  • /control/#UID#/clearvideolayer
  • /control/#UID#/clearchannel

Example

Here's an example of implementation with Bitfocus Companion using the Generic: OSC connection.

Example in Bitfocus Companion

Clone this wiki locally