Getting Started
Sofie Open Live Gateway (sofie-tsr-open-live) is a TSR plugin for Sofie Automation that lets Sofie drive an Open Live production over Open Live's controller WebSocket, using the 1.x automation control contract. It translates Sofie timeline objects into Open Live commands for program and preview switching, DSK and graphics toggling, audio level and mute changes, clip cue/play/pause/stop, on-air control and fade-to-black. After a reconnect it waits for the HELLO/SNAPSHOT sequence and then sends only the differences. Available as an open web service in Eyevinn Open Source Cloud.
The gateway connects out to Sofie Core and to Open Live, so no inbound ports are required. The Open Live URL, production ID and token are configured in the device settings in Sofie.
Prerequisites
- If you have not already done so, sign up for an Eyevinn OSC account
- A running Sofie Core instance
Step 1: Store secrets
Navigate to the Sofie Open Live Gateway service and open the "Service Secrets" tab. Create the following secrets:
sofiedevicetoken: any stable value the gateway uses to register with Sofie Core. Keep it the same across restarts.openlivepat(optional): an OSC Personal Access Token, if the Open Live device in Sofie usesoscauth modeopenliveapikey(optional): an API key, if the Open Live device in Sofie usesapiKeyauth mode for a self-hosted Open Live
Storing the token and key as secrets keeps them out of Sofie's device settings, where the gateway would log them.
Step 2: Create the gateway instance
On the service page click "Create" and fill in:
| Field | Description |
|---|---|
| Name | Unique instance name (lowercase letters and digits, max 20 characters) |
| CoreHost (required) | Cluster-internal host of the Sofie Core instance, from the Core instance details. The public URL is behind the OSC auth gate and does not work |
| CorePort | Port of Sofie Core, defaults to 3000 |
| DeviceId | Stable ID the gateway registers with in Sofie Core. If empty, the first label of the instance hostname is used |
| DeviceToken (required) | {{secrets.sofiedevicetoken}} |
| LogLevel | Log level, defaults to info |
| OpenLiveOscPat | {{secrets.openlivepat}} |
| OpenLiveApiKey | {{secrets.openliveapikey}} |
Step 3: Add the device in Sofie
When the instance is running, the gateway registers itself with Sofie Core under its device ID. In the Sofie UI, add an Open Live device to your studio's peripheral devices and set the Open Live URL, production ID and token or auth mode.
Using the CLI
osc create eyevinn-sofie-tsr-open-live mygateway \
-o CoreHost="<internal-core-host>" \
-o CorePort="3000" \
-o DeviceToken="{{secrets.sofiedevicetoken}}"