OSC

Documentation on OSC support in RouteEffect

Control RouteEffect by sending it Open Sound Control (OSC) messages. With Bitfocus Companion and an Elgato Stream Deck, you can have a physical button control surface to interface with RouteEffect. The following sections covers the OSC messages supported by RouteEffect.

Configuring Bitfocus Companion

Here are instructions for adding support for controlling RouteEffect in Companion:

  1. Go to Companion.

  2. Click Connections.

  3. Click Add connection.

  4. Add a Generic OSC connection to your Companion instance

  5. For the Target Hostname, enter the IP address of the device running RouteEffect.

  6. For the Target Port, enter the port number for the OSC server as defined in RouteEffect Settings.

  7. Click Save.

OSC Message Anatomy

You can send a variety of OSC messages to RouteEffect:

  • Send message without arguments

  • Send integer

  • Send float

  • Send String

  • Send messages with multiple arguments

  • Send boolean

  • Send blob

You will typically send the three items listed in bold above, Send message without arguments, Send String, and Send messages with multiple arguments.

OSC Path and Arguments

The OSC path will contain the message you want to send to RouteEffect along with the ID of the video router you wish to communicate to.

Example 1

For example, support you want to recall the preset "Default Mini" on an ATEM Mini Pro with the identifier: E735F17C-D01D-4DF8-89E7-E01287D188C5.

  • OSC path: /routeeffect/preset/E735F17C-D01D-4DF8-89E7-E01287D188C4

  • Arguments: "Default Mini"

Example 2

If you want to route output 2 to input 1, you would use the following OSC path and arguments using the Send message wit multiple arguments action:

  • OSC path: /routeeffect/route/E735F17C-D01D-4DF8-89E7-E01287D188C5

  • Arguments: 2 1

Arguments

If you choose the Send message with multiple arguments and want to include a string with a space in it, be sure to surround the string with double quotes.

Unique Identifier

Every video router and simulated video router has a unique identifier. You can find this by looking at the detail page for your video router in RouteEffect under the heading OSC Identifier.

Tap the string to copy the identifier to your clipboard.

PreviousDashboardNextConnect

Last updated