AudioBusSystem

Hierarchical audio bus mixer managing master, music, sfx, and UI channels with composed gain calculation, volume clamping, and preference persistence.

Constructor

new AudioBusSystem()

Classes

AudioBusSystem

Methods

createBus(name, configopt) → {AudioBus}

Create or retrieve an audio bus.

Parameters:
NameTypeAttributesDescription
namestring
configObject<optional>
Properties
NameTypeAttributesDefaultDescription
parentstring | AudioBus<optional>
"master"
volumenumber<optional>
1.0
mutedboolean<optional>
false
Returns:
Type: 
AudioBus

exportPreferences() → {Object}

Export user audio preferences separately from game progress saves.

Returns:
Type: 
Object

getBus(name) → {AudioBus}

Get audio bus by name. Throws if missing.

Parameters:
NameTypeDescription
namestring
Returns:
Type: 
AudioBus

getEffectiveVolume(name) → {number}

Get composed effective volume for a bus. If the bus or any of its parents is muted, returns 0.0.

Parameters:
NameTypeDescription
namestring
Returns:
Type: 
number

importPreferences(prefs)

Import user audio preferences. Can be called before audio unlock or scene loading.

Parameters:
NameTypeDescription
prefsObject

isMuted(name) → {boolean}

Check if a bus is muted directly or via any parent.

Parameters:
NameTypeDescription
namestring
Returns:
Type: 
boolean

onBusChanged(listener) → {function}

Add change listener.

Parameters:
NameTypeDescription
listenerfunction
Returns:

Unsubscribe

Type: 
function

setMuted(name, muted)

Set mute state for a bus.

Parameters:
NameTypeDescription
namestring
mutedboolean

setVolume(name, volume)

Set volume for a bus, clamped strictly between 0 and 1. Throws if volume is not a finite number.

Parameters:
NameTypeDescription
namestring
volumenumber

toggleMute(name) → {boolean}

Toggle mute state for a bus.

Parameters:
NameTypeDescription
namestring
Returns:

New mute state

Type: 
boolean