Speak

Read more in Guide > Integrations > Speakerbot.

Parameters

Voice Aliasrequired

Text

The name of the voice alias to use.

Pass Through Bad Word Filter

Toggle

Toggle the bad word filter on or off.

Silent

Toggle

Play the TTS silently

Can be used with the delay option if you want to wait before the TTS is finished, but don't have the audio.

Delay

Toggle

Wait for TTS to complete before continuuing execution of the current action

Messagerequired

Text

The message content to send to Speaker.bot.

The following variables will be populated after executing this sub-action:

		Description
`duration`	`number`	The duration of the speech, when the delay option is used
`speechFile`	`string`	The file containing the speech audio, or `null` if it doesn't exist
`success`	`bool`	Was the request successful? `true`

		Description
`__source`	`EventType`	The event which triggered the action. This will not always exist and requires C# to access `TwitchChatMessage`
`actionId`	`string`	The unique ID of the action being executed `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`actionName`	`string`	The name of the action being executed `My Action`
`actionQueuedAt`	`DateTime`	The timestamp of when action was queued `12/21/2023 9:25:21 AM`
`eventSource`	`EventSource`	The service of the event which triggered the action. This will not always exist and requires C# to access `twitch`
`runningActionId`	`string`	The unique ID of this running action instance within the queue `c83dd939-9f86-4435-b07c-b6e7e3eef134`
`triggerCategory`	`string`	The category of the trigger which executed the action `Twitch/Chat`
`triggerId`	`string`	The unique id of the trigger with executed the action `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`triggerName`	`string`	The name of the trigger which executed the action `Chat Message`

Set Paused State

Toggle the state of the Speaker.bot TTS queue

Speak (UDP)

Send a message with text-to-speech (TTS) using Speaker.bot via UDP