Loading...
Control MiruSuite devices, cameras, AutoCut, the switcher, projects, and Music Follower from Bitfocus Companion.
8080; use 127.0.0.1 when Companion and MiruSuite run on the same computer.If the connection fails, check the address and port, network access/firewall rules, MiruSuite availability, and credentials. The module's Connection status variable can also be used to show connection state on a Companion button.
Presets are generated from the devices and settings configured in MiruSuite. Their names include the target device where relevant. Sections and groups are organized by workflow:
| Companion section or group | What you can do |
|---|---|
| Video: device — General | Enable, disable, or toggle the device's director; trigger random or nearby-preset moves for AutoMove; stop an AutoMove; return a PTZ camera home. Only controls supported by that device's configured components are shown. |
| Video: device — Person Tracking | Choose tracking mode and shot size, learn the current target's face, correct framing once, adjust the target point or tracking sensitivity, and exit steady mode. Controls that need a head-tracking director or person tracker appear only when available. |
| Video: device — PTZ | Hold direction or zoom buttons to move the camera. Manual movement speed is shared across PTZ cameras and can be adjusted with the speed buttons. |
| Video: device — Saved Presets | Recall MiruSuite camera presets. The active-preset control reapplies the camera's current active preset. |
| Audio: device — AutoCut | Set or clear the dominant-speaker override, and enable/disable the device's AutoCut audio component when it has one. |
| vMix Framer: device | Adjust the frame once or enable, disable, and toggle the vMix Framer. |
| Application — AutoCut | Enable, disable, or toggle AutoCut. Presets also include target shot-size configuration controls. |
| Application — Projects | One preset per available project. These presets confirm reported interruptions and request device enablement plus AutoCut and switcher setting restoration. Use the Load Project action to choose these options yourself. |
| Application — Switcher | Select a configured input for Program or Preview, swap the buses with CUT, or trigger the transition configured in MiruSuite. |
| Application — Gamepad | Assign a video device to MiruSuite's shared gamepad control. |
| Application — Orchestra and Music Follower | Include/exclude eligible devices in Orchestra, change common Orchestra settings, toggle each Music Follower, and select ready music pieces or setlist entries. |
Presets and dropdown choices depend on the current MiruSuite configuration. Configure devices, components, presets, switcher inputs, projects, and Orchestra content in MiruSuite first; then refresh or reconnect the module if you change that configuration.
Add an action directly when a preset does not expose the option you need. Available actions include:
-1 to 1 and are scaled by that shared speed.Feedbacks let a button reflect MiruSuite's current state. Depending on your configuration, the module provides feedback for:
Most device feedbacks are populated from devices known to MiruSuite, so the relevant component must be configured on the selected device. Feedbacks that refer to a project, switcher input, face, preset, or Music Follower item use the values currently reported by MiruSuite.
Use Companion variables in button text, expressions, and other modules. Global variables include connection status, device and preset counts, active project, dominant speaker, gamepad camera, AutoCut state/countdown/live shots, live inputs, manual PTZ speed, and Orchestra settings. Device-specific variables are named with the MiruSuite numeric device ID, for example:
$(autodirector-mirusuite:device_12_name)$(autodirector-mirusuite:device_12_director_state)$(autodirector-mirusuite:device_12_active_preset_name)$(autodirector-mirusuite:device_12_controller_pan_angle)$(autodirector-mirusuite:device_12_music_follower_status)Replace 12 with the device ID shown by MiruSuite. Only variables relevant to configured devices/components are defined. For the full variable list, use Companion's variable picker after the module connects.
For MiruSuite guidance, see the Companion integration documentation.
Version 1.1.1 removed the automatic button learning feature. Existing buttons using
learnAutoButtons, playAutoPreset, overwriteAutoPreset, or clearAllAutoButtons
no longer perform those operations. The learnMode and autoPreset feedbacks and
learningMode, offlineMode, and autoConfiguredButtons variables were also removed.
Remove those entries from existing buttons and replace them with the supported
Play Preset / Overwrite Preset actions and Active Preset feedback, selecting saved
MiruSuite presets explicitly. Automatic button assignment and offline learning
have no direct replacement.
Saved connection passwords are migrated to Companion secrets automatically. This module requires Companion 5.0 or later with the Node 26 runtime.