Class StereoPanner

Handles stereo panning and distance callback features.

Index

Constructors

Methods

play2DPanned setPan getSoundPan is2DPannedSound registerDistanceCallback unregisterDistanceCallback destroy

Constructors

constructor

new StereoPanner(
    context: ContextManager,
    groups: GroupManager,
    tracks: TrackManager,
    continuous: ContinuousPlayer,
    listener: ListenerManager,
    events: EventEmitter,
    logger: Logger,
): StereoPanner
Parameters
- context: ContextManager
- groups: GroupManager
- tracks: TrackManager
- continuous: ContinuousPlayer
- listener: ListenerManager
- events: EventEmitter
- logger: Logger
Returns StereoPanner
- Defined in spatial/stereo-panner.ts:33

Methods

play2DPanned

play2DPanned(key: string, options?: Play2DPannedOptions): string | null
Plays a one-shot sound with stereo panning.
Parameters
- key: string
- Optionaloptions: Play2DPannedOptions
Returns string | null
- Defined in spatial/stereo-panner.ts:46

setPan

setPan(instanceId: string, pan: number): boolean
Updates the stereo pan position of a playing 2D panned sound.
Parameters
- instanceId: string
- pan: number
Returns boolean
- Defined in spatial/stereo-panner.ts:154

getSoundPan

getSoundPan(instanceId: string): number | null
Gets the current pan position of a 2D panned sound.
Parameters
- instanceId: string
Returns number | null
- Defined in spatial/stereo-panner.ts:173

is2DPannedSound

is2DPannedSound(instanceId: string): boolean
Checks if a sound instance is a 2D panned sound.
Parameters
- instanceId: string
Returns boolean
- Defined in spatial/stereo-panner.ts:184

registerDistanceCallback

registerDistanceCallback(
instanceId: string,
config: DistanceCallbackConfig,
): boolean
Registers distance callbacks for a 3D sound.
Parameters
- instanceId: string
- config: DistanceCallbackConfig
Returns boolean
- Defined in spatial/stereo-panner.ts:191

unregisterDistanceCallback

unregisterDistanceCallback(instanceId: string): boolean
Unregisters distance callbacks for a sound.
Parameters
- instanceId: string
Returns boolean
- Defined in spatial/stereo-panner.ts:242

destroy

destroy(): void
Destroys all resources.

Returns void
- Defined in spatial/stereo-panner.ts:319