Blah
consume {STATE}
Sets consume state to STATE, STATE should be 0 or 1. When consume is activated, each song played is removed from playlist.
STATE
crossfade {SECONDS}
Sets crossfading between songs.
mixrampdb {deciBels}
Sets the threshold at which songs will be overlapped. Like crossfading but doesn't fade the track volume, just overlaps. The songs need to have MixRamp tags added by an external tool. 0dB is the normalized maximum volume so use negative values, I prefer -17dB. In the absence of mixramp tags crossfading will be used. See http://sourceforge.net/projects/mixramp
mixrampdelay {SECONDS}
Additional time subtracted from the overlap calculated by mixrampdb. A value of "nan" disables MixRamp overlapping and falls back to crossfading.
random {STATE}
Sets random state to STATE, STATE should be 0 or 1.
repeat {STATE}
Sets repeat state to STATE, STATE should be 0 or 1.
setvol {VOL}
Sets volume to VOL, the range of volume is 0-100.
VOL
single {STATE}
Sets single state to STATE, STATE should be 0 or 1. When single is activated, playback is stopped after current song, or song is repeated if the 'repeat' mode is enabled.
replay_gain_mode {MODE}
Sets the replay gain mode. One of off, track, album, auto.
off
track
album
auto
Changing the mode during playback may take several seconds, because the new settings does not affect the buffered data.
This command triggers the options idle event.
options
replay_gain_status
Prints replay gain options. Currently, only the variable replay_gain_mode is returned.
replay_gain_mode
volume {CHANGE}
Changes volume by amount CHANGE.
CHANGE
Note: volume is deprecated, use setvol instead.
volume
setvol
next
Plays next song in the playlist.
pause {PAUSE}
Toggles pause/resumes playing, PAUSE is 0 or 1.
PAUSE
Note: The use of pause command w/o the PAUSE argument is deprecated.
pause
play [SONGPOS]
Begins playing the playlist at song number SONGPOS.
SONGPOS
playid [SONGID]
Begins playing the playlist at song SONGID.
SONGID
previous
Plays previous song in the playlist.
seek {SONGPOS} {TIME}
Seeks to the position TIME (in seconds; fractions allowed) of entry SONGPOS in the playlist.
TIME
seekid {C<SONGID>} {TIME}
Seeks to the position TIME (in seconds; fractions allowed) of song SONGID.
seekcur {TIME}
Seeks to the position TIME (in seconds; fractions allowed) within the current song. If prefixed by '+' or '-', then the time is relative to the current playing position.
stop
Stops playing.
add {URI}
Adds the file URI to the playlist (directories add recursively). URI can also be a single file.
URI
addid {URI} [POSITION]
Adds a song to the playlist (non-recursive) and returns the song id.
URI is always a single file or URL. For example:
addid "foo.mp3" Id: 999 OK
clear
Clears the current playlist.
delete [{POS} | {START:END}]
Deletes a song from the playlist.
deleteid {SONGID}
Deletes the song SONGID from the playlist
move [{FROM} | {START:END}] {TO}
Moves the song at FROM or range of songs at START:END to TO in the playlist.
FROM
START:END
TO
moveid {FROM} {TO}
Moves the song with FROM (songid) to TO (playlist index) in the playlist. If TO is negative, it is relative to the current song in the playlist (if there is one).
songid
playlist
Displays the current playlist.
Note: Do not use this, instead use playlistinfo.
playlistinfo
playlistfind {TAG} {NEEDLE}
Finds songs in the current playlist with strict matching.
playlistid {SONGID}
Displays a list of songs in the playlist. SONGID is optional and specifies a single song to display info for.
playlistinfo [[SONGPOS] | [START:END]]
Displays a list of all songs in the playlist, or if the optional argument is given, displays information only for the song SONGPOS or the range of songs START:END.
playlistsearch {TAG} {NEEDLE}
Searches case-insensitively for partial matches in the current playlist.
plchanges {VERSION} [START:END]
Displays changed songs currently in the playlist since VERSION. Start and end positions may be given to limit the output to changes in the given range.
VERSION
To detect songs that were deleted at the end of the playlist, use playlistlength returned by status command.
plchangesposid {VERSION} [START:END]
Displays changed songs currently in the playlist since VERSION. This function only returns the position and the id of the changed song, not the complete metadata. This is more bandwidth efficient.
prio {PRIORITY} {START:END...}
Set the priority of the specified songs. A higher priority means that it will be played first when "random" mode is enabled.
A priority is an integer between 0 and 255. The default priority of new songs is 0.
prioid {PRIORITY} {ID...}
Same as prio, but address the songs with their id.
rangeid {ID} {START:END}
Specifies the portion of the song that shall be played. START and END are offsets in seconds (fractional seconds allowed); both are optional. Omitting both (i.e. sending just ":") means "remove the range, play everything". A song that is currently playing cannot be manipulated this way.
START
END
shuffle [START:END]
Shuffles the current playlist. START:END is optional and specifies a range of songs.
swap {SONG1} {SONG2}
Swaps the positions of SONG1 and SONG2.
SONG1
SONG2
swapid {SONG1} {SONG2}
Swaps the positions of SONG1 and SONG2 (both song ids).
addtagid {SONGID} {TAG} {VALUE}
Adds a tag to the specified song. Editing song tags is only possible for remote songs. This change is volatile: it may be overwritten by tags received from the server, and the data is gone when the song gets removed from the queue.
cleartagid {SONGID} [TAG]
Removes tags from the specified song. If TAG is not specified, then all tag values will be removed. Editing song tags is only possible for remote songs.
TAG
Playlists are stored inside the configured playlist directory. They are addressed with their file name (without the directory and without the .m3u suffix).
Some of the commands described in this section can be used to run playlist plugins instead of the hard-coded simple m3u parser. They can access playlists in the music directory (relative path including the suffix) or remote playlists (absolute URI with a supported scheme).
listplaylist {NAME}
Lists the songs in the playlist. Playlist plugins are supported.
listplaylistinfo {NAME}
Lists the songs with metadata in the playlist. Playlist plugins are supported.
listplaylists
Prints a list of the playlist directory.
After each playlist name the server sends its last modification time as attribute "Last-Modified" in ISO 8601 format. To avoid problems due to clock differences between clients and the server, clients should not compare this value with their local clock.
load {NAME} [START:END]
Loads the playlist into the current queue. Playlist plugins are supported. A range may be specified to load only a part of the playlist.
playlistadd {NAME} {URI}
Adds URI to the playlist NAME.m3u.
NAME.m3u
NAME.m3u will be created if it does not exist.
playlistclear {NAME}
Clears the playlist NAME.m3u.
playlistdelete {NAME} {SONGPOS}
Deletes SONGPOS from the playlist NAME.m3u.
playlistmove {NAME} {FROM} {TO}
Moves the song at position FROM in the playlist NAME.m3u to the position TO.
rename {NAME} {NEW_NAME}
Renames the playlist NAME.m3u to NEW_NAME.m3u.
NEW_NAME.m3u
rm {NAME}
Removes the playlist NAME.m3u from the playlist directory.
save {NAME}
Saves the current playlist to NAME.m3u in the playlist directory.
count {TAG} {NEEDLE} [...] [group] [GROUPTYPE]
Counts the number of songs and their total playtime in the db matching TAG exactly.
The group keyword may be used to group the results by a tag. The following prints per-artist counts:
count group artist
find {TYPE} {WHAT} [...] [sort TYPE] [window START:END]
Finds songs in the db that are exactly WHAT. TYPE can be any tag supported by MPD, or one of the special parameters:
WHAT
TYPE
any checks all tag values
file checks the full path (relative to the music directory)
base restricts the search to songs in the given directory (also relative to the music directory)
modified-since compares the file's time stamp with the given value (ISO 8601 or UNIX time stamp)
WHAT is what to find.
sort sorts the result by the specified tag. Without sort, the order is undefined. Only the first tag value will be used, if multiple of the same type exist. To sort by "Artist", "Album" or "AlbumArtist", you should specify "ArtistSort", "AlbumSort" or "AlbumArtistSort" instead. These will automatically fall back to the former if "*Sort" doesn't exist. "AlbumArtist" falls back to just "Artist".
window can be used to query only a portion of the real response. The parameter is two zero-based record numbers; a start number and an end number.
findadd {TYPE} {WHAT} [...]
Finds songs in the db that are exactly WHAT and adds them to current playlist. Parameters have the same meaning as for find.
list {TYPE} [FILTERTYPE] [FILTERWHAT] [...] [group] [GROUPTYPE] [...]
Lists unique tags values of the specified type. TYPE can be any tag supported by MPD or file.
Additional arguments may specify a filter like the one in the find command.
The group keyword may be used (repeatedly) to group the results by one or more tags. The following example lists all album names, grouped by their respective (album) artist:
list album group albumartist
listall [URI]
Lists all songs and directories in URI.
Do not use this command. Do not manage a client-side copy of MPD's database. That is fragile and adds huge overhead. It will break with large databases. Instead, query MPD whenever you need something.
listallinfo [URI]
Same as listall, except it also returns metadata info in the same format as lsinfo.
listfiles [URI]
Lists the contents of the directory URI, including files are not recognized by MPD. URI can be a path relative to the music directory or an URI understood by one of the storage plugins. The response contains at least one line for each directory entry with the prefix "file: " or "directory: ", and may be followed by file attributes such as "Last-Modified" and "size".
For example, "smb://SERVER" returns a list of all shares on the given SMB/CIFS server; "nfs://servername/path" obtains a directory listing from the NFS server.
lsinfo [URI]
Lists the contents of the directory URI.
When listing the root directory, this currently returns the list of stored playlists. This behavior is deprecated; use "listplaylists" instead.
This command may be used to list metadata of remote files (e.g. URI beginning with "http://" or "smb://").
Clients that are connected via UNIX domain socket may use this command to read the tags of an arbitrary local file (URI is an absolute path).
readcomments [URI]
Read "comments" (i.e. key-value pairs) from the file specified by URI. This URI can be a path relative to the music directory or an absolute path.
The response consists of lines in the form KEY: VALUE. Comments with suspicious characters (e.g. newlines) are ignored silently.
KEY: VALUE
The meaning of these depends on the codec, and not all decoder plugins support it. For example, on Ogg files, this lists the Vorbis comments.
search {TYPE} {WHAT} [...] [sort TYPE] [window START:END]
Searches for any song that contains WHAT. Parameters have the same meaning as for find, except that search is not case sensitive.
searchadd {TYPE} {WHAT} [...]
Searches for any song that contains WHAT in tag TYPE and adds them to current playlist.
Parameters have the same meaning as for find, except that search is not case sensitive.
searchaddpl {NAME} {TYPE} {WHAT} [...]
Searches for any song that contains WHAT in tag TYPE and adds them to the playlist named NAME.
NAME
If a playlist by that name doesn't exist it is created.
update [URI]
Updates the music database: find new files, remove deleted files, update modified files.
URI is a particular directory or song/file to update. If you do not specify it, everything is updated.
Prints updating_db: JOBID where JOBID is a positive number identifying the update job. You can read the current job id in the status response.
updating_db: JOBID
JOBID
rescan [URI]
Same as update, but also rescans unmodified files.
A "storage" provides access to files in a directory tree. The most basic storage plugin is the "local" storage plugin which accesses the local file system, and there are plugins to access NFS and SMB servers.
Multiple storages can be "mounted" together, similar to the mount command on many operating systems, but without cooperation from the kernel. No superuser privileges are necessary, beause this mapping exists only inside the MPD process
mount {PATH} {URI}
Mount the specified remote storage URI at the given path. Example:
mount foo nfs://192.168.1.4/export/mp3
unmount {PATH}
Unmounts the specified path. Example:
unmount foo
listmounts
Queries a list of all mounts. By default, this contains just the configured music_directory. Example:
listmounts mount: storage: /home/foo/music mount: foo storage: nfs://192.168.1.4/export/mp3 OK
listneighbors
Queries a list of "neighbors" (e.g. accessible file servers on the local net). Items on that list may be used with the mount command. Example:
listneighbors neighbor: smb://FOO name: FOO (Samba 4.1.11-Debian) OK
"Stickers" are pieces of information attached to existing MPD objects (e.g. song files, directories, albums). Clients can create arbitrary name/value pairs. MPD itself does not assume any special meaning in them.
The goal is to allow clients to share additional (possibly dynamic) information about songs, which is neither stored on the client (not available to other clients), nor stored in the song files (MPD has no write access).
Client developers should create a standard for common sticker names, to ensure interoperability.
Objects which may have stickers are addressed by their object type ("song" for song objects) and their URI (the path within the database for songs).
sticker get {TYPE} {URI} {NAME}
Reads a sticker value for the specified object.
sticker set {TYPE} {URI} {NAME} {VALUE}
Adds a sticker value to the specified object. If a sticker item with that name already exists, it is replaced.
sticker delete {TYPE} {URI} [NAME]
Deletes a sticker value from the specified object. If you do not specify a sticker name, all sticker values are deleted.
sticker list {TYPE} {URI}
Lists the stickers for the specified object.
sticker find {TYPE} {URI} {NAME}
Searches the sticker database for stickers with the specified name, below the specified directory (URI). For each matching song, it prints the URI and that one sticker's value.
sticker find {TYPE} {URI} {NAME} = {VALUE}
Searches for stickers with the given value.
Other supported operators are: "<", ">"
close
Closes the connection to MPD. MPD will try to send the remaining output buffer before it actually closes the connection, but that cannot be guaranteed. This command will not generate a response.
kill
Kills MPD.
password {PASSWORD}
This is used for authentication with the server. PASSWORD is simply the plaintext password.
PASSWORD
ping
Does nothing but return OK.
OK
tagtypes
Shows a list of available tag types. It is an intersection of the metadata_to_use setting and this client's tag mask.
About the tag mask: each client can decide to disable any number of tag types, which will be omitted from responses to this client. That is a good idea, because it makes responses smaller. The following tagtypes sub commands configure this list.
tagtypes disable {NAME...}
Remove one or more tags from the list of tag types the client is interested in. These will be omitted from responses to this client.
tagtypes enable {NAME...}
Re-enable one or more tags from the list of tag types for this client. These will no longer be hidden from responses to this client.
tagtypes clear
Clear the list of tag types this client is interested in. This means that MPD will not send any tags to this client.
tagtypes all
Announce that this client is interested in all tag types. This is the default setting for new clients.
These commands allow a client to inspect and manage "partitions". A partition is one frontend of a multi-player MPD process: it has separate queue, player and outputs. A client is assigned to one partition at a time.
partition {NAME}
Switch the client to a different partition.
listpartitions
Print a list of partitions. Each partition starts with a partition keyword and the partition's name, followed by information about the partition.
newpartition {NAME}
Create a new partition.
disableoutput {ID}
Turns an output off.
enableoutput {ID}
Turns an output on.
toggleoutput {ID}
Turns an output on or off, depending on the current state.
outputs
Shows information about all outputs.
outputid: 0 outputname: My ALSA Device outputenabled: 0 OK
Return information:
outputid: ID of the output. May change between executions
outputname: Name of the output. It can be any.
outputenabled: Status of the output. 0 if disabled, 1 if enabled.
config
Dumps configuration values that may be interesting for the client. This command is only permitted to "local" clients (connected via UNIX domain socket).
The following response attributes are available: Name Description music_directory The absolute path of the music directory.
commands
Shows which commands the current user has access to.
notcommands
Shows which commands the current user does not have access to.
urlhandlers
Gets a list of available URL handlers.
decoders
Print a list of decoder plugins, followed by their supported suffixes and MIME types. Example response:
plugin: mad suffix: mp3 suffix: mp2 mime_type: audio/mpeg plugin: mpcdec suffix: mpc
subscribe {NAME}
Subscribe to a channel. The channel is created if it does not exist already. The name may consist of alphanumeric ASCII characters plus underscore, dash, dot and colon.
unsubscribe {NAME}
Unsubscribe from a channel.
channels
Obtain a list of all channels. The response is a list of "channel:" lines.
readmessages
Reads messages for this client. The response is a list of "channel:" and "message:" lines.
sendmessage {CHANNEL} {TEXT}
Send a message to the specified channel.
To install Net::Async::MPD, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::Async::MPD
CPAN shell
perl -MCPAN -e shell install Net::Async::MPD
For more information on module installation, please visit the detailed CPAN module installation guide.