Reference Script Functions Remote

Remote instances script functions

Also on the Cuebot Docs site.

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

remote.getInstances

Lists the other Cuebot computers set up on the Remote page, and the ones connected to you, with their status.

Gives back: A list. Each item has name, outgoing (true when you connect to it), state (like "Connected"), message, instanceId, instanceName, instanceOs, instanceVersion and connectedAt.

C#

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

Python

answer = cb.remote_get_instances()

remote.sendSignal

Sends a named signal to another Cuebot computer, so an action there can react to it. Fails when the name is empty.

Value	In Python	What to put in
name	name	The signal name, like "sceneChanged".
instance	instance	Optional. Which computer to send to (its name or id). Leave it out for every connected one.
args	args	Optional. Extra values to send along, as an object, like { "scene": "Gameplay" }.

Gives back: How many computers got the signal (0 when none are connected).

C#

var answer = await Cb.Call("remote.sendSignal", new { name = "sceneChanged", args = new { scene = "Gameplay" } });

Python

answer = cb.remote_send_signal(name="sceneChanged", args={"scene": "Gameplay"})

remote.waitForSignal

Waits until another Cuebot computer sends a signal with this name. Only signals that arrive after you start waiting count.

Value	In Python	What to put in
name	name	The signal name to wait for, like "ready".
instance	instance	Optional. Only accept it from this computer (its name or id). Leave it out for any computer.
timeoutMs	timeout_ms	Optional. How long to wait, in milliseconds. Leave it out for 30000 (30 seconds); 0 waits forever.

Gives back: The signal with name, sender (the action that sent it), instanceId, instanceName, instanceLabel, instanceOs, instanceVersion and args. null when time ran out.

C#

var answer = await Cb.Call("remote.waitForSignal", new { name = "ready", timeoutMs = 10000 });

Python

answer = cb.remote_wait_for_signal(name="ready", timeout_ms=10000)