Skip to content

Audio

Plays WAV files from a configured audio directory.

Module id: audio. Player component: audio.player.main.

NATS endpoints

Command Request Description
audio.player.<id>.play text, text/plain Plays the WAV file the body names, out of the module's audio directory; the reply comes once playback ended, and a second request waits for the first.

The request is the WAV basename only (alarm.wav); the reply is "ok" after playback, which blocks for up to the timeout (default 5 min). Errors: 404 missing file, 400 invalid name. Typically fired from a trigger command action. Details: Messaging.