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

Play Audio Payload

Play a Media Library audio item through every running Overlay Builder browser source. This does not play desktop audio.

action.send_overlay_audio · 2.8.0

Browse all entries

Requirements and availability

Audio item in Media Library and running Overlay Builder browser source.

Picker contexts: automation, timer, command, pad.

Behavior

Resolve mediaId and require an audio library item. Play in running browser sources, not the desktop window. Volume is a saved percent 0–100, editor default 100.

Configure in the app

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

Steps

Choose action category Send to Overlay, select Play Audio 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
Audio `mediaId`	media_select The selected file plays automatically through running Overlay Builder browser sources.	Editor defaults: {"automation":null,"timer":null,"command":null,"pad":null} Media Types: audio	Supports variables
Volume (%) `volume`	number Saved on this command, automation, timer, or SheevPad action.	Declared UI default: `100` Editor defaults: {"automation":100,"timer":100,"command":100,"pad":100} Min: 0 Max: 100	Literal value / selected resource
No receiver widget or routing setup is required. This does not play through the SheevChat desktop window. `audioInfo`	info	Editor defaults: {"automation":null,"timer":null,"command":null,"pad":null}	Information only

Audio
mediaId

media_select

The selected file plays automatically through running Overlay Builder browser sources.

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

Media Types: audio

Supports variables

Volume (%)
volume

number

Saved on this command, automation, timer, or SheevPad action.

Declared UI default: 100

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

Min: 0

Max: 100

Literal value / selected resource

No receiver widget or routing setup is required. This does not play through the SheevChat desktop window.
audioInfo

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.

{
  "mediaId": "fixture-audio",
  "volume": 100
}

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_audio
public/index.html — getBuilderActionEntries / createDefaultAction

Source revision: 472fb34b484eeef0b663d28cacb628a7b9f14ff1