Skip to main content

Full guide · topic 12 of 13

Control from Companion and Stream Deck

Control ZO-Donations from a Stream Deck via Bitfocus Companion.

ZO-Donations includes a module for Bitfocus Companion, for control from a Stream Deck or any control surface that works with Companion.

Setup

  1. In ZO-Donations: General settings → "External control – Companion / Stream Deck" → check it. External control is off until you check it.
  2. The screen shows the computer's address, the port and a control code.
  3. In Companion: Connections → "ZO-Donations" → enter Host, Port and Control code.

"New code" in ZO-Donations cancels the previous code right away. After 10 wrong codes within 5 minutes, the controlling computer is blocked for 5 minutes.

What you can do

  • LED screen scene, freeze, starting the engine, graphics or text only on the canvas.
  • NDI output: canvas, combined or separate sources.
  • Stop intake, rehearsal mode, blank screen, hide the total or the donor.
  • The announcement queue: NEXT and SKIP CUE. Skipping an announcement doesn't delete a donation.
  • Take over and hand back with two computers. These actions are protected: press twice within 3 seconds.

The variables (total, count, last donor, goal, percent and more) are available for buttons. Each preset has a short description in Companion.

Switching the canvas on air

For an event with several canvases, the canvas command in the Control API switches the canvas on air: by number ({"n":2}), by ID ({"id":"c2"}), or next and previous ({"op":"next"}, {"op":"prev"}). The sender doesn't stop, just as when you switch from the dashboard.

The Companion module doesn't have a ready-made button for this command yet. Until it does, send it as an HTTP request, for example with the Generic HTTP connection in Companion: POST to http://<computer address>:<port>/?zo_ctl=canvas, with the X-ZO-Control header set to the control code, and a JSON body as in the examples. A canvas that doesn't exist returns a no_canvas error.

Companion shows text left to right, so Hebrew on buttons may appear reversed. The presets use short English labels.

חנות התוכנה שלנו: Coral Cue Pro · Coral StageTimer · תקנון רכישה · לחנות
אולפני קורל בע״מ · סמטת קדש 7, גני תקווה · טל׳ 050-3333788 · info@zoom-out.co.il