MixBoard® Companion Module by ClassX

This module allows Bitfocus Companion to interface with the MixBoard® video mixing application over TCP. It supports real-time control of VideoInput switch, transitions, channels and keyers with full feedback support.

Features

• Connect to MixBoard via TCP
• VideoInput program/preview switching (IN 0 to MAX_SUPPORTED_INPUT)
• Control up to 4 channels (CH-0 to CH-3)
• Trigger transitions (CUT, FADE, TR1–TR4)
• Toggle keyers (BKGD, KEY1–KEY4)
• Real-time status feedback

Module Configuration

To configure this module in Companion, fill in the following fields:

Setting	Description	Default
Host	IP address or hostname of the MixBoard device	(required)
Command port	TCP command port	701
Event port	TCP event/feedback port	801
Link channel selection	MixBoard GUI will switch by following the control panel channel selection	false
Protocol log	Enable verbose TCP response logging (debug only)	false

Ensure your network allows access to these ports.

Actions

Once the module is configured, the following actions become available in Companion:

• Set current channel – Change the active channel (CH-0 through CH-3)
• Set Program VideoInput – Set the VideoInput id to display to program
• Set Preview VideoInput – Set the VideoInput id to display to preview
• Take – Take transitions like CUT, FADE, TR1, etc.
• Set Take mode – Set the Take mode to execute on next Auto Take
• Auto Take – Automatically take following the current take mode set from Set Take mode
• Resume transition – Resumed the paused transitions following the given direction (BACKWARD | FORWARD)
• Toggle Keyer – Enable/disable keyers (KEY1, KEY2, etc.) to program/preview according to 'Play to preview' option
• Key link – Enable/disable keyer transition link option to the given keyer (KEY1, KEY2, etc.)
• Execute command – Execute custom MBC command
• Assign action – Generic assign action for control assign buttons
• Execute action – Generic execute action for control execute buttons
• Control preview VideoInput – Enable control of the preview VideoInput
• Control program VideoInput – Enable control of the program VideoInput
• T-Bar value – Set the T-Bar from the internal variable "custom:tbar_value"

Feedbacks

The module provides feedbacks to reflect the current state of the MixBoard:

• Current channel – The current channel has been changed
• Highlight VideoInput control – Highlight the PGM/PVW VideoInput button when controlled
• Key link – The Key link status has changed
• Keyer on Program – The keyer has played to program
• Keyer on Preview – The keyer has played to preview
• Keyer stopped – The keyer has stopped
• Take mode changed – The current Take mode has changed
• Update assign buttons – Update the assign buttons state
• Update execute buttons – Update the execute buttons state
• Update crosspoint buttons – Update the Compositor crosspoint VideoInput buttons
• Update resume button – Update the resume button according to transition status of the current channel
• VideoInput name changed – The VideoInput name has changed
• VideoInput on Preview – The preview VideoInput has changed
• VideoInput on Program – The program VideoInput has changed

These can be used to update button colors or labels in Companion dynamically.

Presets

The module provides built-in button presets for quick configuration inside Bitfocus Companion. These presets are grouped into functional categories and include real-time feedback for an interactive user experience.

Available Preset Categories

• CHANNELS

  • Presets for selecting the active MixBoard channel (CH-0 to CH-3)
  • Includes feedback to indicate which channel is currently selected

• PROGRAM

  • Presets for assigning a VideoInput directly to the program bus of the current channel
  • Feedback highlights the active program VideoInput

• PREVIEW

  • Presets for assigning a VideoInput to the preview bus of the current channel
  • Feedback highlights the selected preview VideoInput

• TRANSITIONS

  • Presets to execute transitions such as CUT, FADE, TR1, TR2, TR3, TR4
  • Allows user to select the Take mode such as CUT, FADE, TR1, TR2, TR3, TR4 and then AUTOTAKE
  • Includes visual feedback for active transition selection

• KEYERS

  • Presets to toggle keyers (BKGD to KEY4)
  • Feedback reflects each keyer’s current playback state (Program, Preview, or Stopped)
  • Presets to enable/disable the transition link option for each keyer
  • Feedback shows the current link status of the keyer

• CONTROL ACTIONS

  • Presets to enable program/preview VideoInput control

• CONTROL ASSIGN

  • Presets to trigger generic assign actions (e.g. crosspoint selection for Compositor VideoInput)
  • Specific feedbacks according to controlled VideoInput
  • Specific actions according to controlled VideoInput

• CONTROL EXECUTE

  • Presets to trigger generic execute actions (e.g. layout selection for Compositor VideoInput)
  • Specific feedbacks according to controlled VideoInput
  • Specific actions according to controlled VideoInput

• CONTROL VIDEOINPUT CROSSPOINTS

  • Preset to toggle the VideoInput to assign preset button
  • Feedback reflects the VideoInput assignment

Each preset is configured with the proper action, arguments, and feedback bindings for real-time updates and immediate visual confirmation of MixBoard’s state.

Troubleshooting

• Check IP/port configuration in Companion matches MixBoard's network settings.
• Enable protocollog in the module settings to log all incoming TCP responses for debugging.
• Watch Companion’s log for connection status or errors.

Maintainer

This module is maintained by Dar of ClassX - https://github.com/dar-dev.

For issues or contributions, please use the GitHub Issues page.