Companion

Included in

AutoTrack StudioAutoCutEducation

Pushing physical buttons is much more intuitive and faster than using a mouse. With the MiruSuite companion module, you can integrate the control of MiruSuite into your existing workflow.

INFO

Bitfocus Companion is a free software that allows you to control your devices from an Elgato stream deck. You can download it here.

Installation

Since version 0.4.0 of Companion you can install our MiruSuite module directly from Companion's connection list. Simply search for "MiruSuite" and select the latest version. This will automatically download and install the module.

For older versions you can download our module here and add it to your module path.

Configuration

1. Make sure MiruSuite is running and the Companion server has network access to the device running MiruSuite (port 8080).
2. Open the Companion web interface and add the MiruSuite module. Set the IP adress of the machine running MiruSuite in the configuration.
3. MiruSuite is now connected and you can start adding buttons. Try starting with the preconfigured presets!

INFO

If MiruSuite and the Companion server are running on the same device you should use 127.0.0.1 as the IP address.

Usage

The MiruSuite Companion module offers different presets, actions, and feedbacks corresponding to the MiruSuite workflows.

You can find explanations for all presets in the following table:

Category	Preset name	Description
General	Toggle Director	Toggle the director on and off. Use this to enable/disable tracking!
General	Enable Director	Enable the director.
General	Disable Director	Disable the director.
General	Random Move	Move the camera in a random position. Requires an AutoMove director.
General	Preset Move	Move the camera to a random nearby presets. Requires an AutoMove director.
General	Stop Move	Stop any ongoing movement of that camera. Requires an AutoMove director.
General	Return Home	Return that camera to its home position. Requires a Controller.
Person Tracking	All/Manual/Single	Set the tracking mode for a given device's director (all, manual, single). Requires a head tracking director.
Person Tracking	Wide/Medium/Close	Set the target shot size of a given device's director (wide, medium, close). Requires a head tracking director.
Person Tracking	Exit Steady	Exit the steady mode of a given device's director. Requires a head tracking director.
Person Tracking	Learn Target Face	Learn the face of the current target person. Requires a person tracker.
Presets	Preset Name	Play a saved preset. When holding the button for at least one second the preset gets overwritten by the current position of the camera. Requires a controller.
Presets	Play active Preset	Move the camera back to it's last active preset. This is useful when using automatic movements to reset the camera to its needed position. When you press a button for more than one second, the preset is updated to the current camera position. Requires a controller.
AutoCut	⏻ AutoCut	Enables and disables AutoCut.
Auto Presets	Learn Auto Presets	This button has a meta-functionality: You can attach ("learn") different buttons to this button. Configure the target devices, click learn and then hit all Auto Preset buttons one after another that should be attached. They will show the corresponding ID after they get clicked. When you add/modify presets the buttons will be automatically populated accordingly so you don't need to setup buttons for every preset you create! When you press a button for more than one second, the preset is updated to the current camera position.
Auto Presets	Auto Preset	This button needs to be learned via the Learn Auto Presets button. When it's attached, MiruSuite automatically distributes the available presets over all Auto Preset buttons.
Auto Presets	Clear All Auto Buttons	Deletes all attached buttons.