Strata - v1.4.10
    Preparing search index...

    Interface PositionalAudioRef

    Ref interface for PositionalAudio imperative control.

    interface PositionalAudioRef {
        isPlaying: () => boolean;
        pause: () => void;
        play: () => void;
        setPosition: (x: number, y: number, z: number) => void;
        setVolume: (volume: number) => void;
        stop: () => void;
    }
    Index

    Properties

    isPlaying pause play setPosition setVolume stop

    Properties

    isPlaying: () => boolean

    Whether the sound is currently playing.

    pause: () => void

    Pause playback.

    play: () => void

    Start or resume playback.

    setPosition: (x: number, y: number, z: number) => void

    Teleport the sound source to a new world position.

    setVolume: (volume: number) => void

    Dynamically update the local volume.

    stop: () => void

    Stop playback and reset to start.

    Settings

    Member Visibility

    On This Page

    Properties