Strata - v1.4.10
    Preparing search index...

    Interface AudioEmitterProps

    Props for the AudioEmitter component.

    interface AudioEmitterProps {
        autoplay?: boolean;
        distanceModel?: DistanceModel;
        follow?: RefObject<Object3D<Object3DEventMap>>;
        loop?: boolean;
        maxDistance?: number;
        onLoad?: () => void;
        position?: [number, number, number];
        refDistance?: number;
        rolloffFactor?: number;
        url: string;
        volume?: number;
    }
    Index

    Properties

    autoplay? distanceModel? follow? loop? maxDistance? onLoad? position? refDistance? rolloffFactor? url volume?

    Properties

    autoplay?: boolean

    Whether to autoplay on load. Default: false.

    distanceModel?: DistanceModel

    Attenuation algorithm.

    follow?: RefObject<Object3D<Object3DEventMap>>

    Reference to an Object3D to track automatically.

    loop?: boolean

    Whether to loop the sound. Default: false.

    maxDistance?: number

    Maximum hearing distance. Default: 10000.

    onLoad?: () => void

    Callback fired when resource is loaded.

    position?: [number, number, number]

    Initial world position. Default: [0, 0, 0].

    refDistance?: number

    Minimum distance for falloff. Default: 1.

    rolloffFactor?: number

    Rolloff rate. Default: 1.0.

    url: string

    URL of the positional audio resource.

    volume?: number

    Local volume multiplier. Default: 1.0.

    Settings

    Member Visibility

    On This Page

    Properties