AudioSystemOptions
Defined in: src/modules/audio/audio-system.ts:57
Options for makeAudioSystem: the provider, an optional one-shot queue and sourceDef, spatial getListener/spatialDefaults, plus name/runAfter/onError.
Type Parameters
Section titled “Type Parameters”TCtx extends AudioTickCtx = AudioTickCtx
Properties
Section titled “Properties”getListener?
Section titled “getListener?”
optionalgetListener?: (ctx) =>AudioListener|undefined
Defined in: src/modules/audio/audio-system.ts:66
Listener position for spatial sources; sources with a spatial field are attenuated/panned relative to it. Return undefined to leave spatial sources at base volume.
Parameters
Section titled “Parameters”TCtx
Returns
Section titled “Returns”AudioListener | undefined
optionalname?:string
Defined in: src/modules/audio/audio-system.ts:58
onError?
Section titled “onError?”
optionalonError?: (error) =>void
Defined in: src/modules/audio/audio-system.ts:67
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
provider
Section titled “provider”provider:
AudioProvider
Defined in: src/modules/audio/audio-system.ts:59
queue?
Section titled “queue?”
optionalqueue?:AudioQueue
Defined in: src/modules/audio/audio-system.ts:60
runAfter?
Section titled “runAfter?”
optionalrunAfter?:string[]
Defined in: src/modules/audio/audio-system.ts:61
sourceDef?
Section titled “sourceDef?”
optionalsourceDef?:ComponentDef<AudioSource>
Defined in: src/modules/audio/audio-system.ts:62
spatialDefaults?
Section titled “spatialDefaults?”
optionalspatialDefaults?:SpatialDefaults
Defined in: src/modules/audio/audio-system.ts:64
Falloff defaults for spatial sources that omit their own. Web Audio defaults: refDistance 1, maxDistance 10000, rolloff 1.