lib/Audio/MPD/Common/Stats.pm

   1 #
   2 # This file is part of Audio::MPD::Common
   3 # Copyright (c) 2007 Jerome Quelin, all rights reserved.
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the same terms as Perl itself.
   7 #
   8 #
   9
  10 package POE::Component::Client::MPD::Stats;
  11
  12 use warnings;
  13 use strict;
  14
  15 use base qw[ Class::Accessor::Fast ];
  16 __PACKAGE__->mk_accessors
  17     ( qw[ artists albums songs uptime playtime db_playtime db_update ] );
  18
  19 #our ($VERSION) = '$Rev$' =~ /(\d+)/;
  20
  21 1;
  22
  23 __END__
  24
  25 =pod
  26
  27 =head1 NAME
  28
  29 Audio::MPD::Common::Stats - class representing MPD stats
  30
  31
  32 =head1 SYNOPSIS
  33
  34     print $stats->artists;
  35
  36
  37 =head1 DESCRIPTION
  38
  39 The MPD server maintains some general information. Those information can be
  40 queried with the mpd modules. Some of those information are served to you as
  41 an C<Audio::MPD::Common::Status> object.
  42
  43 Note that an C<Audio::MPD::Common::Stats> object does B<not> update itself
  44 regularly, and thus should be used immediately.
  45
  46
  47 =head1 METHODS
  48
  49 =head2 Constructor
  50
  51 =over 4
  52
  53 =item new( %kv )
  54
  55 The C<new()> method is the constructor for the C<Audio::MPD::Common::Stats>
  56 class.
  57
  58 Note: one should B<never> ever instantiate an C<Audio::MPD::Common::Stats>
  59 object directly - use the mpd modules instead.
  60
  61 =back
  62
  63
  64 =head2 Accessors
  65
  66 Once created, one can access to the following members of the object:
  67
  68 =over 4
  69
  70 =item $stats->artists()
  71
  72 Number of artists in the music database.
  73
  74
  75 =item $stats->albums()
  76
  77 Number of albums in the music database.
  78
  79
  80 =item $stats->songs()
  81
  82 Number of songs in the music database.
  83
  84
  85 =item $stats->uptime()
  86
  87 Daemon uptime (time since last startup) in seconds.
  88
  89
  90 =item $stats->playtime()
  91
  92 Time length of music played.
  93
  94
  95 =item $stats->db_playtime()
  96
  97 Sum of all song times in the music database.
  98
  99
 100 =item $stats->db_update()
 101
 102 Last database update in UNIX time.
 103
 104
 105 =back
 106
 107
 108 Please note that those accessors are read-only: changing a value will B<not>
 109 change the current settings of MPD server. Use the mpd modules to alter the
 110 settings.
 111
 112
 113 =head1 SEE ALSO
 114
 115 =over 4
 116
 117 =item L<Audio::MPD>
 118
 119 =item L<POE::Component::Client::MPD>
 120
 121 =back
 122
 123
 124 =head1 AUTHOR
 125
 126 Jerome Quelin, C<< <jquelin at cpan.org> >>
 127
 128
 129 =head1 COPYRIGHT & LICENSE
 130
 131 Copyright (c) 2007 Jerome Quelin, all rights reserved.
 132
 133 This program is free software; you can redistribute it and/or modify
 134 it under the same terms as Perl itself.
 135
 136 =cut