paracusia

v0.2.11

paracusia v0.2.11 Paracusia.MpdClient.Stickers

Functions related to Stickers.

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

Link to this section Summary

Functions

all(uri)

Returns all stickers for the song at the given URI

delete(uri)

Deletes all sticker values from the song at the given URI

delete(uri, name)

Deletes a sticker value from the song at the given URI

find(parent_uri, name)

Searches inside parent_uri for songs with the given sticker name and returns a list of {uri, value} tuples where value is the sticker value of uri for name

get(uri, name)

Returns the sticker value for the given URI

set(uri, name, value)

Sets the sticker name of uri to value

Link to this section Functions

Link to this function

all(uri) 
all(String.t()) :: {:ok, map()} | Paracusia.MpdTypes.mpd_error()

Returns all stickers for the song at the given URI.

Link to this function

delete(uri) 
delete(String.t()) :: :ok | Paracusia.MpdTypes.mpd_error()

Deletes all sticker values from the song at the given URI.

Link to this function

delete(uri, name) 
delete(String.t(), String.t()) :: :ok | Paracusia.MpdTypes.mpd_error()

Deletes a sticker value from the song at the given URI.

Link to this function

find(parent_uri, name) 
find(String.t(), String.t()) ::
  {:ok, [{String.t(), String.t()}]} | Paracusia.MpdTypes.mpd_error()

Searches inside parent_uri for songs with the given sticker name and returns a list of {uri, value} tuples where value is the sticker value of uri for name.

Link to this function

get(uri, name) 
get(String.t(), String.t()) ::
  {:ok, String.t()} | Paracusia.MpdTypes.mpd_error()

Returns the sticker value for the given URI.

Link to this function

set(uri, name, value) 
set(String.t(), String.t(), String.t()) :: :ok | Paracusia.MpdTypes.mpd_error()

Sets the sticker name of uri to value.