sfwbar-mpd(1)

Name
sfwbar-mpd - Sfwbar Music Player Daemon module

Filename: mpd.so

Requires: none

SYNOPSIS

The Music Player Daemon module provides an interface to control an MPD server.

Functions

  MpdServer(<address>)

Specify an address for an MPD server to use. The address is specified using the MPD_HOST convention ([password@]host[:port], where a host can be a local socket or an abstract socket prefixed by @). If MpdServer is not called, the MPD module will use MPD_HOST/MPD_PORT environment variables and failing that, will fallback to $XDG_RUNTIME_DIR/mpd/socket, /run/mpd/socket and localhost:6600.

  MpdCmd(<command>)

Send a command to the MPD server. You can send any command supported by an MPD protocol. Output of some MPD commands is processed by the module and made available to the configuration layer. (Please note that while you can send command lists, the output of a command list will not be processed). The output of the following commands is processed:

"list"
    upon completion mpd-search trigger is emitted and the results are available using MpdList function.

"find"
    upon completion mpd-search trigger is emitted and the results are available using MpdList function.

"playlistinfo"
    upon completion mpd-queue trigger is emitted and the results are available using MpdList function.

"listplaylistinfo"
    upon completion mpd-playlist trigger is emitted and the results are stored in an array variable list.

"list"
    upon completion mpd-list trigger is emitted and the results are stored in an array variable list.

"listplaylists"
    upon completion mpd-playlists trigger is emitted and the results are available using MpdInfo("playlists") function.

  MpdInfo(<Query>)

Function MpdInfo queries the state of the MPD server. The function provides an interface to query the current value of any tag of the status and currentsong MPD protocol commands. The values are returned as strings. In addition, MpdInfo supports a few additional query values:

"age"
    time (in microseconds) elapsed since the MPD server state was last queried (this is useful in computing the progress of the current song playback).

"cover"
    the cover art of the currently playing album.

Triggers

The module defines two triggers:

"mpd"
    Emitted whenever the state of the MPD server changes.

"mpd-error"
    Emitted when MPD server returns an error. An error string is provided in the string variable message.

"mpd-list"
    Emitted upon completion of the list MPD protocol command. Results of the query are available in variable list.

"mpd-listplaylists"
    Emitted upon completion of the listplaylists MPD protocol command. Results of the query are available in variable list.

"mpd-search"
    Emitted upon completion of the search or find MPD protocol commands. Results of the query can be retrieved using MpdList function.

"mpd-playlistinfo"
    Emitted upon completion of the playlistinfo MPD protocol command. Results of the query can be retrieved using MpdList function.

"mpd-listplaylistinfo"
    Emitted upon completion of the listplaylistinfo MPD protocol command. Results of the query can be retrieved using MpdList function.

Copyright
GPLv3+