Interface SoundNodeDeps

Everything a node needs from the engine, as ports.

interface SoundNodeDeps {
    listener: AudioListener;
    bus: GainNode;
    panningModel: PanningModel;
    parent: Object3D;
    onStarted(name: string): void;
    onEnded(name: string): void;
    resolveAttachCenter?(): Vector3 | null;
    registerFoaDecoder?(decoder: FoaDecoder): void;
    unregisterFoaDecoder?(decoder: FoaDecoder): void;
}

Index

Properties

listener bus panningModel parent

Methods

onStarted onEnded resolveAttachCenter? registerFoaDecoder? unregisterFoaDecoder?

Properties

listener

listener: AudioListener

bus

bus: GainNode

The bus gain node this node routes into (already attrs.bus).

panningModel

panningModel: PanningModel

parent

parent: Object3D

The node's placeholder group (carries the node transform); voices attach here.

Methods

onStarted

onStarted(name: string): void
Parameters
- name: string
Returns void
- Defined in src/audio/sound-node.ts:58

onEnded

onEnded(name: string): void
Parameters
- name: string
Returns void
- Defined in src/audio/sound-node.ts:59

`Optional`resolveAttachCenter

resolveAttachCenter?(): Vector3 | null
World-space centre of the attach_to node, or null while it is unknown.

Returns Vector3 | null
- Defined in src/audio/sound-node.ts:61

`Optional`registerFoaDecoder

registerFoaDecoder?(decoder: FoaDecoder): void
An ambisonic node's decoder, for the engine to rotate against the camera each frame.
Parameters
- decoder: FoaDecoder
Returns void
- Defined in src/audio/sound-node.ts:63

`Optional`unregisterFoaDecoder

unregisterFoaDecoder?(decoder: FoaDecoder): void
Parameters
- decoder: FoaDecoder
Returns void
- Defined in src/audio/sound-node.ts:64