Developer
Log in

Integrations

Integrations

Three first-party integrations, each built only on the public control API, and each driven by Studio's own catalog. They're also the best working examples of how to build your own.

Stream Deck Touch Portal Companion
What A plugin for Elgato Stream Deck A plug-in for Touch Portal A module for Bitfocus Companion
Runs on macOS 12+ and Windows 10+, Stream Deck 7.1 or later; Linux through OpenDeck Windows, macOS and Linux (Touch Portal Pro) Companion 5.0 and later
Built with Node.js, Stream Deck SDK v3 One small native program per platform Node 22, TypeScript, the TypeScript SDK
Finds Studio Discovery file Discovery file Discovery file, a typed port and token, or pairing
Live state On every key As Touch Portal states and events As feedbacks and variables
More Stream Deck Touch Portal Companion

What they have in common

  • Only the control API. None of them calls anything the API doesn't document. Whatever they do, your integration can do.
  • The catalog decides. Each carries the catalog it was built against, and reads Studio's own catalog.list when it connects, so the names, descriptions and parameters match Studio.
  • No token to copy. On the same computer they find Studio through its discovery file, and follow it when Studio restarts on another port or with a new token.
  • Pushed, never polled. Each subscribes to the topics it shows and redraws from Studio's pushes. Timers count on locally between pushes.
  • Ids, not names. Settings store ids chosen from pickers filled with live state, so a renamed scene keeps working.
  • Destructive actions are guarded. Ending a stream and clearing chat need a long press or an explicit "I'm sure". Banning and timing out people have no button on purpose: Studio's chat does them in context, on the right person.
  • Never stale. While Studio isn't connected, keys and buttons dim; they never show a last value as if it were current.

Building your own

Start with the quickstart and Events and reconnecting. For a control surface, three pages do most of the work:

  • The catalog: actions, parameter types for settings forms, and the live state rules that light a key without per-action code.
  • Destructive actions: what to guard, and how.
  • The reference: which controls suit each action (key, dial, display).

to open · ↑ ↓ to move · Esc to close