rednode API - v0.50.0
    Preparing search index...

    Interface Sound

    A playing sound.

    interface Sound {
        ended: Promise<SoundEnd>;
        id: number;
        set(
            options: {
                fadeTo?: { ms: number; volume: number };
                pan?: number;
                rate?: number;
                volume?: number;
            },
        ): Promise<void>;
        stop(options?: { fadeOut?: number }): Promise<void>;
    }
    Index
    ended: Promise<SoundEnd>

    Settles when the sound ends, however it ends.

    id: number

    Its id in the engine.

    • Changes it while it plays. fadeTo moves the volume there over ms milliseconds instead of at once.

      Parameters

      • options: {
            fadeTo?: { ms: number; volume: number };
            pan?: number;
            rate?: number;
            volume?: number;
        }

      Returns Promise<void>

    • Stops it, fading out over fadeOut milliseconds.

      Parameters

      • Optionaloptions: { fadeOut?: number }

      Returns Promise<void>