Audio Configuration

Multi-track audio support

Audio Configuration

The audio field defines audio sources including background music, voiceovers, and sound effects.

Field Definition

interface AudioConfig {
  tracks?: AudioTrack[];
  bgm?: {
    src: string;
    volume?: number;
    loop?: boolean;
    fadeIn?: number;
    fadeOut?: number;
  };
}

Example

{
  "audio": {
    "bgm": {
      "src": "https://example.com/ambient.mp3",
      "volume": 0.4,
      "fadeIn": 2,
      "fadeOut": 2
    },
    "tracks": [
      {
        "id": "voiceover",
        "type": "voice",
        "src": "https://example.com/voice.mp3",
        "volume": 1.0
      },
      {
        "id": "sfx",
        "type": "sfx",
        "src": "https://example.com/click.mp3",
        "volume": 0.5
      }
    ]
  }
}

Track Types

TypeDescription
bgmBackground music
voiceVoiceover or narration
sfxSound effects
customCustom audio track

Track Properties

FieldTypeRequiredDefaultDescription
idstringYes-Unique track identifier
typestringYes-Track type (bgm/voice/sfx/custom)
srcstringYes-Audio file URL
volumenumberNo1.0Volume level (0-1)
mutedbooleanNofalseMute the track
loopbooleanNofalseLoop the audio
startTimenumberNo0Start time in seconds
fadeInnumberNo0Fade in duration in seconds
fadeOutnumberNo0Fade out duration in seconds
playbackRatenumberNo1.0Playback speed multiplier
solobooleanNofalseSolo this track