Studio control

Three mutations control a studio the way the studio panel in VRA Cloud does. They send the same internal commando to the Core, so the Core applies the change, updates its state and every connected client follows. Use them from a scheduling system, a control surface or a script that switches studios without an operator in the app.

How it works

You call a mutation with the station and one or more studios.
VRA Cloud resolves each studio by id or by its internal name within the station.
VRA Cloud sends an internal commando to the Core of each studio over the studio bus.
The Core applies the state and publishes its new state to VRA Cloud and all clients.

The Core needs to be online. A commando to a studio without a running Core is not queued. The Core also keeps its own rules, so while the Core is in a state like standby it rejects the commando like it would from the app.

Authentication

Authenticate as a Machine User of the station, or as a cloud user who has the station active. Moving studios between stations needs a machine user with Studio routing turned on, see Move a studio to another station.

Addressing a studio

studio_id accepts the studio id or the studio name, the internal name of the studio in VRA Cloud. Names are matched exactly and only within the given station, so a script can use Studio_1 instead of a UUID. A studio belongs to the station it feeds right now, so after a studio moves to another station, address it with that station.

Put a studio on air

mutation {
  setStudioOnAirState(input: {
    station_id: "94bf2c80-2fb6-4c0a-b33d-5d2d1bb888e7"
    studio_id: "Studio_1"
    state: ON_AIR
  }) {
    ok
    studio_ids
  }
}

state is ON_AIR, OFF_AIR, RECORDING or TOGGLE. TOGGLE flips between off air and on air; a recording studio goes off air. RECORDING only works for a studio on Core v2 with recording turned on, and the Core treats it like on air.

Switch several studios at once

The station level mutation takes a list of studios with their new state. Every studio is resolved before anything is sent, so one unknown name fails the whole call and no studio changes.

mutation {
  setStationStudiosOnAirState(input: {
    station_id: "94bf2c80-2fb6-4c0a-b33d-5d2d1bb888e7"
    studios: [
      { studio_id: "Studio_1", state: OFF_AIR }
      { studio_id: "Studio_2", state: ON_AIR }
    ]
  }) {
    ok
    studio_ids
  }
}

Activate or deactivate a Core

mutation {
  setCoreActivationState(input: {
    station_id: "94bf2c80-2fb6-4c0a-b33d-5d2d1bb888e7"
    studio_id: "Studio_1"
    state: ACTIVE
  }) {
    ok
    studio_ids
  }
}

state is ACTIVE, DEACTIVATED or TOGGLE. A deactivated Core stops handling switcher and camera commandos until it is activated again.

Move a studio to another station

A studio feeds one station at a time. Moving it to another station of your broadcaster prepares the studio for that station’s broadcast: its Core, Output Players and clients switch to the data of the new station. The move takes effect at once, also while the studio is on air. Turn on Studio routing for the machine user in VRA Cloud under Settings, Machine users. With it, the machine user can move any studio of the broadcaster to any station of the broadcaster, not only those of its own station. List the studios and the station each one feeds:

query {
  studio_routing {
    stations { id name }
    studios {
      id
      name
      air_state
      station { id name }
    }
  }
}

Move a studio:

mutation {
  setStudioStation(input: {
    studio_id: "Studio_1"
    station_id: "3f0e8c1a-7d52-4a3e-9a0b-6c2d1e4f5a77"
  }) {
    id
    name
    station { id name }
  }
}

studio_id accepts the studio id or its internal name, matched across the whole broadcaster. When two studios share a name, use the id. Moving a studio to the station it already feeds changes nothing.

Response

Every mutation returns the same shape.

{
  "data": {
    "setStudioOnAirState": {
      "ok": true,
      "studio_ids": ["99abda79-9c21-42a2-bb17-08f7886de136"]
    }
  }
}

ok - the commando was sent.
studio_ids - ids of the studios it was sent to, useful when you addressed them by name.

An unknown studio returns No studio 'name' in this station, a station you have no access to returns Not authorized for this station. setStudioStation returns Not authorized to route studios. when Studio routing is off for the machine user.

AutomationLink ingest to push now playing data through the same API.
Core Control API for control on the studio network, including Bitfocus Companion.

New to VRA

Live broadcast

Automation triggers

Outputs

Installation requirements

Clips

Advanced

Misc

Studio control

How it works

Authentication

Addressing a studio

Put a studio on air

Switch several studios at once

Activate or deactivate a Core

Move a studio to another station

Response

​How it works

​Authentication

​Addressing a studio

​Put a studio on air

​Switch several studios at once

​Activate or deactivate a Core

​Move a studio to another station

​Response

​Related

How it works

Authentication

Addressing a studio

Put a studio on air

Switch several studios at once

Activate or deactivate a Core

Move a studio to another station

Response

Related