Indicates the type of sound played by an audio clip. Set audioClipType value in the clipType field of the loadAudioClip command, or read it from clipType in an audioClipStatus event.
clipType is optional on loadAudioClip. When you omit it and do not provide a streamUrl, Sonos plays the default CHIME sound. When you provide a streamUrl, Sonos plays your custom audio.
Applies to playback devices that expose the AUDIO_CLIP capability.
Currently, CHIME is the only built-in firmware sound.
| Value | Valid as input to loadAudioClip | Description |
|---|---|---|
CHIME | Yes(default input) | Built-in Sonos chime sound. Used as the default when clipType is omitted from loadAudioClip |
CUSTOM | No - output only | Appears in audioClipStatus events to indicate that the clip is playing a caller-supplied streamUrl. Do not send CUSTOM as input, providing a streamUrl in loadAudioClip implies a custom clip |
VOICE_ASSISTANT | No - output only | Custom-specific for Sonos. Not for external use. Using VOICE_ASSISTANT will result in an error response. Appears in audioClipStatus events when a voice assistant is speaking on the player. |
File type support:
Sonos supports MP3 and WAV files.
Handling clipType in events:
When you subscribe to the audioClip namespace, incoming audioClipStatus events report the clipType of each active clip. Your integration should be prepared to receive any of the three values, including VOICE_ASSISTANT, so it can react appropriately (for example, deferring its own clips while a voice assistant is speaking).
Handling clipType in loadAudioClip :
clipType is optional in loadAudioClip. When you omit it and do not provide a streamUrl, Sonos plays the default CHIME sound. When you provide a streamUrl, Sonos plays your custom audio.