Classes
Methods
createBus(name, configopt) → {AudioBus}
Create or retrieve an audio bus.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name | string | ||||||||||||||||||||||
config | Object | <optional> | Properties
|
- Source
Returns:
- Type:
- AudioBus
exportPreferences() → {Object}
Export user audio preferences separately from game progress saves.
- Source
Returns:
- Type:
- Object
getBus(name) → {AudioBus}
Get audio bus by name. Throws if missing.
Parameters:
| Name | Type | Description |
|---|---|---|
name | string |
- Source
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:
| Name | Type | Description |
|---|---|---|
name | string |
- Source
Returns:
- Type:
- number
importPreferences(prefs)
Import user audio preferences. Can be called before audio unlock or scene loading.
Parameters:
| Name | Type | Description |
|---|---|---|
prefs | Object |
- Source
isMuted(name) → {boolean}
Check if a bus is muted directly or via any parent.
Parameters:
| Name | Type | Description |
|---|---|---|
name | string |
- Source
Returns:
- Type:
- boolean
onBusChanged(listener) → {function}
Add change listener.
Parameters:
| Name | Type | Description |
|---|---|---|
listener | function |
- Source
Returns:
Unsubscribe
- Type:
- function
setMuted(name, muted)
Set mute state for a bus.
Parameters:
| Name | Type | Description |
|---|---|---|
name | string | |
muted | boolean |
- Source
setVolume(name, volume)
Set volume for a bus, clamped strictly between 0 and 1. Throws if volume is not a finite number.
Parameters:
| Name | Type | Description |
|---|---|---|
name | string | |
volume | number |
- Source
toggleMute(name) → {boolean}
Toggle mute state for a bus.
Parameters:
| Name | Type | Description |
|---|---|---|
name | string |
- Source
Returns:
New mute state
- Type:
- boolean