Skip to content

🔊 Audio System

StorySplat allows you to enhance your scenes with audio, triggered primarily through Waypoint interactions and Custom 3D Model interactions. You can add background music, narration, sound effects, or ambient sounds to create more immersive experiences.

Audio for Hotspots: * Currently, dedicated audio interactions (like adding a separate sound file to play when a standard Sphere or Image hotspot is clicked) are not directly supported. This feature is planned for future updates! * If you create a Video Hotspot (using the Video Plane type), the audio track embedded within the video file itself will play according to the video's Media Trigger Mode (Autoplay, Click, Proximity, Scroll). * Current Limitation: The volume and playback controls for this embedded video audio are not yet customizable within StorySplat and will use default browser behavior. Full control over video audio parameters is planned for the future.

Adding Audio (Waypoints & Custom Models)

Audio is configured as an Interaction attached to either a Waypoint or a Custom 3D Model.

  1. Open Editor: Access either the Waypoint Controls panel (📍 icon) or the 3D Models panel (🧊 icon).
  2. Select Element: Select the specific Waypoint or Custom 3D Model you want to add audio to.
  3. Edit Interactions:
    • For Waypoints: Click the "Edit Interactions" button.
    • For Custom Models: Expand the "Interaction Settings" section.
  4. Add Audio Interaction:
    • For Waypoints: Select "🔊 Audio Interaction" from the dropdown and click "Add Interaction".
    • For Custom Models: Check the "Play/Stop Audio" checkbox.
  5. Configure Audio: The audio settings panel will appear.

Audio Configuration Options (Waypoints & Custom Models)

These settings apply to audio files linked or uploaded via the Waypoint/Custom Model interaction panels, not to audio embedded within Video Hotspots.

  • Audio URL:
    • Enter the direct URL to your audio file (.mp3, .ogg, .wav recommended).
    • Must be publicly accessible or CORS-enabled. Use CORS Proxy setting (⚙️ Settings Menu) if needed.
  • Upload Audio File:
    • (Recommended) Click the "Upload Audio File" button (☁️ icon) to upload from your computer.
    • Stored in cloud storage (counts towards quota). URL auto-populates.
    • Shows current filename and upload progress.
  • Enable Spatial Sound: (Checkbox)
    • Checked (3D Sound): Audio source is positioned at the element's location. Volume/panning changes with distance/orientation. Requires Spatial Sound Settings configuration.
    • Unchecked (2D Sound / Stereo): Plays at constant volume regardless of camera position. Spatial settings ignored.
  • Volume: (Slider) Adjusts playback volume (0% to 100%) of the linked/uploaded audio.
  • Stop Sound When Leaving Waypoint: (Waypoint Audio Only - Checkbox) If checked, linked/uploaded sound stops when leaving the waypoint's Trigger Distance. If unchecked, it plays until finished or stopped otherwise. Does not apply to spatial sounds.
  • Play on page load (Autoplay): (Waypoint Audio Only - Checkbox) If checked, linked/uploaded audio attempts to play on scene load after user interaction.
  • Loop Audio: (Checkbox) If checked, linked/uploaded audio loops continuously.

Spatial Sound Settings (Only when "Enable Spatial Sound" is checked)

Controls the 3D behavior of linked/uploaded audio.

  • Reference Distance (Min Distance): (Slider) Distance for full volume. Attenuation starts beyond this. (Default: 1)
  • Maximum Distance: (Slider) Max distance the sound can be heard. (Default: 100)
  • Rolloff Factor: (Slider) How quickly volume decreases with distance. Higher = faster drop-off. (Default: 1)
  • Distance Model: (Dropdown) Attenuation formula: Exponential (Default), Linear, Inverse.

Custom Model Audio Trigger Mode

  • (Dropdown: Click/Hover) (Custom Models Only) Determines if linked/uploaded audio plays/stops on model Click or Hover.

How Audio Plays

  • Waypoint Audio (Linked/Uploaded): Triggered by Trigger Distance. Behavior set by Stop on Exit, Loop, Autoplay.
  • Custom Model Audio (Linked/Uploaded): Triggered by Audio Trigger Mode (Click/Hover). Click toggles; Hover plays/stops.
  • Video Hotspot Audio (Embedded): Plays with the video based on the Video Hotspot's Media Trigger Mode (Autoplay, Click, Proximity, Scroll). Volume/controls currently use browser defaults.
  • Spatial Audio Listener: Always attached to the active camera for correct 3D positioning.
  • Autoplay Restrictions: Browsers require user interaction (like a click) before any audio can play automatically. Use "Show Start Experience Button" export option or ensure interaction happens first.

Best Practices

  • File Formats & Size: Use web-friendly, compressed formats (.mp3, .ogg). Keep sizes reasonable.
  • Spatial vs. Non-Spatial: Use spatial for diegetic sounds, non-spatial for background music/narration.
  • Trigger Distance (Waypoints): Fine-tune for desired timing.
  • Video Audio: Mix audio levels appropriately in your video editor before uploading video files, as in-app controls are currently limited.
  • Testing: Thoroughly test triggers, spatial effects, and video playback.

Previous: Analytics | Next: Export Settings Deep Dive