phaser - v4.0.0-rc.4
    Preparing search index...

    Type Alias SoundConfig

    Config object containing various sound settings.

    type SoundConfig = {
        delay?: number;
        detune?: number;
        loop?: boolean;
        mute?: boolean;
        pan?: number;
        rate?: number;
        seek?: number;
        source?: SpatialSoundConfig;
        volume?: number;
    }
    Index

    Properties

    delay? detune? loop? mute? pan? rate? seek? source? volume?

    Properties

    delay?: number

    Time, in seconds, that should elapse before the sound actually starts its playback.

    detune?: number

    Represents detuning of sound in cents.

    loop?: boolean

    Whether or not the sound or current sound marker should loop.

    mute?: boolean

    Boolean indicating whether the sound should be muted or not.

    pan?: number

    A value between -1 (full left pan) and 1 (full right pan). 0 means no pan.

    rate?: number

    Defines the speed at which the sound should be played.

    seek?: number

    Position of playback for this sound, in seconds.

    source?: SpatialSoundConfig

    An optional config object containing default spatial sound settings.

    volume?: number

    A value between 0 (silence) and 1 (full volume).

    Settings

    Member Visibility

    On This Page

    Properties