Monky.MPD

This module creates a persistant connection to an mpd server and allows to query information or react to events waited for with MPDs idle

Documentation

data MPDSocket

A type safe socket for this module, basically a handle

data State

The current state of the MPD player submodule

Constructors

Playing

Playing

Stopped

Stopped

Paused

Paused

Instances

Eq State

Methods

(==) :: State -> State -> Bool

(/=) :: State -> State -> Bool

Show State

Methods

showsPrec :: Int -> State -> ShowS

show :: State -> String

showList :: [State] -> ShowS

data TagCollection

Collection of tags MPD supports

Constructors

TagCollection

Fields

• tagArtist :: Maybe Text
• tagArtistSort :: Maybe Text
• tagAlbum :: Maybe Text
• tagAlbumSort :: Maybe Text
• tagAlbumArtist :: Maybe Text
• tagAlbumArtistSort :: Maybe Text
• tagTitle :: Maybe Text
• tagTrack :: Maybe Text
• tagName :: Maybe Text
• tagGenre :: Maybe Text
• tagDate :: Maybe Text
• tagComposer :: Maybe Text
• tagPerformer :: Maybe Text
• tagComment :: Maybe Text
• tagDisc :: Maybe Text
• tagMArtistid :: Maybe Text
• tagMAlbumid :: Maybe Text
• tagMAlbumArtistid :: Maybe Text
• tagMTrackid :: Maybe Text
• tagMReleaseTrackid :: Maybe Text

Instances

Eq TagCollection

Methods

(==) :: TagCollection -> TagCollection -> Bool

(/=) :: TagCollection -> TagCollection -> Bool

Show TagCollection

Methods

showsPrec :: Int -> TagCollection -> ShowS

show :: TagCollection -> String

showList :: [TagCollection] -> ShowS

data SongInfo

Information about an song

Constructors

SongInfo

Fields

• songFile :: Text
• songRange :: Maybe (Float, Float)
• songMTime :: Maybe Text
• songTime :: Maybe Int
• songDuration :: Maybe Float
• songTags :: TagCollection
• songPos :: Maybe Int
• songInfoId :: Maybe Int
• songPriority :: Maybe Int

Instances

Eq SongInfo

Methods

(==) :: SongInfo -> SongInfo -> Bool

(/=) :: SongInfo -> SongInfo -> Bool

Show SongInfo

Methods

showsPrec :: Int -> SongInfo -> ShowS

show :: SongInfo -> String

showList :: [SongInfo] -> ShowS

data Status

Haskell type for the data returned by MPDs status command

Constructors

Status

Fields

• volume :: Int
• repeats :: Bool
• random :: Bool
• single :: Maybe Bool
• consume :: Maybe Bool
• playlist :: Int
• playlistLength :: Int
• state :: State
• mixrAmpdb :: Float
• xfade :: Maybe Int
• mixrAmpDelay :: Maybe Int
• song :: Maybe Int
• songId :: Maybe Int
• nextSong :: Maybe Int
• nextSongId :: Maybe Int
• time :: Maybe Int
• elapsed :: Maybe Float
• bitrate :: Maybe Int
• duration :: Maybe Int
• audio :: Maybe (Int, Int, Int)
• updating :: Maybe Int
• mpderror :: Maybe Text

Instances

Eq Status

Methods

(==) :: Status -> Status -> Bool

(/=) :: Status -> Status -> Bool

Show Status

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

getMPDStatus :: MPDSocket -> IO (Either String Status)

Get the current status or an error from the MPD server

getMPDSong :: MPDSocket -> IO (Either String SongInfo)

Get the information about the song currently beeing player from the MPD server

getMPDSocket

Arguments

:: String

The host the server is on

-> String

The port the server listens on

-> IO (Either String MPDSocket)

Get a new MPDSocket

closeMPDSocket :: MPDSocket -> IO ()

Close the MPDSocket when it is no longer required

getMPDFd :: MPDSocket -> IO Fd

Get the raw Fd from the MPDSocket for eventing api

readOk :: MPDSocket -> IO (Either String ())

Get the OK sent by mpd after idle out of the pipe

goIdle

Arguments

:: MPDSocket

-> String

The string that should be send with idle (list of subsystems)

-> IO (Either String ())

Go into MPDs idle mode, this does return, but MPD wont time us out and will notify us if something happens

doQuery :: MPDSocket -> String -> ExceptT String IO [Text]

Send a query to the MPD server and return a list of answers (line by line)

This does not filter out errors, error checking has to be done by the user. This does filter out the last OK though