Chapter 18 of 21
Companion and API
How to control TimerPRO from Bitfocus Companion or your own software.
- What it is for
- Bitfocus Companion runs Stream Decks and other controllers in video productions. TimerPRO gives it shortcuts and button states; any program on the local network can use the same interface (API).
- Who can use it
- Video operator / integrator; Companion on the same computer or the same network. Companion — PRO feature.
- Where to find it
- Companion tab (shortcut F9).
1Server and Companion setup
- 1 WebSocket (8089) and 2 HTTP API (8090) — program server state.
- 3 Connected clients — how many programs are connected now (e.g. Companion, the Stream Deck plugin).
- 4 Start server / Stop server — the server starts by itself with the program when automatic start is on (below).
- 5 Bitfocus Companion setup — four steps: install Companion, a Generic HTTP connection with the address http://localhost:8090, import the configuration, live state over WebSocket.
- 6 Download Companion config — a file to import into Companion.
- 7 Note in the program — HTTP commands (POST /api/command) are disabled for now; control works over WebSocket or the Stream Deck plugin.
2Shortcuts
- 1 Category — shortcut filter.
- 2 Add shortcut.
- 3 Import and 4 Export — the shortcut set to and from a file.
- 5 Reset — the default shortcut set.
- 6 Shortcut — button colour and label, name, action; Edit, test and delete.
3New shortcut
- 1 Shortcut name.
- 2 Category and 3 Target (e.g. the main timer).
- 4 Action — what the button does.
- 5 Button text (up to 8 characters) and 6 colour — button preview next to it.
4Control API
- 1 Tabs — Commands, HTTP endpoints, Examples.
- 2 WebSocket commands — JSON with action, target, data fields, e.g. { "action": "START", "target": "main" }.
Next: NDI