Strata - v1.4.10
    Preparing search index...

    Interface AudioZoneProps

    Props for the AudioZone component.

    interface AudioZoneProps {
        audioLoop?: boolean;
        audioUrl?: string;
        audioVolume?: number;
        children?: ReactNode;
        debug?: boolean;
        fadeTime?: number;
        geometry: "box" | "sphere";
        onEnter?: () => void;
        onExit?: () => void;
        position?: [number, number, number];
        radius?: number;
        size?: [number, number, number];
    }
    Index

    Properties

    audioLoop? audioUrl? audioVolume? children? debug? fadeTime? geometry onEnter? onExit? position? radius? size?

    Properties

    audioLoop?: boolean

    Whether the zone audio should loop. Default: true.

    audioUrl?: string

    URL of the audio to play when inside the zone.

    audioVolume?: number

    Volume for the zone audio. Default: 1.0.

    children?: ReactNode

    Optional child components.

    debug?: boolean

    Whether to show a wireframe gizmo for the zone. Default: false.

    fadeTime?: number

    Cross-fade duration when entering or exiting the zone. Default: 0.5.

    geometry: "box" | "sphere"

    Geometric primitive for the zone ('box' or 'sphere').

    onEnter?: () => void

    Callback fired when the listener enters the zone.

    onExit?: () => void

    Callback fired when the listener exits the zone.

    position?: [number, number, number]

    Center position of the trigger volume. Default: [0, 0, 0].

    radius?: number

    Radius for 'sphere' geometry. Default: 5.

    size?: [number, number, number]

    Dimensions for 'box' geometry [width, height, depth]. Default: [10, 10, 10].

    Settings

    Member Visibility

    On This Page

    Properties