paracusia v0.2.11 Paracusia.MpdTypes

Types for all information retrieved from MPD.

Link to this section Summary

Types

ids are used by MPD to uniquely identify each song in the database. ids remain unchanged when a song changes its position in the queue

See https://musicpd.org/doc/protocol/response_syntax.html#failure_response_syntax for more details

positions are used to identify the position of a song in the queue. The first song in the queue has index 0

Ranges are used to restrict an operation on a subset of the queue. A range is right-open and indexing starts with zero, e.g., {0, 3} is used to specify the songs at the 1st, 2nd and 3rd position

Results returned by MPD can be sorted in ascending order or descending order (:asc or :desc, respectively)

As described at https://musicpd.org/doc/protocol/tags.html

Link to this section Types

Link to this type

find_tag()
find_tag() :: tag() | :any | :file | :base | :modified_since

ids are used by MPD to uniquely identify each song in the database. ids remain unchanged when a song changes its position in the queue.

Link to this type

mpd_error()
mpd_error() :: {:error, {String.t(), String.t()}}

See https://musicpd.org/doc/protocol/response_syntax.html#failure_response_syntax for more details.

Link to this type

position()
position() :: integer()

positions are used to identify the position of a song in the queue. The first song in the queue has index 0.

Link to this type

range()
range() :: {position(), position()}

Ranges are used to restrict an operation on a subset of the queue. A range is right-open and indexing starts with zero, e.g., {0, 3} is used to specify the songs at the 1st, 2nd and 3rd position.

Link to this type

sort_direction()
sort_direction() :: :asc | :desc

Results returned by MPD can be sorted in ascending order or descending order (:asc or :desc, respectively).

Link to this type

tag()
tag() ::
  :artist
  | :artistsort
  | :album
  | :albumsort
  | :albumartist
  | :albumartistsort
  | :title
  | :track
  | :name
  | :genre
  | :date
  | :composer
  | :performer
  | :comment
  | :disc
  | :musicbrainz_artistid
  | :musicbrainz_albumid
  | :musicbrainz_albumartistid
  | :musicbrainz_trackid
  | :musicbrainz_releasetrackid

As described at https://musicpd.org/doc/protocol/tags.html