AudioManager
Defined in: audio/src/AudioManager.ts:18
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AudioManager(
sound,config?,random?):AudioManager
Defined in: audio/src/AudioManager.ts:27
Parameters
Section titled “Parameters”SoundLibrary
config?
Section titled “config?”random?
Section titled “random?”RandomService
Returns
Section titled “Returns”AudioManager
Accessors
Section titled “Accessors”autoMuteOnBlur
Section titled “autoMuteOnBlur”Get Signature
Section titled “Get Signature”get autoMuteOnBlur():
boolean
Defined in: audio/src/AudioManager.ts:241
Pause audio when the window loses focus or the tab is hidden. Default: true.
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set autoMuteOnBlur(
value):void
Defined in: audio/src/AudioManager.ts:245
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Methods
Section titled “Methods”_handleGesture()
Section titled “_handleGesture()”_handleGesture():
void
Defined in: audio/src/AudioManager.ts:263
Internal
Called by AudioPlugin after a user gesture fires. Fires pending
onUnlock listeners if the context has become running.
Returns
Section titled “Returns”void
getChannelVolume()
Section titled “getChannelVolume()”getChannelVolume(
channel):number
Defined in: audio/src/AudioManager.ts:154
Parameters
Section titled “Parameters”channel
Section titled “channel”string
Returns
Section titled “Returns”number
isUnlocked()
Section titled “isUnlocked()”isUnlocked():
boolean
Defined in: audio/src/AudioManager.ts:208
Whether the underlying AudioContext is running (i.e. audio will play).
Browsers suspend the context on page load until a user gesture; this is
purely a browser-level capability check and is not affected by
autoMuteOnBlur.
Returns
Section titled “Returns”boolean
muteAll()
Section titled “muteAll()”muteAll():
void
Defined in: audio/src/AudioManager.ts:190
Returns
Section titled “Returns”void
muteChannel()
Section titled “muteChannel()”muteChannel(
channel):void
Defined in: audio/src/AudioManager.ts:158
Parameters
Section titled “Parameters”channel
Section titled “channel”string
Returns
Section titled “Returns”void
offUnlock()
Section titled “offUnlock()”offUnlock(
cb):void
Defined in: audio/src/AudioManager.ts:235
Remove a listener registered with onUnlock.
Parameters
Section titled “Parameters”() => void
Returns
Section titled “Returns”void
onUnlock()
Section titled “onUnlock()”onUnlock(
cb): () =>void
Defined in: audio/src/AudioManager.ts:218
Fires cb once when audio becomes playable. If already unlocked, fires
synchronously. Returns a disposer that removes the pending listener (no-op
once it has fired).
Parameters
Section titled “Parameters”() => void
Returns
Section titled “Returns”() => void
pauseChannel()
Section titled “pauseChannel()”pauseChannel(
channel):void
Defined in: audio/src/AudioManager.ts:174
Parameters
Section titled “Parameters”channel
Section titled “channel”string
Returns
Section titled “Returns”void
play()
Section titled “play()”play(
alias,options?):SoundHandle
Defined in: audio/src/AudioManager.ts:54
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”playOnce()
Section titled “playOnce()”playOnce(
alias,options?):SoundHandle
Defined in: audio/src/AudioManager.ts:100
Play a sound only if it isn’t already playing (via a prior playOnce call).
Returns the existing handle if still playing, or a new one otherwise.
Note: only deduplicates against handles created by playOnce, not play.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”playRandom()
Section titled “playRandom()”playRandom(
aliases,options?):SoundHandle
Defined in: audio/src/AudioManager.ts:120
Parameters
Section titled “Parameters”aliases
Section titled “aliases”string[]
options?
Section titled “options?”Returns
Section titled “Returns”resumeChannel()
Section titled “resumeChannel()”resumeChannel(
channel):void
Defined in: audio/src/AudioManager.ts:182
Parameters
Section titled “Parameters”channel
Section titled “channel”string
Returns
Section titled “Returns”void
setChannelVolume()
Section titled “setChannelVolume()”setChannelVolume(
channel,volume):void
Defined in: audio/src/AudioManager.ts:146
Parameters
Section titled “Parameters”channel
Section titled “channel”string
volume
Section titled “volume”number
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop(
handle):void
Defined in: audio/src/AudioManager.ts:128
Parameters
Section titled “Parameters”handle
Section titled “handle”Returns
Section titled “Returns”void
stopAll()
Section titled “stopAll()”stopAll():
void
Defined in: audio/src/AudioManager.ts:140
Returns
Section titled “Returns”void
stopChannel()
Section titled “stopChannel()”stopChannel(
channel):void
Defined in: audio/src/AudioManager.ts:132
Parameters
Section titled “Parameters”channel
Section titled “channel”string
Returns
Section titled “Returns”void
unmuteAll()
Section titled “unmuteAll()”unmuteAll():
void
Defined in: audio/src/AudioManager.ts:196
Returns
Section titled “Returns”void
unmuteChannel()
Section titled “unmuteChannel()”unmuteChannel(
channel):void
Defined in: audio/src/AudioManager.ts:166
Parameters
Section titled “Parameters”channel
Section titled “channel”string
Returns
Section titled “Returns”void