Bitfocus Companion
ControlBitfocus Companion drives Stream Decks, X-keys, MIDI controllers and many other control surfaces. With the InterDirector module, its buttons can switch, put overlays on air, mute, start and stop outputs, run replay and press your hotkeys, and they light up with what is on Program and in Preview.
It needs InterDirector 1.21 or later, and Companion 4.3 or later.
Install the module
- Download the InterDirector module (version 0.1.24), or in InterDirector choose Help ▸ Get the Bitfocus Companion Module, which puts the module that came with your InterDirector in your Downloads folder and shows it.
- In Companion, open Modules, choose Import module package, and pick the file.
- Under Connections, add InterDirector.
The module is not in Companion’s own list of modules, so it is installed from this file. A newer version replaces it the same way.
Connect it
On the same Mac as InterDirector: choose To InterDirector on this Mac, and leave the host and port as they are. It connects whenever a Show is open, and needs no password.
From another machine (a Raspberry Pi, a PC, another Mac):
- In InterDirector, switch on the web remote in the Show’s Remote settings, with a password.
- In Companion, choose To InterDirector on another Mac, through its web remote, and enter the Mac’s address,
port
49722(or the one the Remote settings show), and that password.
The password never travels over the network. Companion appears in InterDirector’s list of connected remotes, where you can disconnect it. Its connection turns green once it is connected; if InterDirector is too old for the module, the connection says so.
What the buttons can do
- Switching: put an input or an overlay in Preview (CUT or FADE then puts an overlay up), take one straight to Program with a cut or a fade, or take Preview to Program with Cut, Fade 1, Fade 2 or Dip, at the lengths set beside those buttons or a Fade 1 of its own length; switch the Auto Director on or off.
- Overlays on, off, or either, and the Overlay button’s own: whatever is in Preview, up or down.
- Composite layers: show, hide, or either, any layer of any Composite, by name (“Stage · Cam 1”). Its sound is left as it is.
- Video FX: switch one of an input’s effects (black & white, noise reduction, blur, sharpen, vignette) on, off, or either, or one of Program’s own, offered first.
- Framing presets: frame a source, or one of a Composite’s layers, with one of your Show’s framing presets, chosen by name or by its number, gliding there over the time you set. Framing preset matches lights a button while it is framed so, and each preset has a section of presets, one button per source and layer.
- Camera presets: send an NDI camera to one of its presets, 1 to 9, at its fastest or at a speed you set. Its section of presets has a button for each.
- Framing a camera: set an NDI camera’s zoom over a glide time, send it to a position or home, or nudge it for a moment. For InterDirector Cam: set its zoom, over a glide time if you want one, step it in or out, or choose a lens.
- Camera PTZ: pan and tilt an NDI camera (eight ways), zoom it in or out, or send it home, at the speed you set. Put the move on a button’s press and Stop on its release, and the camera moves while the button is held; each camera’s PTZ section of presets is set up that way already. If Companion disconnects while a button is held, InterDirector stops the camera.
- Sound: mute, unmute, or either; Follow Program on or off; solo a source, or clear every solo; set a source’s level, or Master’s or any bus’s, by its name. A split source’s strips are offered after it for mute, solo and level, each on its own.
- Media and images: play, pause, restart, next, previous or a chosen item, and reshuffle. Reload a web page, an overlay or a folder. The zoom/position animation on or off, for one source or every one.
- Outputs: start or stop streaming, Program recording, input recording, NDI and the external output; turn one stream destination on or off; mark a cut in the recording.
- Replay: capture a clip, play the selected clip, stop, select the next or previous, delete one; play the selected bucket, every bucket (as Play All), or one by name; select a bucket, the next or the previous, or clear one.
- Data sources: next, previous or a chosen row, the row with a key, or read it now.
- Fade to Black, and any of your hotkeys, for anything else your Show’s hotkeys do.
Each list offers only the inputs the action means something for, by name. A button keeps working when an input is renamed.
Stopping an output, turning a stream destination off while streaming, deleting a replay clip or clearing a bucket with clips asks first on the Mac, as it does from a Stream Deck. Tick Without asking on a button when nobody will be at the Mac to answer.
Tally and names
Buttons can light when an input is on Program (red) or in Preview (green) — an overlay too, and any input a button of your own names — when an overlay is on air, an input is muted or follows Program, an output or a stream destination is on, the Auto Director is running, the zoom and position animations are on, a Composite’s layer is visible, an input’s Video FX is on, a replay is playing or a bucket is selected, Program is faded to black, or a hotkey is on. A button can also take its hotkey’s own colour from InterDirector, bright while it is on and dimmed while it is off, as a Stream Deck key shows it.
For a button of your own that names an input, add the feedback Input’s tally: it does everything at once, red while the input is on Program or on air, green while it is in Preview, and the input’s label colour the rest of the time. The ready-made input buttons use it.
$(interdirector:program) and $(interdirector:preview) show the names of the inputs on Program and in Preview,
and $(interdirector:show) the Show’s.
A button’s text from InterDirector. Every input and every hotkey has a variable holding its name: in a button’s
text field, type $(interdirector: and pick Input name: … or Hotkey name: … from the list. The button then shows
the name as InterDirector has it, and follows a rename. The ready-made input and hotkey buttons already do this.
Presets
Companion’s Presets tab offers ready-made buttons. Drag them onto a page.
- Inputs to Preview: one per input, putting it in Preview, lit with its tally.
- Inputs to Program: one per input, cutting it straight to Program, lit with its tally. To fade instead, change the button’s action to Fade once it is on a page.
- Switching: CUT, FADE 1, FADE 2, DIP, OVERLAY, AUTO, ANIMATE and FTB.
- Overlays: one per overlay, green while it waits in Preview and red while it is on air.
- Composite layers: one per layer of every Composite, showing or hiding it, lit while it is visible.
- Video FX: one section per effect, with a button for Program and for each input that switches it, lit while it is on.
- Media and reload: PLAY, PAUSE, PREV and NEXT for each media and image playlist, and RELOAD for each page, overlay or folder, lit with its input’s tally.
- Sound: a mute and a solo per source with sound, and per strip of a split source, lit while muted or soloed, with CLEAR SOLO. These keep their own colours rather than the tally, so a muted input reads as muted on air.
- Outputs: STREAM, REC, IN REC, NDI and EXT, lit while running, and MARK.
- Replay, when the Show has a replay input: CAPTURE, PLAY CLIP, PREV CLIP, NEXT CLIP, DELETE LAST, PREV BUCKET, NEXT BUCKET, PLAY BUCKET, PLAY ALL, STOP REPLAY, and one per bucket, lit while it is selected.
- Hotkeys: one per hotkey, lit while it is on, and in its own colour, including a colour you give it later.
A button keeps what it was dragged with. Input buttons dragged from module 0.1.15 or later follow every later improvement to their tally where they are; one dragged from an earlier module needs dragging once more to get it.
In the journal
Each press is a line in the journal: “Companion: Cut to Program · Cam 1” from this Mac, or “Web remote (Bitfocus Companion): …” from another machine.