The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Audio-MPD-0.13.4
River stage one • 1 direct dependent • 1 total dependent
++
/ Audio::MPD::Status

NAME

Audio::MPD::Status - class representing MPD status

SYNOPSIS

    my $status = $mpd->status;

DESCRIPTION

The MPD server maintains some information on its current state. Those information can be queried with the status() method of Audio::MPD. This method returns an Audio::MPD::Status object, containing all relevant information.

Note that an Audio::MPD::Status object does not update itself regularly, and thus should be used immediately.

METHODS

Constructor

new( @output )

The new() method is the constructor for the Audio::MPD::Status class. It is called internally by the status() method of Audio::MPD, with the result of the status command sent to MPD server.

Note: one should never ever instantiate an Audio::MPD::Status object directly - use the status() method of Audio::MPD.

Accessors

Once created, one can access to the following members of the object:

audio()

A string with the sample rate of the song currently playing, number of bits of the output and number of channels (2 for stereo) - separated by a colon.

bitrate()

The instantaneous bitrate in kbps.

error()

May appear in special error cases, such as when disabling output.

playlist()

The playlist version number, that changes every time the playlist is updated.

playlistlength()

The number of songs in the playlist.

random()

Whether the playlist is read randomly or not.

repeat()

Whether the song is repeated or not.

song()

The offset of the song currently played in the playlist.

songid()

The song id (MPD id) of the song currently played.

state()

The state of MPD server. Either play, stop or pause.

time()

A string with the time played so far and the total time of the current song, separated by a colon.

volume()

The current MPD volume - an integer between 0 and 100.

xfade()

The crossfade in seconds.

Please note that those accessors are read-only: changing a value will not change the current settings of MPD server. Use Audio::MPD methods to alter the settings.

SEE ALSO

You can find more information on the mpd project on its homepage at http://www.musicpd.org, or its wiki http://mpd.wikia.com.

Regarding this Perl module, you can report bugs on CPAN via http://rt.cpan.org/Public/Bug/Report.html?Queue=Audio-MPD.

Audio::MPD development takes place on <audio-mpd@googlegroups.com>: feel free to join us. (use http://groups.google.com/group/audio-mpd to sign in). Our subversion repository is located at https://svn.musicpd.org.

AUTHORS

Jerome Quelin <jquelin@cpan.org>

COPYRIGHT AND LICENSE

Copyright (c) 2007 Jerome Quelin <jquelin@cpan.org>

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.