AudioProvider
Defined in: src/audio-provider.ts:17
The audio backend a game supplies: play/stop clips, set per-channel volume,
retune an active playback (for spatial attenuation/pan), and dispose.
modules/audio ships a Web Audio implementation.
Properties
Section titled “Properties”dispose
Section titled “dispose”dispose: () =>
void
Defined in: src/audio-provider.ts:18
Returns
Section titled “Returns”void
play: (
clipId,options?) =>string
Defined in: src/audio-provider.ts:19
Parameters
Section titled “Parameters”clipId
Section titled “clipId”string
options?
Section titled “options?”Returns
Section titled “Returns”string
setPlaybackPan
Section titled “setPlaybackPan”setPlaybackPan: (
handle,value) =>void
Defined in: src/audio-provider.ts:21
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
setPlaybackVolume
Section titled “setPlaybackVolume”setPlaybackVolume: (
handle,value) =>void
Defined in: src/audio-provider.ts:23
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
setVolume
Section titled “setVolume”setVolume: (
channel,value) =>void
Defined in: src/audio-provider.ts:24
Parameters
Section titled “Parameters”channel
Section titled “channel”string
number
Returns
Section titled “Returns”void
stop: (
handle) =>void
Defined in: src/audio-provider.ts:25
Parameters
Section titled “Parameters”handle
Section titled “handle”string
Returns
Section titled “Returns”void