WebAudioProvider
Defined in: src/modules/audio/web-audio-provider.ts:72
An AudioProvider backed by the browser’s Web Audio API: clips are
pre-decoded AudioBuffers (supplied up front or resolved on demand), routed
through per-channel gain nodes into a master gain. The constructor throws when
no AudioContext is available (e.g. server-side) unless one is passed in.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WebAudioProvider(
options?):WebAudioProvider
Defined in: src/modules/audio/web-audio-provider.ts:83
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”WebAudioProvider
Methods
Section titled “Methods”dispose()
Section titled “dispose()”dispose():
void
Defined in: src/modules/audio/web-audio-provider.ts:105
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”play()
Section titled “play()”play(
clipId,options?):string
Defined in: src/modules/audio/web-audio-provider.ts:137
Parameters
Section titled “Parameters”clipId
Section titled “clipId”string
options?
Section titled “options?”AudioPlayOptions = {}
Returns
Section titled “Returns”string
Implementation of
Section titled “Implementation of”setPlaybackPan()
Section titled “setPlaybackPan()”setPlaybackPan(
handle,value):void
Defined in: src/modules/audio/web-audio-provider.ts:180
Set the stereo pan of one active playback, in [-1, 1]. Unknown handles are ignored.
Parameters
Section titled “Parameters”handle
Section titled “handle”string
number
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”setPlaybackVolume()
Section titled “setPlaybackVolume()”setPlaybackVolume(
handle,value):void
Defined in: src/modules/audio/web-audio-provider.ts:187
Set the volume of one active playback, in [0, 1]. Unknown handles are ignored.
Parameters
Section titled “Parameters”handle
Section titled “handle”string
number
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”AudioProvider.setPlaybackVolume
setVolume()
Section titled “setVolume()”setVolume(
channel,value):void
Defined in: src/modules/audio/web-audio-provider.ts:194
Parameters
Section titled “Parameters”channel
Section titled “channel”string
number
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”stop()
Section titled “stop()”stop(
handle):void
Defined in: src/modules/audio/web-audio-provider.ts:200
Parameters
Section titled “Parameters”handle
Section titled “handle”string
Returns
Section titled “Returns”void