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->all_songs;

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

Handling the playlist¶

To update the playlist, use the "playlist()" accessor, returning the associated Audio::MPD::Playlist object. You will then be able to call:

    $mpd->playlist->clear;

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

host¶

The hostname where MPD is running. Defaults to environment var "MPD_HOST", then to 'localhost'. Note that "MPD_HOST" can be of the form "password@host:port" (each of "password@" or ":port" can be omitted).

port¶

The port that MPD server listens to. Defaults to environment var "MPD_PORT", then to parsed "MPD_HOST" (cf above), then to 6600.

password¶

The password to access special MPD functions. Defaults to environment var "MPD_PASSWORD", then to parsed "MPD_HOST" (cf above), then to empty string.

conntype¶

Change how the connection to mpd server is handled. It should be of a "CONNTYPE" type (cf Audio::MPD::Types). Use either the "reuse" string to reuse the same connection or "once" to open a new connection per command (default).

new¶

    my $mpd = Audio::MPD->new( \%opts );

This is the constructor for Audio::MPD. One can specify any of the attributes (cf above).

ping¶

    $mpd->ping;

Sends a ping command to the mpd server.

version¶

    my $version = $mpd->version;

Return mpd's version number as advertised during connection. Note that mpd returns protocol version when connected. This protocol version can differ from the real mpd version. eg, mpd version 0.13.2 is "speaking" and thus advertising version 0.13.0.

kill¶

    $mpd->kill;

Send a message to the MPD server telling it to shut down.

set_password¶

    $mpd->set_password( [$password] );

Change password used to communicate with MPD server to $password. Empty string is assumed if $password is not supplied.

updatedb¶

    $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.

urlhandlers¶

    my @handlers = $mpd->urlhandlers;

Return an array of supported URL schemes.

volume¶

    $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.

outputs¶

    my @outputs = $mpd->outputs( );

Return a list of "Audio::MPD::Common::Outputs" with all outputs available within MPD.

output_enable¶

    $mpd->output_enable( $output );

Enable the specified audio output. $output is the ID of the audio output.

output_disable¶

    $mpd->output_disable( $output );

Disable the specified audio output. $output is the ID of the audio output.

stats¶

    my $stats = $mpd->stats;

Return an Audio::MPD::Common::Stats object with the current statistics of MPD. See the associated pod for more information.

status¶

    my $status = $mpd->status;

Return an Audio::MPD::Common::Status object with various information on current MPD server settings. See the associated pod for more information.

current¶

    my $song = $mpd->current;

Return an Audio::MPD::Common::Item::Song representing the song currently playing.

song¶

    my $song = $mpd->song( [$song] );

Return an Audio::MPD::Common::Item::Song representing the song number $song. If $song is not supplied, returns the current song.

songid¶

    my $song = $mpd->songid( [$songid] );

Return an Audio::MPD::Common::Item::Song representing the song with id $songid. If $songid is not supplied, returns the current song.

repeat¶

    $mpd->repeat( [$repeat] );

Set the repeat mode to $repeat (1 or 0). If $repeat is not specified then the repeat mode is toggled.

random¶

    $mpd->random( [$random] );

Set the random mode to $random (1 or 0). If $random is not specified then the random mode is toggled.

fade¶

    $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.

play¶

    $mpd->play( [$song] );

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

playid¶

    $mpd->playid( [$songid] );

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

pause¶

    $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.

stop¶

    $mpd->stop;

Stop playback.

next¶

    $mpd->next;

Play next song in playlist.

prev¶

    $mpd->prev;

Play previous song in playlist.

seek¶

    $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.

seekid¶

    $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.