Repository navigation
Reference Triggers Stream Deck
Also on the Cuebot Docs site.
Runs when the Cuebot plugin in your Stream Deck program connects to Cuebot. Handy to set key titles and pictures when the Stream Deck starts.
Variables you get
| Variable | What it holds |
|---|---|
%instanceId% |
Which Stream Deck program connected (useful if you use more than one computer) |
%pluginVersion% |
The version of the Cuebot plugin in Stream Deck |
%streamDeckVersion% |
The version of the Stream Deck program |
%platform% |
The computer system it runs on, like "windows" or "mac" |
%deviceCount% |
How many Stream Decks are connected |
Type id: streamDeck.connected
Runs when Cuebot learns about the Stream Decks that are plugged in, when the plugin connects and whenever a Stream Deck is added or removed.
Variables you get
| Variable | What it holds |
|---|---|
%instanceId% |
Which Stream Deck program connected (useful if you use more than one computer) |
%pluginVersion% |
The version of the Cuebot plugin in Stream Deck |
%streamDeckVersion% |
The version of the Stream Deck program |
%platform% |
The computer system it runs on, like "windows" or "mac" |
%deviceCount% |
How many Stream Decks are connected |
%deviceNames% |
The names of the Stream Decks, separated by commas |
%device0.name% |
The name of the first Stream Deck (device1.name is the second, and so on) |
%device0.type% |
The model of the first Stream Deck |
Type id: streamDeck.info
Runs when the Stream Deck program stops talking to Cuebot, for example when you close it.
Variables you get
| Variable | What it holds |
|---|---|
%instanceId% |
Which Stream Deck program connected (useful if you use more than one computer) |
%pluginVersion% |
The version of the Cuebot plugin in Stream Deck |
%streamDeckVersion% |
The version of the Stream Deck program |
%platform% |
The computer system it runs on, like "windows" or "mac" |
%deviceCount% |
How many Stream Decks are connected |
Type id: streamDeck.disconnected
Runs when you press a key, turn a dial or tap the touch strip on a Stream Deck that has a Cuebot trigger on it. Great for turning Stream Deck keys into Cuebot buttons.
| Setting | What to put in |
|---|---|
| Button IDs | The button ID you typed on the key in Stream Deck, like "ShoutOut". Separate several with commas. Leave empty to react to every Cuebot key and dial. |
| Event | What the person did. Key down is pressing a key. Key up is letting go. Dial rotate is turning a dial. Any key or dial press covers a key press, a dial press and a touch tap. Options: Any, Key down, Key up, Dial rotate, Dial press, Dial release, Touch tap, Any key or dial press. Starts as: Key down. |
Variables you get
| Variable | What it holds |
|---|---|
%buttonId% |
The button ID of the key or dial |
%buttonEvent% |
What happened: keyDown, keyUp, dialRotate, dialDown, dialUp or touchTap |
%isDial% |
True when it was a dial, false for a normal key |
%ticks% |
How far the dial turned (minus means left); only for dial turns |
%pressed% |
Whether the dial was pushed in; only for dial events |
%deviceName% |
The name of the Stream Deck |
%row% |
The key's row on the Stream Deck |
%column% |
The key's column on the Stream Deck |
%state% |
Which of its two states the key is in, 0 or 1 |
Type id: streamDeck.action