NAME

Audio::MPD - Class for talking to MPD (Music Player Daemon) servers

SYNOPSIS

use Audio::MPD;

my $mpd = Audio::MPD->new();
$mpd->play();
sleep 10;
$mpd->next();

DESCRIPTION

Audio::MPD gives a clear object-oriented interface for talking to and controlling MPD (Music Player Daemon) servers. A connection to the MPD server is established as soon as a new Audio::MPD object is created. Commands are then sent to the server as the class's methods are called.

METHODS

Constructor

new( [$host] [, $port] [, $password] )

This is the constructor for Audio::MPD. One can specify a $hostname, a $port, and a $password.

If none is specified then defaults to environment vars MPD_HOST, MPD_PORT and MPD_PASSWORD. If those aren't set, defaults to 'localhost', 6600 and ''.

Controlling the server

$mpd->ping(): Sends a ping command to the mpd server.
$mpd->version(): Return the version number for the server we are connected to.
$mpd->kill(): Send a message to the MPD server telling it to shut down.
$mpd->password( [$password] ): Change password used to communicate with MPD server to $password. Empty string is assumed if $password is not supplied.
$mpd->updatedb( [$path] ): Force mpd to recan its collection. If $path (relative to MPD's music directory) is supplied, MPD will only scan it - otherwise, MPD will rescan its whole collection.
$mpd->urlhandlers(): Return an array of supported URL schemes.

Handling volume & output

$mpd->volume( [+][-]$volume ): Sets the audio output volume percentage to absolute $volume. If $volume is prefixed by '+' or '-' then the volume is changed relatively by that value.
$mpd->output_enable( $output ): Enable the specified audio output. $output is the ID of the audio output.
$mpd->output_disable( $output ): Disable the specified audio output. $output is the ID of the audio output.

Retrieving info from current state

$mpd->stats(): Return a hashref with the number of artists, albums, songs in the database, as well as mpd uptime, the playtime of the playlist / the database and the last update of the database
$mpd->status(): Return an Audio::MPD::Status object with various information on current MPD server settings. Check the embedded pod for more information on the available accessors.
$mpd->playlist( ): Return an arrayref of Audio::MPD::Item::Songs, one for each of the songs in the current playlist.
$mpd->pl_changes( $plversion ): Return a list with all the songs (as API::Song objects) added to the playlist since playlist $plversion.
$mpd->current( ): Return an Audio::MPD::Item::Song representing the song currently playing.
$mpd->song( [$song] ): Return an Audio::MPD::Item::Song representing the song number $song. If $song is not supplied, returns the current song.
$mpd->songid( [$songid] ): Return an Audio::MPD::Item::Song representing the song with id $songid. If $songid is not supplied, returns the current song.

Altering MPD settings

$mpd->repeat( [$repeat] ): Set the repeat mode to $repeat (1 or 0). If $repeat is not specified then the repeat mode is toggled.
$mpd->random( [$random] ): Set the random mode to $random (1 or 0). If $random is not specified then the random mode is toggled.
$mpd->fade( [$seconds] ): Enable crossfading and set the duration of crossfade between songs. If $seconds is not specified or $seconds is 0, then crossfading is disabled.

Controlling playback

$mpd->play( [$song] )

Begin playing playlist at song number $song. If no argument supplied, resume playing.

$mpd->playid( [$songid] )

Begin playing playlist at song ID $songid. If no argument supplied, resume playing.

$mpd->pause( [$state] )

Pause playback. If $state is 0 then the current track is unpaused, if $state is 1 then the current track is paused.

Note that if $state is not given, pause state will be toggled.

$mpd->stop()

Stop playback.

$mpd->next()

Play next song in playlist.

$mpd->prev()

Play previous song in playlist.

$mpd->seek( $time, [$song])

Seek to $time seconds in song number $song. If $song number is not specified then the perl module will try and seek to $time in the current song.

$mpd->seekid( $time, $songid )

Seek to $time seconds in song ID $songid. If $song number is not specified then the perl module will try and seek to $time in the current song.

Handling playlist

$mpd->add( $path ): Add the song identified by $path (relative to MPD's music directory) to the current playlist. No return value.
$mpd->delete( $song ): Remove song number $song from the current playlist. No return value.
$mpd->deleteid( $songid ): Remove the specified $songid from the current playlist. No return value.
$mpd->clear(): Remove all the songs from the current playlist. No return value.
$mpd->crop(): Remove all of the songs from the current playlist *except* the song currently playing.
$mpd->swap( $song1, $song2 ): Swap positions of song number $song1 and $song2 on the current playlist. No return value.
$mpd->swapid( $songid1, $songid2 ): Swap the postions of song ID $songid1 with song ID $songid2 on the current playlist. No return value.
$mpd->move( $song, $newpos ): Move song number $song to the position $newpos. No return value.
$mpd->moveid( $songid, $newpos ): Move song ID $songid to the position $newpos. No return value.
$mpd->shuffle(): Shuffle the current playlist. No return value.
$mpd->load( $playlist ): Load list of songs from specified $playlist file. No return value.
$mpd->save( $playlist ): Save the current playlist to a file called $playlist in MPD's playlist directory. No return value.
$mpd->rm( $playlist ): Delete playlist named $playlist from MPD's playlist directory. No return value.

Retrieving information from current playlist

$mpd->get_time_format( )

Returns the current position and duration of the current song. String is formatted at "M:SS/M:SS", with current time first and total time after.

$mpd->get_time_info( )

Return current timing information in various different formats contained in a hashref with the following keys:

minutes_so_far
seconds_so_far
time_so_far
minutes
seconds
percentage
time_total
seconds_total
seconds_left
time_left

Searching the collection

To search the collection, use the collection() accessor, returning the associated Audio::MPD::Collection object. You will then be able to call:

$mpd->collection->random_song();

See Audio::MPD::Collection documentation for more details on available methods.

AUTHORS

Jerome Quelin <jquelin@cpan.org>

Original code by Tue Abrahamsen <tue.abrahamsen@gmail.com>, documented by Nicholas J. Humfrey <njh@aelius.com>.

COPYRIGHT AND LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

To install Audio::MPD, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Audio::MPD

CPAN shell

perl -MCPAN -e shell
install Audio::MPD

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)