Speech triggers¶

Speech finished¶

Runs when Cuebot has finished reading a text out loud, or when it was skipped. Good for hiding a talking avatar again.

Setting	What to put in
Voice alias	The name of a voice (a "voice alias" from the Speech page). Empty means any voice.

Variables you get

Variable	What it holds
`%text%`	The text that was read
`%alias%`	The voice name that was used
`%user%`	The viewer whose message was read (empty for your own speech)
`%duration%`	How long the speech took, in milliseconds
`%skipped%`	True if it was skipped and not read

Type id: speech.finished

Runs when Cuebot starts reading a text out loud with its text-to-speech voice. Good for lighting up a talking avatar or showing who is being read.

Setting	What to put in
Voice alias	The name of a voice (a "voice alias" from the Speech page). Empty means any voice.

Variables you get

Variable	What it holds
`%text%`	The text being read
`%alias%`	The voice name being used
`%user%`	The viewer whose message is being read (empty for your own speech)
`%source%`	Where the text came from, like chat or an action

Type id: speech.started

Runs when speech is switched on or off, paused or resumed, or a VoiceGate profile changes. Good for showing a "speech paused" light on your stream.

Variables you get

Variable	What it holds
`%enabled%`	True if speech is switched on
`%paused%`	True if the speech queue is paused
`%eventsEnabled%`	True if event speech (reading follows, subs and so on) is on

Type id: speech.stateChanged