Chapter 17 of 21

Stream Deck

How to control TimerPRO with Elgato Stream Deck buttons or keyboard keys.

What it is for: Every Stream Deck button (or key) can run a program function: start, pause, add a minute, next lecture, message and many more. The operator does not need the mouse.
Who can use it: Operator; a Stream Deck connected to this computer — directly over USB (no Elgato app) or through the Elgato Stream Deck app with the TimerPRO plugin. FREE version — up to 5 Stream Deck shortcuts.
Where to find it: Stream Deck tab (shortcut F8).

1Connection method

1 USB direct (default) — TimerPRO drives the Stream Deck itself, without the Elgato app and without installing a plugin. Requires the Elgato Stream Deck app to be closed (only one program can use a Stream Deck at a time). No plugin needed.
2 Elgato plugin — as before: Requires the Elgato Stream Deck app and the TimerPRO plugin. Choose it when the Elgato app also controls other programs (OBS, vMix).
3 Status — Connected, No Stream Deck connected, Busy — the Elgato Stream Deck app is running or No access to the device. Plugging in and unplugging are detected automatically (every 2 s).
4 Device — model, number of buttons and grid (e.g. 15 = 5×3, XL 32 = 8×4, Mini 6 = 3×2). With several connected — device choice.
5 Button brightness.
6 Last pressed button — a quick check that the buttons work.
7 Try again — e.g. after closing the Elgato app.

Once connected, the Stream Deck immediately has three boards matched to the number of buttons (Mini 6, 8, 15, XL 32). The preview in the card shows the same images as the device.
1 Countdown on a button — the remaining time live, in the phase colours from Clock appearance (e.g. green → yellow → orange), after time is up +MM:SS in red. Press = start / pause.
2 Start / pause — the button shows the state (▶ start, ❚❚ pause). Next to it: reset.
3 Adjustments +1′ −1′ +5′ −5′ and 4 times 5–60 min.
5 Next board — the last button; its caption says which board comes next.
6 Arrows in the preview — browse the boards in the window (the device stays on its board).
7 Board bar — Rename, Add board, ← → (order), Delete board, Export / Import (a .json file, e.g. for another computer), Restore defaults. Without a connected device the bar starts with the layout choice (15 / 6 / 8 / 32 / 3 buttons).
Board Messages & screen: predefined messages 1–5 (text and colour from the message list), clear message, flashing, current time, progress bar, clock mode.
Board Timeline & agenda: start Timeline, Next (caption = title of the next lecture), reset Timeline, AUTO NEXT (ON / OFF), Agenda online (ON / OFF for the conference loaded into the Timeline), countdown and start / pause.

Click a button in the preview — the edit window opens. Changes are saved immediately and appear on the device right away.
1 Button preview — how it will look on the Stream Deck (updates live).
2 Function → Choose… — 3 search and 4 categories: all program functions (the same as in assignments) and the Stream Deck group: Countdown (live remaining time), Next lecture (Timeline), Agenda online on / off, Next board, Previous board.
5 Function parameters — e.g. message text, time, number of a predefined message.
6 Caption — your own caption; empty = automatic in the program language.
7 Icon — type a character or pick one from the palette (∅ = automatic).
8 Background and Text — your own colour or automatic.
9 Clear button — the button will be empty (black).

1 Server (WebSocket 8089) — the program server the plugin connects to.
2 Plugin installed — whether the TimerPRO plugin is in the Stream Deck app (and which version).
3 Plugin connected — whether the plugin is connected to the program now.
4 Install plugin — copies the plugin into the Stream Deck app; then restart the Stream Deck app.
5 Open plugin folder — the Stream Deck app plugins folder.
6 How it works — four steps from installation to the first button.
7 Refresh status.

1 Filter — all, Stream Deck only, keyboard only, function category.
2 Search assignments.
3 Assignment — button or key, function, title, parameters, state (two example keys in the screenshot).
4 Add, 5 Edit, 6 Clone.
7 Test — runs the function right away, without pressing the button.
8 Remove (next to it: remove selected).

1 Stream Deck button or Keyboard key.
2 Find — press the button on the Stream Deck (or the key), the program recognises it.
3 Function — choose from the list (search or categories).
4 Function categories.
5 Title — the label on the button and on the assignment list.
6 Save.

Used by the functions “Load Timer Preset 1-3”, “Save Current as Preset” and “Quick Save”.
1 Preset name and 2 time in HH:MM:SS format.
3 Save presets.

1 Search function….
2 Categories — the number next to each is the number of functions in it.
3 Function — name, category and action identifier (needed e.g. in Companion).
4 Functions documentation — description of all functions.

Next: Companion and API