Stream Deck script functions¶

Functions for C# (Cb.Call) and Python (cb.call). See Script functions for how to use them.

streamdeck.getInstances¶

Lists the Stream Deck apps that are connected to Cuebot, with their devices and Cuebot keys.

Gives back: A list of apps. Each has id, remote, pluginVersion, streamDeckVersion, platform, connectedAt, devices (name, type, size) and buttons (buttonId, row, column, state and more).

C#Python

var answer = await Cb.Call("streamdeck.getInstances");

answer = cb.call("streamdeck.getInstances")

streamdeck.isConnected¶

Checks whether the Cuebot plugin in the Stream Deck app is connected right now.

Gives back: true while at least one Stream Deck plugin is connected, otherwise false.

C#Python

var answer = await Cb.Call("streamdeck.isConnected");

answer = cb.call("streamdeck.isConnected")

streamdeck.setBackground¶

Changes the picture on a Stream Deck key. Leave the image empty to put the normal picture back.

Value	What to put in
`buttonId`	The button id you gave the key in the Cuebot Stream Deck plugin. Needed.
`image`	A picture file on your computer, a web link (http or https) or a data: link. Empty puts the normal picture back.
`state`	Optional. Which state of a two-state key to change: 0 or 1. Leave it out for the state it shows now.

Gives back: How many keys have this button id (0 when none was found).

C#Python

var answer = await Cb.Call("streamdeck.setBackground", new { buttonId = "scene", image = "C:\\Stream\\live.png" });

answer = cb.call("streamdeck.setBackground", buttonId="scene", image="C:\\Stream\\live.png")

streamdeck.setState¶

Switches a two-state Stream Deck key to state 0 or 1.

Value	What to put in
`buttonId`	The button id you gave the key in the Cuebot Stream Deck plugin. Needed.
`state`	Optional. 0 or 1. Default 0.

Gives back: How many keys have this button id (0 when none was found).

C#Python

var answer = await Cb.Call("streamdeck.setState", new { buttonId = "mic", state = 1 });

answer = cb.call("streamdeck.setState", buttonId="mic", state=1)

streamdeck.setTitle¶

Changes the text shown on a Stream Deck key.

Value	What to put in
`buttonId`	The button id you gave the key in the Cuebot Stream Deck plugin, like "deaths". Needed.
`title`	The text to show, like "Deaths: 3".
`state`	Optional. Which state of a two-state key to change: 0 or 1. Leave it out for the state it shows now.

Gives back: How many keys have this button id (0 when none was found).

C#Python

var answer = await Cb.Call("streamdeck.setTitle", new { buttonId = "deaths", title = "Deaths: 3" });

answer = cb.call("streamdeck.setTitle", buttonId="deaths", title="Deaths: 3")

streamdeck.setValue¶

Changes the value shown on a Stream Deck key or dial (Stream Deck +).

Value	What to put in
`buttonId`	The button id you gave the key or dial in the Cuebot Stream Deck plugin. Needed.
`value`	The value to show, like "75%".
`indicator`	Optional. For dials: how full the bar is, 0-100.

Gives back: How many keys have this button id (0 when none was found).

C#Python

var answer = await Cb.Call("streamdeck.setValue", new { buttonId = "volume", value = "75%", indicator = 75 });

answer = cb.call("streamdeck.setValue", buttonId="volume", value="75%", indicator=75)

streamdeck.showAlert¶

Flashes the warning sign on a Stream Deck key for a moment.

Value	What to put in
`buttonId`	The button id you gave the key in the Cuebot Stream Deck plugin. Needed.

Gives back: How many keys have this button id (0 when none was found).

C#Python

var answer = await Cb.Call("streamdeck.showAlert", new { buttonId = "scene" });

answer = cb.call("streamdeck.showAlert", buttonId="scene")

streamdeck.showOk¶

Flashes the check mark on a Stream Deck key for a moment.

Value	What to put in
`buttonId`	The button id you gave the key in the Cuebot Stream Deck plugin. Needed.

Gives back: How many keys have this button id (0 when none was found).

C#Python

var answer = await Cb.Call("streamdeck.showOk", new { buttonId = "scene" });

answer = cb.call("streamdeck.showOk", buttonId="scene")

streamdeck.toggleState¶

Flips a two-state Stream Deck key to its other state.

Value	What to put in
`buttonId`	The button id you gave the key in the Cuebot Stream Deck plugin. Needed.

Gives back: How many keys have this button id (0 when none was found).

C#Python

var answer = await Cb.Call("streamdeck.toggleState", new { buttonId = "mic" });

answer = cb.call("streamdeck.toggleState", buttonId="mic")