Interface AudioEngineDeps

The pieces of the viewer the engine reads, as ports (see module docs).

interface AudioEngineDeps {
    getCamera(): Object3D;
    onCameraReplaced(cb: () => void): Unsubscribe;
    getDims(): SimpleDims | null;
    onDimsChanged(cb: () => void): Unsubscribe;
    getSceneGraph(): SceneNode | null;
    getSceneScale(): number;
    container(): HTMLElement;
    emit(
        event: "sound-ended" | "sound-started",
        payload: { name: string },
    ): void;
    notifyUiChanged(): void;
    resolveNodeCenter?(name: string): Vector3 | null;
}

Index

Methods

getCamera onCameraReplaced getDims onDimsChanged getSceneGraph getSceneScale container emit notifyUiChanged resolveNodeCenter?

Methods

getCamera

getCamera(): Object3D
Returns Object3D
- Defined in src/audio/audio-engine.ts:52

onCameraReplaced

onCameraReplaced(cb: () => void): Unsubscribe
Fires after the camera OBJECT is replaced (perspective ⇄ ortho); the listener re-parents.
Parameters
- cb: () => void
Returns Unsubscribe
- Defined in src/audio/audio-engine.ts:54

getDims

getDims(): SimpleDims | null
Returns SimpleDims | null
- Defined in src/audio/audio-engine.ts:55

onDimsChanged

onDimsChanged(cb: () => void): Unsubscribe
Fires synchronously on every dimension change.
Parameters
- cb: () => void
Returns Unsubscribe
- Defined in src/audio/audio-engine.ts:57

getSceneGraph

getSceneGraph(): SceneNode | null
Returns SceneNode | null
- Defined in src/audio/audio-engine.ts:58

getSceneScale

getSceneScale(): number
Scene characteristic size — the distance defaults derive from it.

Returns number
- Defined in src/audio/audio-engine.ts:60

container

container(): HTMLElement
Where the autoplay gate mounts.

Returns HTMLElement
- Defined in src/audio/audio-engine.ts:62

emit

emit(event: "sound-ended" | "sound-started", payload: { name: string }): void
Parameters
- event: "sound-ended" | "sound-started"
- payload: { name: string }
Returns void
- Defined in src/audio/audio-engine.ts:63

notifyUiChanged

notifyUiChanged(): void
Tell the UI (the rail) the engine's state changed.

Returns void
- Defined in src/audio/audio-engine.ts:65

`Optional`resolveNodeCenter

resolveNodeCenter?(name: string): Vector3 | null
World-space bounding-box centre of the scene node called name, or null when it is unknown or not loaded yet — what attach_to sources follow.
Parameters
- name: string
Returns Vector3 | null
- Defined in src/audio/audio-engine.ts:70