ecspresso
    Preparing search index...

    Interface AudioState<Ch>

    Audio state resource providing fire-and-forget SFX and music control. Effective volume = individual * channel * master.

    interface AudioState<Ch extends string = string> {
        getChannelVolume(channel: Ch): number;
        getMasterVolume(): number;
        isMuted(): boolean;
        mute(): void;
        pauseMusic(channel?: Ch): void;
        play(sound: string, options?: PlayOptions<Ch>): number;
        playMusic(sound: string, options?: MusicOptions<Ch>): void;
        resumeMusic(channel?: Ch): void;
        setChannelVolume(channel: Ch, volume: number): void;
        setMasterVolume(volume: number): void;
        stop(soundId: number): void;
        stopMusic(channel?: Ch): void;
        toggleMute(): void;
        unmute(): void;
    }

    Type Parameters

    • Ch extends string = string
    Index

    Methods

    getChannelVolume getMasterVolume isMuted mute pauseMusic play playMusic resumeMusic setChannelVolume setMasterVolume stop stopMusic toggleMute unmute

    Methods

    • Get current volume for a channel.

      Parameters

      • channel: Ch

      Returns number

    • Pause music on a channel. If omitted, pauses all music.

      Parameters

      • Optionalchannel: Ch

      Returns void

    • Resume music on a channel. If omitted, resumes all music.

      Parameters

      • Optionalchannel: Ch

      Returns void

    • Set volume for a channel (0-1).

      Parameters

      • channel: Ch
      • volume: number

      Returns void

    • Set master volume (0-1).

      Parameters

      • volume: number

      Returns void

    • Stop a specific sound by its Howler sound ID.

      Parameters

      • soundId: number

      Returns void

    • Stop music on a channel. If omitted, stops all music.

      Parameters

      • Optionalchannel: Ch

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods