Skip to main content

Interface: SpatialAudioOptions

Defined in: src/audio/spatialAudioTypes.ts:106

Options for constructing a SpatialAudio.

Properties​

context?​

optional context: SpatialAudioContextLike

Defined in: src/audio/spatialAudioTypes.ts:108

Pre-built context to use (dependency injection / testing).


distanceModel?​

optional distanceModel: DistanceModelType

Defined in: src/audio/spatialAudioTypes.ts:114

Distance-attenuation algorithm. Defaults to 'inverse'.


maxDistance?​

optional maxDistance: number

Defined in: src/audio/spatialAudioTypes.ts:118

Maximum distance for attenuation. Defaults to 10000.


panningModel?​

optional panningModel: PanningModelType

Defined in: src/audio/spatialAudioTypes.ts:112

Spatialization algorithm. Defaults to 'HRTF'.


position?​

optional position: [number, number, number]

Defined in: src/audio/spatialAudioTypes.ts:122

Initial position of the sound. Defaults to the origin.


refDistance?​

optional refDistance: number

Defined in: src/audio/spatialAudioTypes.ts:116

Reference distance for attenuation. Defaults to 1.


rolloffFactor?​

optional rolloffFactor: number

Defined in: src/audio/spatialAudioTypes.ts:120

Rolloff factor. Defaults to 1.


source?​

optional source: PositionalSource

Defined in: src/audio/spatialAudioTypes.ts:110

Transport source to drive from play / pause / stop.