Lumia Stream sub-actions¶

Chat bot message¶

Sends a message in chat through Lumia Stream's chat bot.

Setting	What to put in
Message	The text to send.
Platform	Which chat to send it to, or all for every chat Lumia is connected to. Options: twitch, youtube, facebook, kick, discord, all. Starts as: `twitch`.
Send as the streamer	Tick to send it as you instead of as the bot. Starts as: `false`.

Type id: lumia.chatbotMessage

Reads one of Lumia Stream's variables and saves its value in a variable of yours.

Setting	What to put in
Variable	The Lumia variable to read, like "twitch_username".
Save in variable	The name of your variable that will hold the answer. Use it later as %name%. Starts as: `lumia.variableValue`.

Variables it adds

Variable	What it holds
`%lumia.variableValue%`	The value read from Lumia (or whatever name you chose in the box above)

Type id: lumia.getVariable

Sends a raw request to Lumia Stream for things the other steps cannot do. For advanced users who know Lumia's request types.

Setting	What to put in
Type	The kind of request, as Lumia names it, like "studio-scene" or "clear-queue".
Params (JSON)	The details of the request, written like {"value":"Sunset"}. Leave empty if it needs none.
Save the reply in variable	The name of your variable that will hold Lumia's reply. Starts as: `lumia.response`.

Variables it adds

Variable	What it holds
`%lumia.response%`	Lumia's reply (or whatever name you chose in the box above)

Type id: lumia.send

Makes Lumia Stream show one of its alerts, as if it had really happened. Good for a light show on your own events.

Setting	What to put in
Alert	The alert's name, like "twitch-follower" or "twitch-bits".
Extra settings	Extra details for Lumia, one per line as name=value, like username=%user%. Lumia can use them in its own texts as {{name}}.

Type id: lumia.sendAlert

Tells Lumia Stream to run one of your commands, such as a light show. Handy for stream events.

Setting	What to put in
Command	The command's name, as you set it up in Lumia Stream.
Command type	Where the command comes from in Lumia, like a chat command or a channel point reward. Options: chat-command, chatbot-command, twitch-points, twitch-extension, kick-points. Starts as: `chat-command`.
Keep this look afterwards	Tick to keep this look until you change it, instead of going back to normal afterwards. Starts as: `false`.
Skip queue	Tick to run right now instead of waiting behind other commands and colours. Starts as: `false`.
Extra settings	Extra details for Lumia, one per line as name=value, like username=%user%. Lumia can use them in its own texts as {{name}}.

Type id: lumia.sendCommand

Changes your Lumia Stream lights to a colour. Good for a quick flash when something happens.

Setting	What to put in
Colour	The colour as #RRGGBB, like #FF0000 for red, or as three numbers like "255,0,0". Starts as: `#FF4076`.
Brightness (0-100)	How bright, from 0 to 100. Leave empty to use Lumia's usual setting (100).
Duration (ms)	How long the colour stays, in milliseconds (1000 is one second). Leave empty to use Lumia's usual (4000).
Transition (ms)	How long the fade into the colour takes, in milliseconds. Leave empty to use Lumia's usual (0, instant).
Reset to default instead	Tick to put the lights back to normal instead. All other colour settings are ignored. Starts as: `false`.
Lights	Only change these lights: type their names separated by commas. Leave empty for all your lights.
Keep this look afterwards	Tick to keep this look until you change it, instead of going back to normal afterwards. Starts as: `false`.
Skip queue	Tick to run right now instead of waiting behind other commands and colours. Starts as: `false`.

Type id: lumia.setColor

Turns Lumia Stream on or off, or flips it to the other state.

Setting	What to put in
State	On turns it on, Off turns it off, Toggle flips whatever it is now. Options: On, Off, Toggle. Starts as: `Toggle`.

Type id: lumia.setLumiaState

Turns Lumia Stream's stream mode on or off, or flips it.

Setting	What to put in
State	On turns it on, Off turns it off, Toggle flips whatever it is now. Options: On, Off, Toggle. Starts as: `Toggle`.

Type id: lumia.setStreamMode

Puts your Lumia Stream lights back to their normal look.

Type id: lumia.setToDefault

Sets one of Lumia Stream's variables to a value you choose.

Setting	What to put in
Variable	The name of the Lumia variable to set.
Value	The value to put in it.

Type id: lumia.setVariable

Makes Lumia Stream read a message out loud.

Setting	What to put in
Message	The text to read out.
Voice	The voice to use. Leave empty for Lumia's normal voice.
Volume (0-100)	How loud, from 0 to 100. Only works on Windows. Leave empty for the normal volume.

Type id: lumia.tts