Flux Product Docs
  • What is Flux?
  • Guides
    • Creating a Premium Video
    • Creating Your First Site
    • Creating a Countdown
    • Creating a Navigation Bar
    • Creating a Group
    • Custom 404 Page
    • Adding a Favicon to Your Site
    • Adding Videos to Your Site
    • Managing Your Guest List
    • Asset Management
    • Creating Sites from Site Templates
    • Publishing Site Versions
    • Advanced Debugging
  • Fundamentals
    • Key Concepts
    • Sites
    • Guests
    • Environments
      • Show Variables
    • Flows
      • Anatomy of a Node
      • Connecting Nodes and Building Flows
      • Passing Data
      • Scope
      • Interpolation
    • Keyboard Shortcuts
      • Keyboard Shortcuts - Page Editor
    • Animation States
    • Local Variables
    • Groups
  • Use Cases
    • For Designers
    • For Engineers
      • Custom CSS
      • Custom Modules
    • For Event Manager
      • Intercom Integration
  • Documentation
    • FAQ
    • Glossary
    • 🚀Show Controller
      • Modes
    • Domains and Subdomains
      • Hover
      • AWS Route 53
    • Premium Live Channels
    • Basic Video
    • Premium Video
      • AI Generated Subtitles
      • Supported Input Codecs and Containers
      • Supported Language Labels
      • Serverside Forensic Watermarking
    • Flow Nodes
      • Middleware
  • Modules
    • Access Code
    • Audio
    • Button
    • Carousel
    • Chat
    • Checkbox
    • Container
    • Countdown
    • Date
    • Embed
    • Image
    • Intercom
    • Link
    • Lottie
    • Page
    • Meter
    • Modal
    • Photobooth Gallery
    • Open Login
    • QR Code
    • Radio
    • Rich Text
    • Stack
    • Style
    • Spline
    • Switch
    • Text Input
    • Video
  • Template Guides
    • NatGeo FYC
      • Adding a Panel
    • Meow Wolf All Shrimps
  • 🚀Change Logs
    • July 12, 2024
    • June 08, 2024
    • April 26, 2024
    • April 12, 2024
    • March 29, 2024
    • March 15, 2024
    • March 1, 2024
    • September 2022
    • August 2022
    • July 2022
    • June 2022
Powered by GitBook
On this page
  • Overview
  • Audio Properties
  • Details (required)
  • Loops
  • Autoplay
  • Broadcasters
  • On Timestamp Update
  • On Complete
  • On Pause
  • On Play
  • On Start
  • On Unmute
  • On Mute
  • Listeners
  • Mute
  • Pause
  • Play
  • Unmute
  • Set Source

Was this helpful?

  1. Modules

Audio

Last updated 7 months ago

Was this helpful?

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

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

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

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


On Pause

Fires when audio playback has been paused.


On Play

Fires when audio playback has started or resumed.


On Start

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


On Unmute

Fires when audio playback volume has been unmuted.


On Mute

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


Listeners

Mute

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


Pause

When triggered, pauses audio playback.


Play

When triggered, starts audio playback.


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

Browser limitations
On Timestamp Update Broadcast Node
On Complete Broadcast Node
On Pause Broadcast Node
On Play Broadcast Node
On Start Broadcast Node
On Unmute Broadcast Node
On Mute Broadcast Node
Mute Listener Node
Pause Listener Node
Play Listener Node
Unmute Listener Node