Reference Script Functions Lumia

Lumia Stream 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.

lumia.chatbotMessage

Sends a chat message through Lumia Stream's chat bot. Fails with an error when Lumia Stream is not connected.

Value	In Python	What to put in
message	message	What to say, like "The lights are now purple!" Needed.
platform	platform	Optional. Where to send it: "twitch", "youtube", "facebook", "kick", "discord" or "all". Default "twitch".
asSelf	as_self	Optional. true sends it as your own account instead of the bot. Default false.

Gives back: true when Lumia Stream accepted it.

C#

var answer = await Cb.Call("lumia.chatbotMessage", new { message = "The lights are now purple!" });

Python

answer = cb.lumia_chatbot_message(message="The lights are now purple!")

lumia.connect

Starts connecting to Lumia Stream. It does not wait: Cuebot keeps trying in the background until it works.

Gives back: true once connecting has started (not when it is connected).

C#

var answer = await Cb.Call("lumia.connect");

Python

answer = cb.lumia_connect()

lumia.disconnect

Disconnects Cuebot from Lumia Stream.

Gives back: true when done.

C#

var answer = await Cb.Call("lumia.disconnect");

Python

answer = cb.lumia_disconnect()

lumia.getInfo

Tells you what your Lumia Stream offers: its commands, alerts, lights and voices. Cuebot reads this when it connects.

Gives back: commands (names by kind), alerts, lights (each with id, name, type), voices and states (on, streamMode, fuze; or null).

C#

var answer = await Cb.Call("lumia.getInfo");

Python

answer = cb.lumia_get_info()

lumia.getVariable

Reads one of your Lumia Stream variables. Fails with an error when Lumia Stream is not connected.

Value	In Python	What to put in
name	name	The variable's name in Lumia Stream, like "deaths". Needed.

Gives back: The variable's value as text (empty when Lumia sends nothing).

C#

var answer = await Cb.Call("lumia.getVariable", new { name = "deaths" });

Python

answer = cb.lumia_get_variable(name="deaths")

lumia.isConnected

Checks whether Cuebot is connected to Lumia Stream right now.

Gives back: true while connected, otherwise false.

C#

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

Python

answer = cb.lumia_is_connected()

lumia.send

Sends any request to Lumia Stream's Send API. For advanced users who know Lumia's request types.

Value	In Python	What to put in
type	type	The request type, like "studio-scene". Needed.
params	params	Optional. The request's settings as an object, like {"value": "Sunset"}.

Gives back: Lumia Stream's reply message, or null when it sends none.

C#

var answer = await Cb.Call("lumia.send", new Dictionary<string, object?> { ["type"] = "studio-scene", ["params"] = new { value = "Sunset" } });

Python

answer = cb.lumia_send(type="studio-scene", params={"value": "Sunset"})

lumia.sendAlert

Fakes a Lumia Stream alert, like a follow, so its light show plays. Fails with an error when Lumia Stream is not connected.

Value	In Python	What to put in
alert	alert	The alert's name in Lumia Stream, like "twitch-follower". Needed.
extraSettings	extra_settings	Optional. Extra values for the alert, like {"username": "CoolViewer"}.

Gives back: true when Lumia Stream accepted it.

C#

var answer = await Cb.Call("lumia.sendAlert", new { alert = "twitch-follower", extraSettings = new { username = "CoolViewer" } });

Python

answer = cb.lumia_send_alert(alert="twitch-follower", extra_settings={"username": "CoolViewer"})

lumia.sendCommand

Runs one of your Lumia Stream commands, like a light scene. Fails with an error when Lumia Stream is not connected or says no.

Value	In Python	What to put in
command	command	The command's name as set in Lumia Stream, like "party". Needed.
type	type	Optional. The kind of command: "chat-command", "chatbot-command", "twitch-points", "twitch-extension" or "kick-points". Default "chat-command".
hold	hold	Optional. true keeps the lights this way afterwards instead of going back. Default false.
skipQueue	skip_queue	Optional. true runs it right away instead of waiting in Lumia's queue. Default false.
extraSettings	extra_settings	Optional. Extra values for the command, like {"username": "CoolViewer"}.

Gives back: true when Lumia Stream accepted it.

C#

var answer = await Cb.Call("lumia.sendCommand", new { command = "party" });

Python

answer = cb.lumia_send_command(command="party")

lumia.setColor

Changes the colour of your Lumia Stream lights. Fails with an error when Lumia Stream is not connected.

Value	In Python	What to put in
color	color	The colour as "#RRGGBB", like "#FF4076", or "r,g,b", like "255,64,118". Needed.
brightness	brightness	Optional. How bright, 0-100.
transition	transition	Optional. How long the colour fades in, in milliseconds.
duration	duration	Optional. How long the colour stays, in milliseconds.
lights	lights	Optional. Which lights, by name or id, split with commas, like "Hue go, hue:19". Leave it out for all lights.
hold	hold	Optional. true keeps this colour afterwards instead of going back. Default false.
skipQueue	skip_queue	Optional. true does it right away instead of waiting in Lumia's queue. Default false.

Gives back: true when Lumia Stream accepted it.

C#

var answer = await Cb.Call("lumia.setColor", new { color = "#9146FF", brightness = 80 });

Python

answer = cb.lumia_set_color(color="#9146FF", brightness=80)

lumia.setToDefault

Puts your Lumia Stream lights back to their default look.

Gives back: true when Lumia Stream accepted it.

C#

var answer = await Cb.Call("lumia.setToDefault");

Python

answer = cb.lumia_set_to_default()

lumia.setVariable

Changes one of your Lumia Stream variables. Fails with an error when Lumia Stream is not connected.

Value	In Python	What to put in
name	name	The variable's name in Lumia Stream, like "deaths". Needed.
value	value	The new value: text, a number, true/false or an object. Counters also take "+1", "-1" or "=5".

Gives back: true when Lumia Stream accepted it.

C#

var answer = await Cb.Call("lumia.setVariable", new { name = "deaths", value = "+1" });

Python

answer = cb.lumia_set_variable(name="deaths", value="+1")

lumia.tts

Says text out loud with Lumia Stream's text-to-speech. Fails with an error when Lumia Stream is not connected.

Value	In Python	What to put in
message	message	What to say, like "Welcome to the stream!" Needed.
voice	voice	Optional. The Lumia voice name. Leave it out for Lumia's default voice.
volume	volume	Optional. How loud, 0-100.

Gives back: true when Lumia Stream accepted it.

C#

var answer = await Cb.Call("lumia.tts", new { message = "Welcome to the stream!" });

Python

answer = cb.lumia_tts(message="Welcome to the stream!")