Reference Sub actions Stream Deck

Stream Deck sub-actions

Also on the Cuebot Docs site.

Set key picture

Changes the picture on a Stream Deck key. Handy to show an icon that tells whether something is on.

Setting	What to put in
Button ID	The button ID of the key, as shown in the key's settings in Stream Deck and on the Stream Deck page, like "ShoutOut". Keys with the same ID change together. You can use %variables%, like %buttonId%.
Image	A picture file on your computer (PNG, JPEG, GIF, SVG, WebP or BMP, up to 2 MB), a web link starting with http, or a data: link. Leave empty to bring back the key's own picture.
State	Which of the key's two looks to change. Current changes the one showing now; 0 is the first and 1 the second. Options: Current, 0, 1. Starts as: Current.

Variables it adds

Variable	What it holds
%streamDeckButtons%	How many keys on screen were changed

Type id: streamDeck.setBackground

Set key value

Shows a value, like a number or a name, on a key or on a dial's touch strip. Good for live counters.

Setting	What to put in
Button ID	The button ID of the key, as shown in the key's settings in Stream Deck and on the Stream Deck page, like "ShoutOut". Keys with the same ID change together. You can use %variables%, like %buttonId%.
Value	The text to show: on a key it replaces the title, on a dial it shows on the touch strip. You can use %variables%.
Indicator (dials)	For dials only: how full the dial's bar is, from 0 to 100. Leave empty to leave the bar alone.

Variables it adds

Variable	What it holds
%streamDeckButtons%	How many keys on screen were changed

Type id: streamDeck.setValue

Set State

Sets a two-state key to its first or second look, for example an 'on' and an 'off' picture.

Setting	What to put in
Button ID	The button ID of the key, as shown in the key's settings in Stream Deck and on the Stream Deck page, like "ShoutOut". Keys with the same ID change together. You can use %variables%, like %buttonId%.
State	0 is the first look and 1 is the second look. Options: 0, 1. Starts as: 0.

Variables it adds

Variable	What it holds
%streamDeckButtons%	How many keys on screen were changed

Type id: streamDeck.setState

Set Title

Changes the text written on a Stream Deck key.

Setting	What to put in
Button ID	The button ID of the key, as shown in the key's settings in Stream Deck and on the Stream Deck page, like "ShoutOut". Keys with the same ID change together. You can use %variables%, like %buttonId%.
Title	The words to show on the key. You can use %variables%. Leave empty to bring back the key's own text.
State	Which of the key's two looks to change. Current changes the one showing now; 0 is the first and 1 the second. Options: Current, 0, 1. Starts as: Current.

Variables it adds

Variable	What it holds
%streamDeckButtons%	How many keys on screen were changed

Type id: streamDeck.setTitle

Show Alert

Makes a key flash a warning sign for a moment, to show that something went wrong.

Setting	What to put in
Button ID	The button ID of the key, as shown in the key's settings in Stream Deck and on the Stream Deck page, like "ShoutOut". Keys with the same ID change together. You can use %variables%, like %buttonId%.

Variables it adds

Variable	What it holds
%streamDeckButtons%	How many keys on screen were changed

Type id: streamDeck.showAlert

Show Ok

Makes a key flash a check mark for a moment, to show that something worked.

Setting	What to put in
Button ID	The button ID of the key, as shown in the key's settings in Stream Deck and on the Stream Deck page, like "ShoutOut". Keys with the same ID change together. You can use %variables%, like %buttonId%.

Variables it adds

Variable	What it holds
%streamDeckButtons%	How many keys on screen were changed

Type id: streamDeck.showOk

Toggle State

Flips a two-state key to its other look: from the first to the second, or back.

Setting	What to put in
Button ID	The button ID of the key, as shown in the key's settings in Stream Deck and on the Stream Deck page, like "ShoutOut". Keys with the same ID change together. You can use %variables%, like %buttonId%.

Variables it adds

Variable	What it holds
%streamDeckButtons%	How many keys on screen were changed

Type id: streamDeck.toggleState