Class PlaybackCommands

Index

Constructors

Methods

next pause play playId previous seek seekCur seekId stop

Constructors

constructor

new PlaybackCommands(protocol: MPDProtocol): PlaybackCommands
Parameters
- protocol: MPDProtocol
Returns PlaybackCommands
- Defined in src/core/commands/playback.ts:5

Methods

next

next(): Promise<void>
Plays the next song in the playlist.

Returns Promise<void>
- Defined in src/core/commands/playback.ts:39

pause

pause(pause?: boolean): Promise<void>
Pauses or resumes playback.
Parameters
- pause: boolean = true
Returns Promise<void>
- Defined in src/core/commands/playback.ts:76

play

play(songPos?: number): Promise<void>
Begins playing the playlist at song number songPos.
Parameters
- OptionalsongPos: number
Returns Promise<void>
- Defined in src/core/commands/playback.ts:10

playId

playId(songId: number): Promise<void>
Begins playing the playlist at song with the given songId.
Parameters
- songId: number
Returns Promise<void>
- Defined in src/core/commands/playback.ts:21

previous

previous(): Promise<void>
Plays the previous song in the playlist.

Returns Promise<void>
- Defined in src/core/commands/playback.ts:32

seek

seek(songPos: number, time: number): 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>
- Defined in src/core/commands/playback.ts:46

seekCur

seekCur(time: number, relative?: boolean): 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>
- Defined in src/core/commands/playback.ts:63

seekId

seekId(songId: number, time: number): 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>
- Defined in src/core/commands/playback.ts:54

stop

stop(): Promise<void>
Stops playing.

Returns Promise<void>
- Defined in src/core/commands/playback.ts:84