PlatformAudioBackend
Defined in: audio/PlatformAudioBackend.ts:71
Properties
Section titled “Properties”delivery
Section titled “delivery”
readonlydelivery:AudioDelivery
Defined in: audio/PlatformAudioBackend.ts:76
See AudioDelivery.
isReady
Section titled “isReady”
readonlyisReady:boolean
Defined in: audio/PlatformAudioBackend.ts:74
readonlymixer:AudioMixer|null
Defined in: audio/PlatformAudioBackend.ts:73
readonlyname:string
Defined in: audio/PlatformAudioBackend.ts:72
Methods
Section titled “Methods”dispose()
Section titled “dispose()”dispose():
void
Defined in: audio/PlatformAudioBackend.ts:89
Returns
Section titled “Returns”void
ensureResumed()
Section titled “ensureResumed()”ensureResumed():
Promise<void>
Defined in: audio/PlatformAudioBackend.ts:78
Returns
Section titled “Returns”Promise<void>
getFrequencyData()?
Section titled “getFrequencyData()?”
optionalgetFrequencyData(out):boolean
Defined in: audio/PlatformAudioBackend.ts:93
Fill out with the master output’s frequency magnitudes (0-255 per bin,
low→high), returning true. Optional: backends without analysis (e.g.
WeChat) omit it, and callers treat a missing method as silence.
Parameters
Section titled “Parameters”Uint8Array
Returns
Section titled “Returns”boolean
initialize()
Section titled “initialize()”initialize(
options?):Promise<void>
Defined in: audio/PlatformAudioBackend.ts:77
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<void>
invalidateSource()?
Section titled “invalidateSource()?”
optionalinvalidateSource(src):void
Defined in: audio/PlatformAudioBackend.ts:85
Forget source-address reuse after an authored clip changes.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
loadBuffer()
Section titled “loadBuffer()”loadBuffer(
src,options?):Promise<AudioBufferHandle>
Defined in: audio/PlatformAudioBackend.ts:80
Parameters
Section titled “Parameters”string
a RESOLVED source the host can fetch — never a cache key.
options?
Section titled “options?”AudioLoadOptions
Returns
Section titled “Returns”Promise<AudioBufferHandle>
loadBufferFromData()
Section titled “loadBufferFromData()”loadBufferFromData(
src,data,options?):Promise<AudioBufferHandle>
Defined in: audio/PlatformAudioBackend.ts:82
Parameters
Section titled “Parameters”string
as loadBuffer; bytes backends use data and ignore it.
ArrayBuffer
options?
Section titled “options?”AudioLoadOptions
Returns
Section titled “Returns”Promise<AudioBufferHandle>
play()
Section titled “play()”play(
buffer,config):AudioHandle
Defined in: audio/PlatformAudioBackend.ts:86
Parameters
Section titled “Parameters”buffer
Section titled “buffer”config
Section titled “config”Returns
Section titled “Returns”resume()
Section titled “resume()”resume():
void
Defined in: audio/PlatformAudioBackend.ts:88
Returns
Section titled “Returns”void
suspend()
Section titled “suspend()”suspend():
void
Defined in: audio/PlatformAudioBackend.ts:87
Returns
Section titled “Returns”void
unloadBuffer()
Section titled “unloadBuffer()”unloadBuffer(
handle):void
Defined in: audio/PlatformAudioBackend.ts:83
Parameters
Section titled “Parameters”handle
Section titled “handle”Returns
Section titled “Returns”void