This section describes the various actions in Companion module for Bitfocus.

Note: Most actions require Viz Arc to be running.

Note: The companion app doesn't allow you to load or fill data dynamically. Therefore, it's very important to press the blue Learn values button every time you select a filter.

Action - Execute

Drag and drop the Execute action to any of the page buttons. The action lets you select an Action from the currently loaded project by selecting any of the actions.

The button automatically displays the name and color of the selected action, exactly as it appears in Viz Arc, and the font size adjusts to the length of the text. If the configured action is no longer found in the currently loaded project (for example, after a project change), the button turns yellow.

The button turns black if there is an incorrect configuration. Try to open the action, click the Learn values button and check the configuration.

Action - Execute (REST)

The Execute REST Action allows you to launch Viz Arc actions using the REST service which does not require Viz Arc to be running.

You need to specify a project, an action and a profile on which to execute the action. Since the REST service works on stored projects, any project can be selected, independently of what is currently loaded in the Viz Arc client. The button automatically displays the name and color of the selected action.

The button turns black if there is an incorrect configuration. Try to open the action, click the Learn values button and check the configuration.

Arena

The Arena action lets you execute Viz Arena related macros.

  • Detect Viz Arena Calibration: Detects the calibration of the current image, equivalent of pressing the shortcut D in Viz Arena.

  • Clear Viz Arena Calibration: Clears the calibration, equivalent of pressing the BACKSPACE button in Viz Arena.

  • Clear Viz Arena Keyer: Clears the Keyer, equivalent of pressing C in Viz Arena.

  • Set Viz Arena Camera: Selects the current camera for both Viz Arena preview and program feeds.

The parameter fields support Companion variables. Refer to the Viz Arena Integration documentation for more information.

DataMap

The DataMap action allows you to set a Viz Arc DataMap variable. Both the key and the value fields support Companion variables, so live data from other Companion connections can be pushed into Viz Arc graphics.

Object Tracker

The Object Tracker action lets you execute Object Tracker related macros.

  • Take Tracker: Takes all active trackers On Air.

  • Take Out Tracker: Takes all active trackers Off Air.

  • Preview Tracker: Previews all active trackers.

  • Preview Out Tracker: Previews out all active trackers.

  • Stop Tracker: Stops all active trackers.

  • Set Active Tracker: Selects the currently active tracker by index, starting at 1.

  • Reset Pointer Offset: Resets all pointer offsets.

The parameter fields support Companion variables. Refer to the Viz Object Tracker manual for more information.

Playlist

The Playlist action lets you control various aspects of Viz Arc's playlist.

  • Execute Selected Playlist Row: Plays the currently selected playlist element.

  • Execute Selected Playlist Row And Next: Plays the currently selected playlist element and advances to the next playable playlist element.

  • Preview Selected Playlist Row: Previews the selected playlist element.

  • Go to First: Selects the first playlist element.

  • Play Current Playlist: Plays the currently selected playlist from the selected item on.

  • Stop Current Playlist: Stops the currently selected playlist.

  • Play Playlist By Name: Selects and plays the playlist by the specified name. If the name is ambiguous, it plays the first occurrence.

  • Play Playlist By Index: Selects and plays the playlist specified by the given index, where 0 is the first playlist.

  • Change Active Tab: Selects the tab by the specified name.

  • Execute By Callup Code: Executes the playlist row associated with the specified callup code.

  • Execute Row by Id: Plays the specific playlist row bound to the button, regardless of which row is currently selected in Viz Arc. If the bound row no longer exists in the current playlist, the button shows a warning.

Refer to the playlist to learn more about Viz Arc's playlist functionality.

Load Project

The Project Loader allows to load a project from Graphic Hub or a local file based project. Select a project to be loaded from the drop down menu.

Script Callback

The Script Callback action triggers Viz Arc script functions that may be defined in the global script or a template.

The Payload can be any string passed to the script method.

A sample Viz Arc script might look like this:

Viz Arc Script Sample

The available script callback is OnCompanionKey.

Sub OnCompanionKey(companionKey)
' companionKey.Payload : the payload string configured on the button
' companionKey.DeviceName : always "Companion"
Console.WriteLine("Companion button pressed: " & companionKey.Payload)
End Sub

Since the payload field supports Companion variables, a single script callback can react to many different buttons by inspecting the payload content.

Shortcut

The Shortcut action lets you execute Viz Arc's shortcuts.

Viz Arc Launcher

With the Viz Arc Launcher, you can start Viz Arc in case it is not running with a specific project with optional command line arguments.

This plug-in relies on an installed Viz Arc Unreal Loader service. Change the Launcher address to a different host/port if the Unreal Launcher and Viz Arc are installed on a remote host.

You can also change Command Line Arguments.

Feedbacks

The Feedback tab contains a list of all feedback related to that action. They can be disabled or enabled as desired.

Depending on the action, the following feedbacks are available:

  • Action Text / Action Color (In-App and REST): The button automatically shows the name and color of the selected Viz Arc action, exactly as it appears in the Viz Arc UI. The font size adjusts automatically to the length of the text.

  • Action Missing Warning (In-App) / Playlist Row Missing: The button turns yellow when the configured action or playlist row is not found in the currently loaded project, for example after a project change.

  • Request Error: The button turns red for two seconds when a request to Viz Arc fails, giving immediate visual feedback to the operator.

  • Label feedbacks: Additional feedbacks automatically label buttons for the project, DataMap key, shortcut, playlist name/index, active tab, playlist row and callup code actions.

Feedbacks update in real time: the module keeps a WebSocket connection to Viz Arc and automatically refreshes its action, tab and playlist information whenever a new project is loaded.

Request Error feedback: Once the Viz Arc Action to be executed has been selected, pushing the button executes the action only if Viz Arc is running and the project from which the action originates is currently opened. If the action cannot be found or Viz Arc is not running, the background starts to blink red.

Variables

The module exposes the following Companion variables:

Variable

Description

connection_status

Current connection status of the module.

inapp_host / inapp_port

Configured host and port of the Viz Arc Web Server (In-App) API.

rest_host / rest_port

Configured host and port of the Viz Arc REST API.

Logs

In the Connection tab, you can view the Logs which can be very useful for finding any problems related to the action configuration.

image-20260810-151411.png