Strata - v1.4.10
    Preparing search index...

    Interface PositionalAudioProps

    Props for the PositionalAudio component.

    interface PositionalAudioProps {
        autoplay?: boolean;
        distanceModel?: DistanceModel;
        loop?: boolean;
        maxDistance?: number;
        onEnd?: () => void;
        onLoad?: () => void;
        playbackRate?: number;
        position?: [number, number, number];
        refDistance?: number;
        rolloffFactor?: number;
        url: string;
        volume?: number;
    }
    Index

    Properties

    autoplay? distanceModel? loop? maxDistance? onEnd? onLoad? playbackRate? position? refDistance? rolloffFactor? url volume?

    Properties

    autoplay?: boolean

    Whether to start playing immediately on load. Default: false.

    distanceModel?: DistanceModel

    Algorithm used for volume attenuation ('linear', 'inverse', 'exponential').

    loop?: boolean

    Whether to loop playback indefinitely. Default: false.

    maxDistance?: number

    Maximum distance after which sound is no longer heard. Default: 10000.

    onEnd?: () => void

    Callback fired when playback reaches the end.

    onLoad?: () => void

    Callback fired when the audio file is fully loaded.

    playbackRate?: number

    Playback speed multiplier. Default: 1.0.

    position?: [number, number, number]

    World position [x, y, z]. Default: [0, 0, 0].

    refDistance?: number

    Distance at which volume starts to decrease. Default: 1.

    rolloffFactor?: number

    Rate of volume falloff with distance. Default: 1.0.

    url: string

    URL of the audio resource to load.

    volume?: number

    Local volume multiplier (0-1). Default: 1.0.

    Settings

    Member Visibility

    On This Page

    Properties