Install the VRA Core module for Bitfocus Companion from a download, connect it to the Core and get buttons with tally, on-air status and studio presets.
The VRA Core module for Bitfocus Companion turns a Stream Deck, or any other Companion surface, into a control panel for the Core. It uses the Core API v2 and reads the Core’s state about once a second, so buttons show tally, on-air status and values.
Studio and Core: on air, recording, off air; Core activate, deactivate and reload configuration.
Signals, Audio Director, Camera Assist and macros, with state feedback. Automations show their state.
Cameras: cut, preview and angles, with program (red) and preview (green) tally.
Output Player v2: scenes, rundown, items, clip and graphics banks, playout take out, return and hold.
Station variables: set and toggle.
Presets made from your studio: a button for every signal, macro, camera, angle, output, bank and variable, updated when the studio changes.
The module is under review for the Companion module store. Until it is listed there, install it from the download below. The steps are the same for a Companion machine without internet.
This link always serves the newest version. Earlier versions and the release notes are on the releases page. Keep the file as it is: Companion imports the .tgz itself, you do not unpack it.Does the Companion machine have no internet? Download the file on another computer and copy it over, for example on a USB stick.
Open Connections, search for VRA in Add New Connection and click Add next to VRA Core. Give the connection a label and choose the version you imported under Module Version.
2
Connect to the Core
Does Companion run on the Core machine itself? Then keep the settings as they are: Core address127.0.0.1, Port3002, no token. The connection turns green within a few seconds.
Companion on another machine:
Core address: the IP address or host name of the Core machine.
Device token: create a device in VRA Cloud under Studio settings → Core API → Devices and paste its token. Not needed when Access without a token lets this machine in. See Authentication and LAN access.
Station: optional. With a station set, the buttons only act while that station holds the studio. See Station safety.
Open Buttons, then the Presets tab, and pick your VRA Core connection. Drag a preset onto a button. The presets are made from your studio, so you see your own signals, macros, cameras, outputs and variables.
The colours follow the studio:
Colour
Meaning
Red
On air, camera on program, item or bank on air
Green
Camera on preview, VRA app connected
Orange
Recording, output fault, playout held
Blue
Core active, macro running, automation activated
Amber
Signal or BOOLEAN variable on, bank AUTO on
The module’s help in Companion lists every action, feedback and variable: click ? next to the connection.
Download vra-core.tgz again and import it on the Modules page. Companion keeps the earlier version until you switch over: open the connection, click the pencil next to Module Version, choose the new version and click Save. The connection restarts with it.
Change the module version of a connection. Screenshot: Bitfocus Companion documentation.
The Core runs, the address and port are right, and the network lets Companion reach port 3002.
Authentication failure
Companion runs on another machine and needs a device token, or the token is wrong or revoked.
Insufficient permissions
The Core API or its System feature is switched off in Studio settings → Core API, or the device may not use it.
A button that does nothing writes the reason to the connection’s log in Companion, for example 409 station_mismatch. On the Core machine, http://localhost:3002/api/v2/requests lists the last calls with their status. See Errors and status codes.Prefer to build your own buttons with Companion’s Generic HTTP module? See Bitfocus Companion Control over Visual Radio.
