Illutions Engine API - v0.26.0
    Preparing search index...

    Type Alias SoundParams

    Parameters used to load a global or positional audio source.

    type SoundParams = {
        fade?: number;
        loop?: boolean;
        name: string;
        object: string;
        url: string;
        volume?: number;
    }
    Index
    fade? loop? name object url volume?
    fade?: number

    Fade-in duration in seconds. Default: 2.

    loop?: boolean

    Whether playback should loop. Default: true.

    name: string

    Unique name used to identify the audio source.

    object: string

    Name of the scene object for positional audio. Use an empty string for global audio.

    url: string

    Path or URL to the audio file.

    volume?: number

    Target playback volume. Default: 0.

    Settings
    Member Visibility

    On This Page
    Properties