A typeclass to allow for multiple implementations of a connection to an MPD server.

The main implementation of an MPD client. It actually connects to a server and interacts with it.

To use the error throwing/catching capabilities:

import Control.Monad.Error (throwError, catchError)

To run IO actions within the MPD monad:

import Control.Monad.Trans (liftIO)

The MPDError type is used to signal errors, both from the MPD and otherwise.

Represents various MPD errors (aka. ACKs).

A response is either an MPDError or some result.

A wrapper for withMPDEx that uses localhost:6600 as the default host:port, or whatever is found in the environment variables MPD_HOST and MPD_PORT. If MPD_HOST is of the form "password@host" the password will be supplied as well.

Examples:

withMPD $ play Nothing
withMPD $ add_ "tool" >> play Nothing >> currentSong

Same as withMPD, but takes optional arguments that override MPD_HOST and MPD_PORT.

This is e.g. useful for clients that optionally take --port and --host as command line arguments, and fall back to withMPD's defaults if those arguments are not given.

The most configurable API for running an MPD action.

An interface for creating MPD queries.

For example, to match any song where the value of artist is "Foo", we use:

Artist =? "Foo"

We can also compose queries, thus narrowing the search. For example, to match any song where the value of artist is "Foo" and the value of album is "Bar", we use:

Artist =? "Foo" <&> Album =? "Bar"

Create a query.

Combine queries.

An empty query. Matches anything.

A type class for values that can be converted to Strings.

Used for commands which require a playlist name. If empty, the current playlist is used.

Used for commands which require a path within the database. If empty, the root path is used.

Available metadata types/scope modifiers, used for searching the database for entries with certain metadata values.

A metadata value.

Object types.

Represents the different playback states.

Represents the various MPD subsystems.

Represents the result of running count.

Result of the lsInfo operation

Represents an output device.

Represents a single song item.

The position of a song in a playlist.

Get list of specific tag type

Add metadata tag value.

Container for database statistics.

Container for MPD status.

The default value for this type.

Clear the current error message in status.

Get the currently playing song.

Wait until there is a noteworthy change in one or more of MPD's susbystems.

The first argument is a list of subsystems that should be considered. An empty list specifies that all subsystems should be considered.

A list of subsystems that have noteworthy changes is returned.

Note that running this command will block until either idle returns or is cancelled by noidle.

Cancel idle.

Get server statistics.

Get the server's status.

Set consume mode

Set crossfading between songs.

Set random playing.

Set repeating.

Set the volume (0-100 percent).

Set single mode

Set the replay gain mode.

Get the replay gain options.

Play the next song.

Pause playing.

Begin/continue playing.

Play a file with given id.

Play the previous song.

Seek to some point in a song.

Seek to some point in a song (id version)

Stop playing.

Like add, but returns a playlist id.

Add a song (or a whole directory) to the current playlist.

Clear the current playlist.

Remove a song from the current playlist.

Remove a song from the current playlist.

Move a song to a given position in the current playlist.

Move a song from (songid) to (playlist index) in the playlist. If to is negative, it is relative to the current song in the playlist (if there is one).

Retrieve file paths and positions of songs in the current playlist. Note that this command is only included for completeness sake; it's deprecated and likely to disappear at any time, please use playlistInfo instead.

Search for songs in the current playlist with strict matching.

Retrieve metadata for songs in the current playlist.

Like playlistInfo but can restrict to a range of songs.

Displays a list of songs in the playlist. If id is specified, only its info is returned.

Search case-insensitively with partial matches for songs in the current playlist.

Retrieve a list of changed songs currently in the playlist since a given playlist version.

Like plChanges but only returns positions and ids.

Shuffle the playlist.

Swap the positions of two songs.

Swap the positions of two songs (Id version)

Retrieve a list of files in a given playlist.

Retrieve metadata for files in a given playlist.

Retreive a list of stored playlists.

Load an existing playlist.

Add a song (or a whole directory) to a stored playlist. Will create a new playlist if the one specified does not already exist.

Clear a playlist. If the specified playlist does not exist, it will be created.

Remove a song from a playlist.

Move a song to a given position in the playlist specified.

Rename an existing playlist.

Delete existing playlist.

Save the current playlist.

Count the number of entries matching a query.

Search the database for entries exactly matching a query.

Adds songs matching a query to the current playlist.

List all tags of the specified type.

List the songs (without metadata) in a database directory recursively.

Recursive lsInfo.

Non-recursively list the contents of a database directory.

Search the database using case insensitive matching.

Update the server's database.

If no path is given, the whole library will be scanned. Unreadable or non-existent paths are silently ignored.

The update job id is returned.

Like update but also rescans unmodified files.

Reads a sticker value for the specified object.

Adds a sticker value to the specified object.

Delete a sticker value from the specified object.

Lists the stickers for the specified object.

Searches the sticker database for stickers with the specified name, below the specified path.

Send password to server to authenticate session. Password is sent as plain text.

Check that the server is still responding.

Turn off an output device.

Turn on an output device.

Retrieve information for all output devices.

Retrieve a list of available commands.

Retrieve a list of unavailable (due to access restrictions) commands.

Retrieve a list of available song metadata.

Retrieve a list of supported urlhandlers.

Retreive a list of decoder plugins with associated suffix and mime types.

Retrieve configuration keys and values.