How signals work
- A signal has a value: on or off, a number or a text.
- Something sets that value: a dashboard button, the Signals page, a control surface through the Core API, or a VRA product.
- VRA reacts to it: the default signals switch automation on or off, and an automation can check any signal in its conditions.
The default signals in every studio
Every studio has two default signals. They come with every license, belong to their own studio and cannot be deleted.
You can rename a default signal and turn it on or off, but its scope, identifier and value type are fixed, so one studio never switches off automation in another.
Turn a signal on or off
To turn a signal on or off in VRA Cloud, open Settings → Studio → Signals, click the dots next to the signal and pick Turn on or Turn off. To set a number or a text, click the signal, enter the value under Current value and click Set. Only input signals that are enabled can be set. An output signal is set by VRA, and its value is read only. On air, a Signal button on a dashboard or a key on a Stream Deck with Bitfocus Companion is quicker than the settings page.Add your own signal
Your own signals need a Pro license. With a lower license, Add signal is unavailable and the two default signals still work. To add a signal, open Settings → Studio → Signals and click Add signal. Fill in the settings and click Create signal.
After you create a signal, its sheet also shows Enabled. When Enabled is off, the signal keeps its value, but nothing can write it.
Use a signal in an automation
To run a command when a signal has a value, add the Signal state condition to an automation, pick the signal and the value. A station wide signal shows with(station wide) after its name.
Deleting a signal stops every condition that uses it. The Signals page shows how many conditions use a signal, and the delete confirmation says so again.
Set a signal from outside VRA
The Core API v2 reads and writes signals from a control surface or a script on the studio network, by id or by identifier. For example,/api/v2/signals/audio-director/off switches off audio auto switching for the studio. The same routes work over TCP and OSC.
Limitations
- Signals cannot be added below a Pro license. The two default signals work on every license.
- A default signal cannot be deleted, moved to another studio or changed to another value type.
- An output signal cannot be written from a dashboard, the Signals page or the Core API.