Class SpatialAudio

Position-based audio panning and volume falloff.

Usage:

const spatial = new SpatialAudio(scene, { maxDistance: 500 });
spatial.setListener(player);
spatial.play('explosion', { x: 300, y: 200 });

Index

Constructors

Methods

compute getListener play setConfig setListener

Constructors

constructor

new SpatialAudio(scene: Scene, config?: SpatialAudioConfig): SpatialAudio
Parameters
- scene: Scene
- Optionalconfig: SpatialAudioConfig
Returns SpatialAudio
- Defined in packages/clik-engine/src/audio/SpatialAudio.ts:33

Methods

compute

compute(
position: PositionLike,
overrideConfig?: Partial<SpatialAudioConfig>,
): { pan: number; volume: number }
Compute volume and pan for a position relative to the listener
Parameters
- position: PositionLike
- OptionaloverrideConfig: Partial<SpatialAudioConfig>
Returns { pan: number; volume: number }
- Defined in packages/clik-engine/src/audio/SpatialAudio.ts:62

getListener

getListener(): PositionLike | null
Get current listener

Returns PositionLike | null
- Defined in packages/clik-engine/src/audio/SpatialAudio.ts:85

play

play(
    key: string,
    position: PositionLike,
    overrideConfig?: Partial<SpatialAudioConfig>,
): void
Play a sound at a world position with spatial falloff
Parameters
- key: string
- position: PositionLike
- OptionaloverrideConfig: Partial<SpatialAudioConfig>
Returns void
- Defined in packages/clik-engine/src/audio/SpatialAudio.ts:49

setConfig

setConfig(config: Partial<SpatialAudioConfig>): this
Update config
Parameters
- config: Partial<SpatialAudioConfig>
Returns this
- Defined in packages/clik-engine/src/audio/SpatialAudio.ts:90

setListener

setListener(position: PositionLike): this
Set the listener position (usually the player/camera)
Parameters
- position: PositionLike
Returns this
- Defined in packages/clik-engine/src/audio/SpatialAudio.ts:43