Class StoredPlaylistsCommands

Index

Constructors

Methods

listPlaylist listPlaylistInfo listPlaylists load playlistAdd playlistClear playlistDelete playlistMove remove rename save

Constructors

constructor

new StoredPlaylistsCommands(protocol: MPDProtocol): StoredPlaylistsCommands
Parameters
- protocol: MPDProtocol
Returns StoredPlaylistsCommands
- Defined in src/core/commands/storedPlaylists.ts:6

Methods

listPlaylist

listPlaylist(name: string): Promise<string[]>
Lists the songs in the playlist. Playlist plugins are supported.
Parameters
- name: string
Returns Promise<string[]>
- Defined in src/core/commands/storedPlaylists.ts:21

listPlaylistInfo

listPlaylistInfo(name: string): Promise<PlaylistItem[]>
Lists the songs with metadata in the playlist. Playlist plugins are supported.
Parameters
- name: string
Returns Promise<PlaylistItem[]>
- Defined in src/core/commands/storedPlaylists.ts:30

listPlaylists

listPlaylists(): Promise<StoredPlaylist[]>
Prints a list of the playlist directory. Each playlist name comes with its last modification time. To avoid problems due to clock differences between clients and the server, clients should not compare this value with their local clock.

Returns Promise<StoredPlaylist[]>
- Defined in src/core/commands/storedPlaylists.ts:13

load

load(name: string, start?: number, end?: number): Promise<void>
Loads the playlist into the current queue. Playlist plugins are supported. A range may be specified to load only a part of the playlist.
Parameters
- name: string
- Optionalstart: number
- Optionalend: number
Returns Promise<void>
- Defined in src/core/commands/storedPlaylists.ts:40

playlistAdd

playlistAdd(name: string, uri: string): Promise<void>
Adds uri to the playlist name.m3u. name.m3u will be created if it does not exist.
Parameters
- name: string
- uri: string
Returns Promise<void>
- Defined in src/core/commands/storedPlaylists.ts:62

playlistClear

playlistClear(name: string): Promise<void>
Clears the playlist name.m3u.
Parameters
- name: string
Returns Promise<void>
- Defined in src/core/commands/storedPlaylists.ts:70

playlistDelete

playlistDelete(name: string, position: number): Promise<void>
Deletes position from the playlist name.m3u.
Parameters
- name: string
- position: number
Returns Promise<void>
- Defined in src/core/commands/storedPlaylists.ts:78

playlistMove

playlistMove(name: string, from: number, to: number): Promise<void>
Moves the song at position from in the playlist name.m3u to the position to.
Parameters
- name: string
- from: number
- to: number
Returns Promise<void>
- Defined in src/core/commands/storedPlaylists.ts:86

remove

remove(name: string): Promise<void>
Removes the playlist name.m3u from the playlist directory.
Parameters
- name: string
Returns Promise<void>
- Defined in src/core/commands/storedPlaylists.ts:102

rename

rename(name: string, newName: string): Promise<void>
Renames the playlist name.m3u to newName.m3u.
Parameters
- name: string
- newName: string
Returns Promise<void>
- Defined in src/core/commands/storedPlaylists.ts:94

save

save(name: string): Promise<void>
Saves the current playlist to name.m3u in the playlist directory.
Parameters
- name: string
Returns Promise<void>
- Defined in src/core/commands/storedPlaylists.ts:54