Bitfocus Companion

Bitfocus Companion can control Power Studio through the REST API plugin. This makes it possible to use devices such as Stream Deck to operate carts, players, the playout playlist, the Mix Editor and the Recorder.

Requirements

• Power Studio version 1.24.1 or newer.
• The REST API plugin installed, enabled and reachable from the Companion computer.
• Bitfocus Companion installed on a computer in the studio network.
• The Power Studio Companion module available in Companion.
• Network access from the Companion computer to the Power Studio computer.
• Authentication, IP and CORS settings configured for the station.

The REST API plugin and Companion module both use port 9876 by default. Use another port only when the station has a clear reason and the same port is configured on both sides.

Configure Power Studio

1. Open Options and Settings.
2. Enable and configure the REST API plugin.
3. Set the API port. The default is 9876.
4. Keep the API on the trusted studio network or a managed VPN.
5. Restart Power Studio after changing plugin settings.
6. Confirm that a normal Power Studio user can log in and operate the functions that Companion will control.

Recommended REST API authentication setup:

• Leave Authenticate request using Basic Auth disabled unless the station specifically needs Basic Auth.
• With Basic Auth disabled, the REST API uses the permissions of the user currently logged into Power Studio.
• If no user is logged into Power Studio, REST API authorization fails with HTTP 401.
• With Basic Auth enabled, Companion can authenticate with a username and password, but Playout, Carts, Mix Editor, Recorder and Playlist Window control still require a user to be logged into Power Studio.

Use a dedicated local network for control where possible. Do not expose the REST API publicly.

Add The Connection In Companion

1. Open Bitfocus Companion.
2. Add a new Power Studio connection.
3. Enter the Power Studio host name or IP address.
4. Set the port to the REST API plugin port, usually 9876.
5. Leave the path prefix empty unless the API is published behind a reverse proxy.
6. Leave the module Username and Password empty when Basic Auth is disabled in Power Studio.
7. Enter the module username and password only when Basic Auth is enabled in the REST API plugin.
8. Keep the default poll interval of 100 ms unless support asks you to change it. The minimum is 10 ms.
9. Save the connection and wait until Companion reports the connection as OK.

Power Studio version 1.24.1 or newer is required. If an older version is detected, Companion shows the connection message Power Studio version 1.24.1 or newer is required.

Build The First Button Pages

Start with Companion presets. Presets already contain the action, text variables and feedback colors needed for reliable buttons.

A practical first layout is:

• One player transport page with Play, Cue or stop and Playout Player PFL for Player A through Player D.
• One cart page with rack slots 1 through 7 for Cart A and Cart B.
• One Mix Editor page with play, stop, record, save, undo and mix navigation.
• One Recorder page with play, stop, record and recorder profile navigation.
• One Playlist Window page with 16 set-next buttons and previous, next and reset window buttons.
• One small diagnostics area showing connection status and the latest command error.

Power Studio names players and carts with letters. Companion uses the same names:

Presets created with the current module include text feedback. That means title display options can be changed later and the placed buttons will update. Buttons created with an older module version may need to be dragged from the preset list again.

Useful Preset Groups

Use the three title display options in the Companion module when long titles make buttons hard to read. They control cart rack presets, player transport presets and playlist window presets separately.

Buttons can show live Power Studio information, such as the current artist and title on a player, cart names, the selected playlist item or connection status. Use this information on operator-facing pages so a Stream Deck page remains useful even when the presenter is not looking at the Power Studio monitor.

Companion feedbacks can change button colors based on Power Studio state. Common examples are:

• Playing, cued, selected or unavailable player states.
• Playout Player PFL or cue status.
• Selected cart or cart playback state.
• The next visible playlist item.
• Recorder recording state.
• Connection and authorization status.

Companion triggers can react to state changes inside Power Studio. Use triggers conservatively in live studios: visual feedback is usually safe, while automatic actions should be tested carefully before they are used during broadcast.

Button Colors And Connection State

When the connection is not OK, preset buttons turn dark gray. This includes missing configuration, a bad network connection, authentication problems and unsupported Power Studio versions.

Companion's own connection indicator helps diagnose the cause:

• A yellow or orange warning triangle usually points to authentication or authorization problems.
• A red warning triangle usually points to a missing or unreachable connection.

When the connection is OK, presets use feedback colors for the current state. For example, player and cart buttons can show loaded, selected, playing, next item or unavailable states.

Troubleshooting

If buttons stay dark gray:

• Check the Companion host, port and path prefix.
• Check that the REST API plugin is enabled in Power Studio.
• Check that Companion can reach the Power Studio computer over the network.
• Check whether Power Studio is version 1.24.1 or newer.
• Put the connection_status or last_status_error variable on a temporary button.

If authorization fails:

• With Basic Auth disabled, log in to Power Studio with a user that has permission to operate the required functions.
• With Basic Auth enabled, check the Companion module username and password.

If the module is connected but commands do not work:

• Confirm that a user is currently logged into Power Studio.
• Confirm that the logged-in user has permission for Playout, Carts, Mix Editor, Recorder or Playlist Window control.
• Put the last_command_error variable on a temporary button.

If playlist buttons set the wrong item as next, check the current Playlist Window page in Companion. Use previous window, next window and reset window to align the visible button window with the intended playlist items.