Interface BackgroundAudioPlayerOptions

interface BackgroundAudioPlayerOptions {
    ambientSound?: AudioSourceType | AudioConfig | AudioConfig[];
    streamTimeoutMs?: number;
    thinkingSound?: AudioSourceType | AudioConfig | AudioConfig[];
}

Properties

Ambient sound to play continuously in the background. Can be a file path, BuiltinAudioClip, or AudioConfig. File paths will be looped automatically.

streamTimeoutMs?: number

Stream timeout in milliseconds for the audio mixer. Controls how long the mixer waits for a stream to produce data before timing out. Higher values are more tolerant of network latency and processing delays.

Default Value

2000

Sound to play when the agent is thinking. Plays when agent state changes to 'thinking' and stops when it changes to other states.