Beta reference. Prepared from development builds for this version. This reference does not describe the current stable release.

A verified stable reference is not available yet. Choose a prepared beta version above.

Do · Actions · supported

Send TTS/Text Payload

Speak text through every running Overlay Builder browser source. This does not play desktop TTS audio.

action.send_overlay_tts · 2.8.0

Browse all entries

Requirements and availability

Running Overlay Builder browser source and configured supported TTS voice.

Picker contexts: automation, timer, command, pad.

Behavior

Resolve text; blank does nothing. Speak through running Overlay Builder browser sources, not desktop TTS. Global voice is used unless a supported piper: or kokoro: override is selected.

Configure in the app

Open: Do → Advanced Actions (commands only) → Add action

Steps

Choose action category Send to Overlay, select Send TTS/Text Payload, and click Add action.
Expand the action card. Configure the Fields below; check Editor defaults for your context and any operation-dependent fields.
Choose resource values from real app pickers. Set output Platform separately from the trigger Where setting when the action offers it.
Use Move action up / Move action down to position this action, then save the containing command, automation, timer or SheevPad button.

Limitations

Picker availability does not supply missing event variables. Check prerequisites and originating provider.
An action return value is not automatically a sequence variable. Only documented producers create template outputs.

Fields

Field Input / options Defaults / limits Availability

Field	Input / options	Defaults / limits	Availability
Text `text`	textarea	Editor defaults: {"automation":null,"timer":null,"command":null,"pad":null} Example hint: {user} redeemed {reward}: {message}	Supports variables
TTS voice `ttsVoice`	tts_voice_select Use global keeps the TTS voice selected in Settings > Audio. Piper/Kokoro overrides generate OBS/browser-source audio with that voice.	Declared UI default: Editor defaults: {"automation":"","timer":"","command":"","pad":""}	Literal value / selected resource
Plays automatically through all running Overlay Builder browser sources. No receiver widget or routing setup is required. `overlayAudioInfo`	info	Editor defaults: {"automation":null,"timer":null,"command":null,"pad":null}	Information only

Text
text

textarea

Editor defaults: {"automation":null,"timer":null,"command":null,"pad":null}

Example hint: {user} redeemed {reward}: {message}

Supports variables

TTS voice
ttsVoice

tts_voice_select

Use global keeps the TTS voice selected in Settings > Audio. Piper/Kokoro overrides generate OBS/browser-source audio with that voice.

Declared UI default:

Editor defaults: {"automation":"","timer":"","command":"","pad":""}

Literal value / selected resource

Plays automatically through all running Overlay Builder browser sources. No receiver widget or routing setup is required.
overlayAudioInfo

info

Editor defaults: {"automation":null,"timer":null,"command":null,"pad":null}

Information only

Contract details

Declared Contexts: [ "timer", "automation", "command", "pad" ]
Picker Contexts: [ "automation", "timer", "command", "pad" ]
Hidden From Picker: false
Required Variables: []
Failure Behavior: See the behavior for local skips/errors and context entries for sequence continuation.
Outputs: []

Examples

Illustrative configuration; replace fixture resources in the editor. This is not an import file.

{
  "text": "Welcome {user}!",
  "ttsVoice": ""
}

Related entries

Source and verification

Source-reviewed for 2.8.0. Connected-service validation remains subject to release UAT.

src/features/automations.js — ACTION_REGISTRY.send_overlay_tts
public/index.html — getBuilderActionEntries / createDefaultAction

Source revision: 472fb34b484eeef0b663d28cacb628a7b9f14ff1