lib/Audio/MPD/Common/Stats.pm

   1 use strict;
   2 use warnings;
   3
   4 package Audio::MPD::Common::Stats;
   5 # ABSTRACT: class representing MPD stats
   6
   7 use Moose;
   8
   9
  10 # -- public attributes
  11
  12 =attr $stats->artists;
  13
  14 Number of artists in the music database.
  15
  16 =attr $stats->albums;
  17
  18 Number of albums in the music database.
  19
  20 =attr $stats->songs;
  21
  22 Number of songs in the music database.
  23
  24 =attr $stats->uptime;
  25
  26 Daemon uptime (time since last startup) in seconds.
  27
  28 =attr $stats->playtime;
  29
  30 Time length of music played.
  31
  32 =attr $stats->db_playtime;
  33
  34 Sum of all song times in the music database.
  35
  36 =attr $stats->db_update;
  37
  38 Last database update in UNIX time.
  39
  40 =cut
  41
  42 has artists     => ( is=>'ro', isa=>'Int', required=>1 );
  43 has albums      => ( is=>'ro', isa=>'Int', required=>1 );
  44 has songs       => ( is=>'ro', isa=>'Int', required=>1 );
  45 has uptime      => ( is=>'ro', isa=>'Int', required=>1 );
  46 has playtime    => ( is=>'ro', isa=>'Int', required=>1 );
  47 has db_playtime => ( is=>'ro', isa=>'Int', required=>1 );
  48 has db_update   => ( is=>'ro', isa=>'Int', required=>1 );
  49
  50
  51 1;
  52 __END__
  53
  54 =head1 DESCRIPTION
  55
  56 The MPD server maintains some general information. Those information can
  57 be queried with the mpd modules. Some of those information are served to
  58 you as an L<Audio::MPD::Common::Status> object.
  59
  60 An L<Audio::MPD::Common::Stats> object does B<not> update itself
  61 regularly, and thus should be used immediately.
  62
  63 Note: one should B<never> ever instantiate an L<Audio::MPD::Common::Stats>
  64 object directly - use the mpd modules instead.