Velum Studio
All guides

Guides › Make it yours

Stream Deck, Touch Portal and Companion

Control Studio from buttons, tablets and other apps.

Velum Studio can be controlled from Stream Deck, Touch Portal and Bitfocus Companion, and from your own scripts. Each switches scenes, mutes and mixes audio, records, saves replays and screenshots, goes live, and more, and shows what's happening in Studio on its buttons as it happens.

The plugins for Stream Deck, Touch Portal and Companion will be linked here when they're published.

Studio's side

Open the gear › Appearance… › Remote control….

  • Let apps on this computer control Studio is on to start with. That's all the plugins on this computer need: they find Studio by themselves, with nothing to type.
  • Port and Token are there for apps that ask for them. New token… makes a new one; apps using the old one are disconnected until they read the new one.
  • Allow devices on my network is off to start with. Turn it on to control Studio from another computer or a tablet. Every device has to pair first: Pair a device… shows a QR code and a one-time code, good for five minutes. The connection is encrypted. Paired devices are listed under Paired devices, where Remove stops one at once.

Stream Deck

  • Needs Stream Deck 7.1 or later, on macOS 12 or later or Windows 10 or later.
  • Double-click the plugin file (.streamDeckPlugin). Stream Deck installs it, and Velum Studio appears in the actions list.
  • Start Velum Studio. Keys connect by themselves; there's no token to copy.
  • Each key's settings start with a Studio picker. Active follows the Velum Studio that's running; if you run more than one, pick it by name.
  • Keys come in two styles, under Key style: Velum and Classic gold.

Touch Portal

  • Needs Touch Portal with the Pro upgrade (Touch Portal needs it for any plug-in), on the same computer as Velum Studio: Windows 10 or 11, macOS 13 or later, or Linux.
  • In Touch Portal, open the gear and choose Import plug-in, then pick the .tpp file for your computer. Allow it when Touch Portal asks.
  • Start Velum Studio. Velum Studio appears in the action list, under Streaming.
  • Scenes, sources and effects are lists filled from Studio, so you pick rather than type. Every value is a Touch Portal state: a scene button can light up while its scene is on air, and sliders and dials move both ways.

Bitfocus Companion

  • Needs Companion 5.0 or later. The module is called velum-studio.
  • Add a connection and choose how it finds Studio: This computer (found by itself), Typed in (a port and token), or Another computer (the pairing link from Studio's QR code).
  • Presets are built from what you have in Studio now. End stream and Clear chat need their I'm sure option and a two-second hold, so a tap never ends your stream.

Your own apps and scripts

Studio's control API is a WebSocket on this computer, with a token. Apps find it, and the token, in a discovery file in Studio's settings folder. The developer documentation covers it in full, with SDKs for C#, TypeScript and Python.