NAME

POE::Component::Client::MPD::Status - class representing MPD status

SYNOPSIS

print $status->bitrate;

DESCRIPTION

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

Note that a POCOCM::Status object does not update itself regularly, and thus should be used immediately.

METHODS

Constructor

new( \%kv )

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

Note: one should never ever instantiate an POCOCM::Status object directly - use the status() message of POCOCM.

Accessors

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

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

$status->bitrate()

The instantaneous bitrate in kbps.

$status->error()

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

$status->playlist()

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

$status->playlistlength()

The number of songs in the playlist.

$status->random()

Whether the playlist is read randomly or not.

$status->repeat()

Whether the song is repeated or not.

$status->song()

The offset of the song currently played in the playlist.

$status->songid()

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

$status->state()

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

$status->time()

A POCOCM::Time object, representing the time elapsed / remainging and total. See the associated pod for more details.

$status->volume()

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

$status->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 POCOCM messages to alter the settings.

SEE ALSO

For all related information (bug reporting, mailing-list, pointers to MPD and POE, etc.), refer to POE::Component::Client::MPD's pod, section SEE ALSO

AUTHOR

Jerome Quelin, <jquelin at cpan.org>

COPYRIGHT & LICENSE

Copyright 2007 Jerome Quelin, all rights reserved.

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.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA