Stream Dock x Companion: Getting Connected
MiraBox
Use the Stream Dock plugin or direct USB integration to connect your device to Bitfocus Companion. This guide focuses only on establishing the connection and resolving common connection problems.
Bitfocus Companion can connect software and production hardware to physical control surfaces. Stream Dock can work with Companion in two different ways: through the Companion plugin inside the Stream Dock software, or through direct USB integration managed by Companion.
For users considering a Stream Deck alternative, either method can turn Stream Dock into a practical streaming control deck. The correct option depends on whether you want to keep using Stream Dock software features or dedicate the device entirely to Companion.
Scope of this guide: This article covers the connection between Stream Dock and Companion. Creating Companion buttons, actions, feedback, and application modules is managed inside Companion and is covered by the official Bitfocus documentation.
Choose One Connection Method
Plugin Connection
Choose the plugin method when you want to keep the Stream Dock software running and continue using its other plugins. Stream Dock and Companion run at the same time, while the Companion plugin passes button information between them.
Direct USB Integration
Choose direct integration when your supported Stream Dock will be used exclusively as a Companion control surface. The Stream Dock software must be fully closed so Companion can manage the USB device.
Do not let both applications manage the same Stream Dock at the same time. This can cause device detection failures, unresponsive controls, or display problems. Neither method requires the separate Companion Satellite application.
Method 1: Connect Through the Stream Dock Plugin
1. Check the Requirements
Download Companion from the official Bitfocus download page. The connection flow in this guide uses the Satellite API and is intended for Companion 4.3 or later.
The Companion plugin page currently lists these minimum Stream Dock versions:
- Windows:
3.10.188.226 - macOS:
3.10.189.0313
2. Install the Companion Plugin
Open the Companion plugin page on MiraBox Space, sign in, and select Get or Open Software. Allow the browser to open Stream Dock and wait for the plugin to finish installing. Companion should then appear in the Stream Dock action list.
3. Confirm That the Satellite API Is Available
Start Companion and select Launch GUI. In Companion settings, confirm that the Satellite API or Satellite protocol is enabled. Depending on the Companion version, this setting may appear under Protocols.
The default Satellite TCP port is 16622. The browser administration port is not the plugin connection port.
4. Enter the Connection Details in Stream Dock
In Stream Dock, add a Companion action to an empty key and open Plugin Configuration. When Companion and Stream Dock run on the same computer, use:
- Protocol: Satellite TCP
-
Host:
127.0.0.1 -
Port:
16622 - Device ID: Keep the generated default value
If Companion runs on another computer, enter that computer's local network IP address instead of 127.0.0.1.
If the Satellite port was changed in Companion, enter the same port in the Stream Dock plugin.
Use remote connections only on a trusted network. Allow the necessary application and port through the firewall when required, but do not disable the firewall or expose the control port directly to the public internet.
5. Confirm the Connection
Save the configuration. The plugin should report Connected to Companion. The Stream Dock title bar may also report that the device is connected, but this only confirms the hardware connection and does not replace the plugin connection status.
Satellite WebSocket is another available protocol and normally uses ws://127.0.0.1:16623.
Do not mix this address with Satellite TCP port 16622 or ports shown in older Legacy tutorials.
Method 2: Connect Stream Dock Directly to Companion
1. Confirm Device Support
The current Bitfocus MiraBox surface module lists models including 293V3, XL, N3, N4, M18V3, HSV293S, and selected compatible variants. Support changes as the module is updated, so check the exact model in the MiraBox Stream Dock module documentation.
2. Fully Close the Stream Dock Software
Save your work and completely quit Stream Dock, including its system-tray process. Closing or minimizing the main window is not enough. Connect the device to the Companion computer with a USB cable that supports data transfer.
3. Add the MiraBox Surface Integration
Open the Companion GUI and go to Surfaces. In Surface Integrations, select Add Surface Integration.
If uninstalled modules are hidden, select All Available. Search for MiraBox and add the MiraBox Stream Dock surface module. Confirm that the integration is enabled and that Companion detects the USB device.
This is a hardware surface integration. It is different from a Companion connection module used to control OBS or another application, and it is also different from the Companion plugin installed through MiraBox Space.
To return to the plugin method, disable the MiraBox surface integration in Companion before restarting the Stream Dock software.
Troubleshooting
Companion Cannot Find a Directly Connected Stream Dock
Make sure Stream Dock and its system-tray process are fully closed. Confirm that the MiraBox surface module is installed, enabled, and compatible with the exact device model. Reconnect the USB data cable and rescan for devices. If the model is not supported, use the plugin connection method instead.
The Plugin Reports That It Is Disconnected
Confirm that Companion is running and that the Satellite API is enabled. Check the selected protocol, host, and port. If the applications are on different computers, verify the local network IP address and firewall rules.
The Device Is Connected, but Companion Is Not
The Stream Dock title bar only reports the USB hardware status. Open the Companion plugin settings and check for the separate Connected to Companion message.
The Port Settings Do Not Work
Use 16622 for Satellite TCP or 16623 for Satellite WebSocket unless those ports were changed in Companion. Do not use the browser administration port, and do not copy Legacy port values from older tutorials.
A Remote Companion Computer Cannot Be Reached
Replace 127.0.0.1 with the Companion computer's current local network IP address. Confirm that both computers are on the same trusted network and that the required port is allowed through the firewall.
The Direct Connection Stops Working After Stream Dock Starts
Only one application should manage the USB device. Exit Stream Dock completely when using direct Companion integration. When using the plugin method, disable direct MiraBox surface integration in Companion.
The Connection Works, but Companion Buttons or Actions Do Not
This confirms that the Stream Dock connection is working. Button creation, actions, application modules, and feedback are configured inside Companion. Continue with the official Companion button documentation.
Choose the Connection That Fits Your Workflow
Use the Companion plugin when you want to keep Stream Dock software and its other plugins available. Use direct USB integration when a supported device will be dedicated to Companion. Keeping that ownership clear is the most important part of a reliable connection.
Related resources: Companion download · Satellite API · Surface documentation · MiraBox module documentation