Speech sub-actions

Activate VoiceGate profile

Switches to another VoiceGate profile, or turns VoiceGate off. VoiceGate holds back new speech while your microphone hears you talking, so Cuebot does not talk over you.

Setting	What to put in
Profile	The name of a VoiceGate profile from the Speech page. Type none to turn VoiceGate off.

Variables it adds

Variable	What it holds
%success%	True if the profile was found and switched on

Type id: speech.activateVoiceGate

Clear speech queue

Throws away everything waiting to be read out loud. The text being read right now finishes. Good when chat spams.

Type id: speech.clearQueue

Pause or resume text-to-speech

Pauses or resumes reading out loud. Texts wait in line while paused. Handy for a quiet moment on stream. This is the text-to-speech line, not the action queues on the Queues page.

Setting	What to put in
Mode	Pause holds speech back. Resume lets it go on. Toggle switches to the opposite. Options: Pause, Resume, Toggle. Starts as: Pause.

Type id: speech.pause

Set event speech

Switches reading of events out loud (follows, subs, tips and so on) on or off. Chat reading is not changed.

Setting	What to put in
Mode	Enable turns it on. Disable turns it off. Toggle switches to the opposite. Options: Enable, Disable, Toggle. Starts as: Enable.

Type id: speech.setEvents

Set speech enabled

Switches all speech on or off. While off, Cuebot reads nothing out loud. Good for a "mute the bot" hotkey.

Setting	What to put in
Mode	Enable turns it on. Disable turns it off. Toggle switches to the opposite. Options: Enable, Disable, Toggle. Starts as: Enable.

Type id: speech.setEnabled

Set user voice

Gives one viewer their own voice, so their chat messages sound different when read out loud. Leave the voice empty to give them the normal one back.

Setting	What to put in
Platform	The site the viewer is on, like twitch. The default %platform% means whoever started the action. Starts as: %platform%.
User name	The viewer's chat name. The default %user% means whoever started the action. Starts as: %user%.
User id	Optional. The viewer's id on their site. If empty, the name is used. Starts as: %userId%.
Voice alias	The name of the voice to use (a "voice alias" from the Speech page). Empty = go back to the normal voice.

Type id: speech.setUserVoice

Set voice alias

Changes which voice is used for chat, for events, as the default, or for highlighted messages. Handy to switch voice for a funny part of the stream.

Setting	What to put in
Used for	Where the voice is used. Chat = viewer messages. Events = follows, subs and so on. Default = anything else. Highlight = highlighted messages. Options: Chat, Events, Default, Highlight. Starts as: Chat.
Voice alias	The name of the voice to use (a "voice alias" from the Speech page). Empty = go back to the normal setting.

Type id: speech.setAlias

Speak

Reads a text out loud with a text-to-speech voice. Good for reading a viewer's message or a tip message. It can also save the speech as a file without playing.

Setting	What to put in
Voice alias	The name of the voice to use (a "voice alias" from the Speech page). Empty = the default voice.
Text	What to say. You can use %variables%, like "%user% just followed".
Wait until spoken	Tick to wait until the speech is finished before the next step. Unticked, the next step starts right away. Starts as: false.
Silent (render to a file only)	Tick to only create the speech as an audio file without playing it out loud. Starts as: false.
Apply filters (bad words, links, length)	Tick to clean the text first: bad words, links and very long text are handled by your Speech page filters. Starts as: false.
Filter profile	Which set of filters to use, from the Speech page. Empty = the normal filters. Only used when filters are ticked.
Priority	Higher numbers are read first when several texts wait in line. 0 is normal. Starts as: 0.

Variables it adds

Variable	What it holds
%success%	True if the text was read (false if it was skipped, for example by a filter)
%speechFile%	Only after waiting or silent: the audio file that was made
%duration%	Only after waiting or silent: how long the speech takes, in milliseconds

Type id: speech.speak

Speak next in queue

Moves speech on by one text: stops the one being read, and if the queue is paused it lets exactly one waiting text start. Handy for stepping through a paused queue.

Variables it adds

Variable	What it holds
%success%	True if a text was stopped or started

Type id: speech.next

Stop current speech

Stops the text being read right now. The next text in line (if any) is read after it. Good as a "skip" button for long messages.

Type id: speech.skip

Stop user's speech

Removes one viewer's waiting messages from the speech line and stops theirs if it is being read right now. Good when someone spams.

Setting	What to put in
Platform	The site the viewer is on, like twitch. The default %platform% means whoever started the action. Starts as: %platform%.
User name	The viewer's chat name. The default %user% means whoever started the action. Starts as: %user%.
User id	The viewer's id on their site. The default %userId% means whoever started the action. Starts as: %userId%.

Variables it adds

Variable	What it holds
%stoppedCount%	How many of their messages were stopped

Type id: speech.stopUser