paracusia

v0.2.11

paracusia v0.2.11 Paracusia.MpdClient.Playlists

Functions related to stored playlists.

See also: https://musicpd.org/doc/protocol/playlist_files.html

Link to this section Summary

Functions

add(playlist, uri)

Adds uri to the playlist playlist.m3u

clear(playlist)

Clears the playlist playlist.m3u

delete_pos(playlist, pos)

Deletes the song at position pos from the playlist

list(playlist)

Returns a list containing all songs in the given playlist

list_all()

Returns a list of all playlists inside the playlists directory

list_info(playlist)

Returns a map containing all songs from the playlist and their metadata

load(playlist)

Loads the playlist into the queue

load(playlist, arg)

Loads a given range from the playlist into the queue

move(playlist, from, to)

Moves the song at position from in the playlist playlist.m3u to the position to

remove(playlist)

Removes the playlist playlist.m3u from the playlist directory

rename(playlist, new_name)

Renames the playlist playlist.m3u to new_name.m3u

save(name)

Saves the current playlist to name.m3u in the playlist directory

Link to this section Functions

Link to this function

add(playlist, uri) 
add(String.t(), String.t()) :: :ok | Paracusia.MpdTypes.mpd_error()

Adds uri to the playlist playlist.m3u

playlist.m3u will be created if it does not already exist.

Link to this function

clear(playlist) 
clear(String.t()) :: :ok | Paracusia.MpdTypes.mpd_error()

Clears the playlist playlist.m3u

Link to this function

delete_pos(playlist, pos) 
delete_pos(String.t(), integer()) :: :ok | Paracusia.MpdTypes.mpd_error()

Deletes the song at position pos from the playlist.

Link to this function

list(playlist) 
list(String.t()) :: {:ok, [String.t()]} | Paracusia.MpdTypes.mpd_error()

Returns a list containing all songs in the given playlist.

Link to this function

list_all() 
list_all() :: {:ok, [map()]} | Paracusia.MpdTypes.mpd_error()

Returns a list of all playlists inside the playlists directory.

Link to this function

list_info(playlist) 
list_info(String.t()) :: {:ok, [map()]} | Paracusia.MpdTypes.mpd_error()

Returns a map containing all songs from the playlist and their metadata.

Link to this function

load(playlist) 
load(String.t()) :: :ok | Paracusia.MpdTypes.mpd_error()

Loads the playlist into the queue.

Link to this function

load(playlist, arg) 
load(String.t(), Paracusia.MpdTypes.range()) ::
  :ok | Paracusia.MpdTypes.mpd_error()

Loads a given range from the playlist into the queue.

Link to this function

move(playlist, from, to) 
move(String.t(), integer(), integer()) :: :ok | Paracusia.MpdTypes.mpd_error()

Moves the song at position from in the playlist playlist.m3u to the position to.

Link to this function

remove(playlist) 
remove(String.t()) :: :ok | Paracusia.MpdTypes.mpd_error()

Removes the playlist playlist.m3u from the playlist directory.

Link to this function

rename(playlist, new_name) 
rename(String.t(), String.t()) :: :ok | Paracusia.MpdTypes.mpd_error()

Renames the playlist playlist.m3u to new_name.m3u

Link to this function

save(name) 
save(String.t()) :: :ok | Paracusia.MpdTypes.mpd_error()

Saves the current playlist to name.m3u in the playlist directory.