|
Network.MPD | Stability | alpha | Maintainer | Joachim Fasting <joachim.fasting@gmail.com> |
|
|
|
|
|
Description |
An MPD client library. MPD is a daemon for playing music that is
controlled over a network socket. Its site is at http://www.musicpd.org/.
To avoid name clashes with the standard Prelude functions, do:
import qualified Network.MPD as MPD
|
|
Synopsis |
|
|
|
|
Basic data types
|
|
|
A typeclass to allow for multiple implementations of a connection
to an MPD server.
| | Methods | | | Instances | |
|
|
|
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)
| Instances | |
|
|
|
The MPDError type is used to signal errors, both from the MPD and
otherwise.
| Constructors | NoMPD | MPD not responding
| TimedOut | The connection timed out
| Unexpected String | MPD returned an unexpected response.
This is a bug, either in the library or
in MPD itself.
| Custom String | Used for misc. errors
| ACK ACKType String | ACK type and a message from the
server
|
| Instances | |
|
|
|
Represents various MPD errors (aka. ACKs).
| Constructors | InvalidArgument | Invalid argument passed (ACK 2)
| InvalidPassword | Invalid password supplied (ACK 3)
| Auth | Authentication required (ACK 4)
| UnknownCommand | Unknown command (ACK 5)
| FileNotFound | File or directory not found ACK 50)
| PlaylistMax | Playlist at maximum size (ACK 51)
| System | A system error (ACK 52)
| PlaylistLoad | Playlist loading failed (ACK 53)
| Busy | Update already running (ACK 54)
| NotPlaying | An operation requiring playback
got interrupted (ACK 55)
| FileExists | File already exists (ACK 56)
| UnknownACK | An unknown ACK (aka. bug)
|
| Instances | |
|
|
|
A response is either an MPDError or some result.
|
|
|
|
|
|
|
|
Connections
|
|
|
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
|
|
|
The most configurable API for running an MPD action.
|
|
Command related data types
|
|
|
|
|
|
|
|
|
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.
| Constructors | Artist | | ArtistSort | | Album | | AlbumArtist | | AlbumArtistSort | | Title | | Track | | Name | | Genre | | Date | | Composer | | Performer | | Comment | | Disc | | MUSICBRAINZ_ARTISTID | | MUSICBRAINZ_ALBUMID | | MUSICBRAINZ_ALBUMARTISTID | | MUSICBRAINZ_TRACKID | |
| Instances | |
|
|
|
Object types.
| Constructors | | Instances | |
|
|
|
|
|
Represents the different playback states.
| Constructors | | Instances | |
|
|
|
Represents the various MPD subsystems.
| Constructors | DatabaseS | The song database
| UpdateS | Database updates
| StoredPlaylistS | Stored playlists
| PlaylistS | The current playlist
| PlayerS | The player
| MixerS | The volume mixer
| OutputS | Audio outputs
| OptionsS | Playback options
|
| Instances | |
|
|
|
Constructors | Off | Disable replay gain
| TrackMode | Per track mode
| AlbumMode | Per album mode
|
| Instances | |
|
|
|
Represents the result of running count.
| Constructors | Count | | cSongs :: Integer | Number of songs matching the query
| cPlaytime :: Seconds | Total play time of matching songs
|
|
| Instances | |
|
|
|
Represents an output device.
| Constructors | Output | | outID :: Int | Output's ID number
| outName :: String | Output's name as defined in
the MPD configuration file
| outEnabled :: Bool | |
|
| Instances | |
|
|
|
Represents a single song item.
| Constructors | Song | | sgFilePath :: String | | sgTags :: Map Metadata [String] | Map of available tags (multiple occurences of one tag type allowed)
| sgLastModified :: Maybe UTCTime | Last modification date
| sgLength :: Seconds | Length of the song in seconds
| sgIndex :: Maybe (Int, Int) | Position/ID in playlist
|
|
| Instances | |
|
|
|
Get list of specific tag type
|
|
|
Represents a single playlist item.
| Constructors | | Instances | |
|
|
|
Represents a single item in database.
| Constructors | | Instances | |
|
|
|
Container for database statistics.
| Constructors | Stats | | stsArtists :: Integer | Number of artists.
| stsAlbums :: Integer | Number of albums.
| stsSongs :: Integer | Number of songs.
| stsUptime :: Seconds | Daemon uptime in seconds.
| stsPlaytime :: Seconds | Total playing time.
| stsDbPlaytime :: Seconds | Total play time of all the songs in
the database.
| stsDbUpdate :: Integer | Last database update in UNIX time.
|
|
| Instances | |
|
|
|
Container for MPD status.
| Constructors | Status | | stState :: State | | stVolume :: Int | A percentage (0-100)
| stRepeat :: Bool | | stRandom :: Bool | | stPlaylistID :: Integer | A value that is incremented by the server every time the
playlist changes.
| stPlaylistLength :: Integer | The number of items in the current playlist.
| stSongPos :: Maybe Int | Current song's position in the playlist.
| stSongID :: Maybe Int | Current song's playlist ID.
| stNextSongPos :: Maybe Int | Next song's position in the playlist.
| stNextSongID :: Maybe Int | Next song's playlist ID.
| stTime :: (Double, Seconds) | Time elapsed/total time.
| stBitrate :: Int | Bitrate (in kilobytes per second) of playing song (if any).
| stXFadeWidth :: Seconds | Crossfade time.
| stMixRampdB :: Double | MixRamp threshold in dB
| stMixRampDelay :: Double | MixRamp extra delay in seconds
| stAudio :: (Int, Int, Int) | Samplerate/bits/channels for the chosen output device
(see mpd.conf).
| stUpdatingDb :: Integer | Job ID of currently running update (if any).
| stSingle :: Bool | If True, MPD will play only one song and stop after finishing it.
| stConsume :: Bool | If True, a song will be removed after it has been played.
| stError :: Maybe String | Last error message (if any).
|
|
| Instances | |
|
|
Query interface
|
|
|
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"
| Instances | |
|
|
|
Create a query.
|
|
|
Combine queries.
|
|
|
An empty query. Matches anything.
|
|
Querying MPD's status
|
|
|
Clear the current error message in status.
|
|
|
Get the current song.
|
|
|
Make MPD server notify the client if there is a noteworthy change
in one or more of its subsystems. Note that after running this command
you can either monitor handle for incoming notifications or cancel this
by noidle. Any command other than noidle sent to MPD server while
idle is active will be ignored.
|
|
|
Get idle notifications. If there is no notifications ready
at the moment, this function will block until they show up.
|
|
|
Cancel idle.
|
|
|
Get the server's status.
|
|
|
Get server statistics.
|
|
Playback options
|
|
|
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.
|
|
Controlling playback
|
|
|
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.
|
|
The current playlist
|
|
|
Like add_ but returns a list of the files added.
|
|
|
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.
|
|
|
Displays a list of songs in the playlist.
If id is specified, only its info is returned.
|
|
|
Search for songs in the current playlist with strict matching.
|
|
|
Retrieve metadata for songs in the current playlist.
|
|
|
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.
|
|
|
|
|
|
Swap the positions of two songs.
|
|
|
Swap the positions of two songs (Id version
|
|
Stored playlist
|
|
|
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.
|
|
|
Like playlistAdd but returns a list of the files added.
|
|
|
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.
|
|
|
|
|
|
Move a song to a given position in the playlist specified.
|
|
|
|
|
|
Delete existing playlist.
|
|
|
Save the current playlist.
|
|
The music database
|
|
|
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 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 paths are given, all paths will be scanned.
Unreadable or non-existent paths are silently ignored.
|
|
|
Like update but also rescans unmodified files.
|
|
Stickers
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Connection
|
|
|
Close the connection.
|
|
|
Kill the server. Obviously, the connection is then invalid.
|
|
|
Send password to server to authenticate session.
Password is sent as plain text.
|
|
|
Check that the server is still responding.
|
|
Audio output devices
|
|
|
Turn off an output device.
|
|
|
Turn on an output device.
|
|
|
Retrieve information for all output devices.
|
|
Reflection
|
|
|
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.
|
|
Produced by Haddock version 2.6.1 |