Class SpatialPlayer

Handles 3D audio playback (one-shot and continuous).

Index

Constructors

Methods

play3D playContinuous3D updateSoundPosition updateChannelPosition setSoundOrientation setChannelOrientation is3DSound is3DChannel getSoundPosition getChannelPosition getSoundOrientation getChannelOrientation

Constructors

constructor

new SpatialPlayer(
    context: ContextManager,
    groups: GroupManager,
    tracks: TrackManager,
    continuous: ContinuousPlayer,
    pannerFactory: PannerFactory,
    _listener: ListenerManager,
    events: EventEmitter,
    logger: Logger,
): SpatialPlayer
Parameters
- context: ContextManager
- groups: GroupManager
- tracks: TrackManager
- continuous: ContinuousPlayer
- pannerFactory: PannerFactory
- _listener: ListenerManager
- events: EventEmitter
- logger: Logger
Returns SpatialPlayer
- Defined in spatial/spatial-player.ts:28

Methods

play3D

play3D(key: string, position: Vector3, options?: Play3DOptions): string | null
Plays a one-shot sound at a specific position in 3D space.
Parameters
- key: string
- position: Vector3
- Optionaloptions: Play3DOptions
Returns string | null
- Defined in spatial/spatial-player.ts:42

playContinuous3D

playContinuous3D(
    key: string,
    position: Vector3,
    channelId?: string,
    options?: Play3DOptions,
): Promise<void>
Plays continuous audio at a specific position in 3D space.
Parameters
- key: string
- position: Vector3
- channelId: string = 'default_3d'
- Optionaloptions: Play3DOptions
Returns Promise<void>
- Defined in spatial/spatial-player.ts:152

updateSoundPosition

updateSoundPosition(instanceId: string, position: Vector3): boolean
Updates the position of a playing 3D sound (one-shot).
Parameters
- instanceId: string
- position: Vector3
Returns boolean
- Defined in spatial/spatial-player.ts:250

updateChannelPosition

updateChannelPosition(channelId: string, position: Vector3): boolean
Updates the position of a continuous 3D channel.
Parameters
- channelId: string
- position: Vector3
Returns boolean
- Defined in spatial/spatial-player.ts:278

setSoundOrientation

setSoundOrientation(instanceId: string, orientation: Vector3): boolean
Sets the orientation of a playing 3D sound (one-shot).
Parameters
- instanceId: string
- orientation: Vector3
Returns boolean
- Defined in spatial/spatial-player.ts:306

setChannelOrientation

setChannelOrientation(channelId: string, orientation: Vector3): boolean
Sets the orientation of a continuous 3D channel.
Parameters
- channelId: string
- orientation: Vector3
Returns boolean
- Defined in spatial/spatial-player.ts:333

is3DSound

is3DSound(instanceId: string): boolean
Checks if a sound instance is a 3D positioned sound.
Parameters
- instanceId: string
Returns boolean
- Defined in spatial/spatial-player.ts:360

is3DChannel

is3DChannel(channelId: string): boolean
Checks if a channel is a 3D positioned channel.
Parameters
- channelId: string
Returns boolean
- Defined in spatial/spatial-player.ts:368

getSoundPosition

getSoundPosition(instanceId: string): Vector3 | null
Gets the current position of a 3D sound.
Parameters
- instanceId: string
Returns Vector3 | null
- Defined in spatial/spatial-player.ts:376

getChannelPosition

getChannelPosition(channelId: string): Vector3 | null
Gets the current position of a 3D channel.
Parameters
- channelId: string
Returns Vector3 | null
- Defined in spatial/spatial-player.ts:387

getSoundOrientation

getSoundOrientation(instanceId: string): Vector3 | null
Gets the current orientation of a 3D sound.
Parameters
- instanceId: string
Returns Vector3 | null
- Defined in spatial/spatial-player.ts:398

getChannelOrientation

getChannelOrientation(channelId: string): Vector3 | null
Gets the current orientation of a 3D channel.
Parameters
- channelId: string
Returns Vector3 | null
- Defined in spatial/spatial-player.ts:409

Class SpatialPlayer

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SpatialPlayer

Methods

play3D

Parameters

Returns string | null

playContinuous3D

Parameters

Returns Promise<void>

updateSoundPosition

Parameters

Returns boolean

updateChannelPosition

Parameters

Returns boolean

setSoundOrientation

Parameters

Returns boolean

setChannelOrientation

Parameters

Returns boolean

is3DSound

Parameters

Returns boolean

is3DChannel

Parameters

Returns boolean

getSoundPosition

Parameters

Returns Vector3 | null

getChannelPosition

Parameters

Returns Vector3 | null

getSoundOrientation

Parameters

Returns Vector3 | null

getChannelOrientation

Parameters

Returns Vector3 | null

Settings

On This Page