Audio

Overview

The Audio module provides a way for a content author to embed a sound effect or background audio in the page. The sounds embedded with the Audio module must, unless they autoplay, be played via the flow controller nodes.

Audio Properties

Details (required)

Asset, defaults to a whooshing sound effect

Allows the selection of an audio file from the asset manager this is the asset that will be played by the module.

Loops

Checkbox, default disabled

If enabled, shows the audio will loop back to the beginning after it reaches the end of the audio.

Autoplay

Checkbox, default disabled

If enabled, attempts to play the audio immediate when the module loads

Browser limitations may block autoplay when a user first visits your page. A play button will appear if autoplay is blocked, requiring the user to click to begin playback. For a workaround, see Force Autoplay.

Broadcasters

On Timestamp Update Broadcast Node

On Timestamp Update

Fires when the audio playback advances to a new timestamp.

Output	Description	Type
timestamp	The current timestamp of the audio in seconds	number
duration	The total duration of the audio file in seconds	number

---

On Complete Broadcast Node

On Complete

Fires when the audio has played through to the end. Does not trigger for looping audio.

---

On Pause Broadcast Node

On Pause

Fires when audio playback has been paused.

---

On Play Broadcast Node

On Play

Fires when audio playback has started or resumed.

---

On Start Broadcast Node

On Start

Fires when audio playback starts. Does not fire when a paused audio file is resumed.

---

On Unmute Broadcast Node

On Unmute

Fires when audio playback volume has been unmuted.

---

On Mute Broadcast Node

On Mute

Fires when the audio playback volume has been set to zero.

---

Listeners

Mute Listener Node

Mute

When triggered, sets the audio playback volume to the zero.

---

Pause Listener Node

Pause

When triggered, pauses audio playback.

---

Play Listener Node

Play

When triggered, starts audio playback.

---

Unmute Listener Node

Unmute

When triggered, sets the audio playback volume to the previous level.

---

Set Source

When triggered, sets the current source of the audio module to the specified URL.

Input	Description	Type
Source URL	The URL of the source audio file.	string