Audio::MPD::Common::Status(3)

NAME
Audio::MPD::Common::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 mpd modules. Some of those information are served to you as an "Audio::MPD::Common::Status" object.

Note that an "Audio::MPD::Common::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 "Audio::MPD::Common::Status" class.

    Note: one should never ever instantiate an "Audio::MPD::Common::Status" object directly - use the mpd modules instead.

  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()
    An "Audio::MPD::Common::Time" object, representing the time elapsed / remainging and total. See the associated pod for more details.

$status->updating_db()
    An integer, representing the current update job.

$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 the mpd modules to alter the settings.

SEE ALSO

Audio::MPD
POE::Component::Client::MPD

AUTHOR
Jerome Quelin, "<jquelin at cpan.org>"

COPYRIGHT & LICENSE
Copyright (c) 2007 Jerome Quelin, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.