mpc-js
    Preparing search index...

    Interface PlaybackCommands

    interface PlaybackCommands {
        next(): Promise<void>;
        pause(pause?: boolean): Promise<void>;
        play(songPos?: number): Promise<void>;
        playId(songId: number): Promise<void>;
        previous(): Promise<void>;
        seek(songPos: number, time: number): Promise<void>;
        seekCur(time: number, relative?: boolean): Promise<void>;
        seekId(songId: number, time: number): Promise<void>;
        stop(): Promise<void>;
    }

    Hierarchy

    • ReturnType<typeof createPlaybackCommands>
      • PlaybackCommands
    Index

    Methods

    next pause play playId previous seek seekCur seekId stop

    Methods

    • Plays the next song in the playlist.

      Returns Promise<void>

    • Pauses or resumes playback.

      Parameters

      • pause: boolean = true

      Returns Promise<void>

    • Begins playing the playlist at song number songPos.

      Parameters

      • OptionalsongPos: number

      Returns Promise<void>

    • Begins playing the playlist at song with the given songId.

      Parameters

      • songId: number

      Returns Promise<void>

    • Plays the previous song in the playlist.

      Returns Promise<void>

    • Seeks to the position time (in seconds; fractions allowed) of entry songPos in the playlist.

      Parameters

      • songPos: number
      • time: number

      Returns Promise<void>

    • Seeks to the position time (in seconds; fractions allowed) within the current song. If relative is true, then the time is relative to the current playing position.

      Parameters

      • time: number
      • relative: boolean = false

      Returns Promise<void>

    • Seeks to the position time (in seconds; fractions allowed) of song with the given songId.

      Parameters

      • songId: number
      • time: number

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods