Files
bpfire/config/mpfire/perl/Audio/MPD/Common/Stats.pm
Christian Schmidt 83d20a4555 Finalized core13 and redirector fixes
Added some files to core14
First Beta of MPFire V3
2008-05-12 15:58:31 +02:00

136 lines
2.3 KiB
Perl

#
# This file is part of Audio::MPD::Common
# 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.
#
#
package Audio::MPD::Common::Stats;
use warnings;
use strict;
use base qw[ Class::Accessor::Fast ];
__PACKAGE__->mk_accessors
( qw[ artists albums songs uptime playtime db_playtime db_update ] );
#our ($VERSION) = '$Rev$' =~ /(\d+)/;
1;
__END__
=head1 NAME
Audio::MPD::Common::Stats - class representing MPD stats
=head1 SYNOPSIS
print $stats->artists;
=head1 DESCRIPTION
The MPD server maintains some general information. Those information can be
queried with the mpd modules. Some of those information are served to you as
an C<Audio::MPD::Common::Status> object.
Note that an C<Audio::MPD::Common::Stats> object does B<not> update itself
regularly, and thus should be used immediately.
=head1 METHODS
=head2 Constructor
=over 4
=item new( %kv )
The C<new()> method is the constructor for the C<Audio::MPD::Common::Stats>
class.
Note: one should B<never> ever instantiate an C<Audio::MPD::Common::Stats>
object directly - use the mpd modules instead.
=back
=head2 Accessors
Once created, one can access to the following members of the object:
=over 4
=item $stats->artists()
Number of artists in the music database.
=item $stats->albums()
Number of albums in the music database.
=item $stats->songs()
Number of songs in the music database.
=item $stats->uptime()
Daemon uptime (time since last startup) in seconds.
=item $stats->playtime()
Time length of music played.
=item $stats->db_playtime()
Sum of all song times in the music database.
=item $stats->db_update()
Last database update in UNIX time.
=back
Please note that those accessors are read-only: changing a value will B<not>
change the current settings of MPD server. Use the mpd modules to alter the
settings.
=head1 SEE ALSO
=over 4
=item L<Audio::MPD>
=item L<POE::Component::Client::MPD>
=back
=head1 AUTHOR
Jerome Quelin, C<< <jquelin at cpan.org> >>
=head1 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.
=cut