lib/Audio/MPD/Common/Status.pm

   1 use strict;
   2 use warnings;
   3
   4 package Audio::MPD::Common::Status;
   5 # ABSTRACT: class representing MPD status
   6
   7 use Moose;
   8 use Moose::Util::TypeConstraints;
   9 use Audio::MPD::Common::Time;
  10
  11 subtype 'Int_0_100'
  12       => as 'Int'
  13       => where { $_ >= 0 && $_ <= 100 }
  14       => message { "$_ is not between 0 and 100" };
  15 enum 'State' => qw{ play stop pause };
  16 coerce 'Audio::MPD::Common::Time'
  17     => from 'Str'
  18     => via { Audio::MPD::Common::Time->new($_) };
  19
  20
  21 # -- attributes
  22
  23 =attr $status->audio()
  24
  25 A string with the sample rate of the song currently playing, number of
  26 bits of the output and number of channels (2 for stereo) - separated
  27 by a colon.
  28
  29 =attr $status->bitrate()
  30
  31 The instantaneous bitrate in kbps.
  32
  33 =attr $status->error()
  34
  35 May appear in special error cases, such as when disabling output.
  36
  37 =attr $status->playlist()
  38
  39 The playlist version number, that changes every time the playlist
  40 is updated.
  41
  42 =attr $status->playlistlength()
  43
  44 The number of songs in the playlist.
  45
  46 =attr $status->random()
  47
  48 Whether the playlist is read randomly or not.
  49
  50 =attr $status->repeat()
  51
  52 Whether the song is repeated or not.
  53
  54 =attr $status->song()
  55
  56 The offset of the song currently played in the playlist.
  57
  58 =attr $status->songid()
  59
  60 The song id (MPD id) of the song currently played.
  61
  62 =attr $status->state()
  63
  64 The state of MPD server. Either C<play>, C<stop> or C<pause>.
  65
  66 =attr $status->time()
  67
  68 An L<Audio::MPD::Common::Time> object, representing the time elapsed /
  69 remainging and total. See the associated pod for more details.
  70
  71 =attr $status->updating_db()
  72
  73 An integer, representing the current update job.
  74
  75 =attr $status->volume()
  76
  77 The current MPD volume - an integer between 0 and 100.
  78
  79 =attr $status->xfade()
  80
  81 The crossfade in seconds.
  82
  83 =cut
  84
  85 has audio          => ( is=>'ro', required=>1, isa=>'Str' );
  86 has bitrate        => ( is=>'ro', required=>1, isa=>'Int' );
  87 has error          => ( is=>'ro', required=>0, isa=>'Str' );
  88 has playlist       => ( is=>'ro', required=>1, isa=>'Int' );
  89 has playlistlength => ( is=>'ro', required=>1, isa=>'Int' );
  90 has random         => ( is=>'ro', required=>1, isa=>'Bool' );
  91 has repeat         => ( is=>'ro', required=>1, isa=>'Bool' );
  92 has songid         => ( is=>'ro', required=>1, isa=>'Int' );
  93 has song           => ( is=>'ro', required=>1, isa=>'Int' );
  94 has state          => ( is=>'ro', required=>1, isa=>'State' );
  95 has time           => ( is=>'ro', required=>1, isa=>'Audio::MPD::Common::Time', coerce=>1 );
  96 has updating_db    => ( is=>'ro', required=>1, isa=>'Int' );
  97 has volume         => ( is=>'ro', required=>1, isa=>'Int_0_100' );
  98 has xfade          => ( is=>'ro', required=>1, isa=>'Int' );
  99
 100
 101 1;
 102 __END__
 103
 104 =head1 DESCRIPTION
 105
 106 The MPD server maintains some information on its current state. Those
 107 information can be queried with mpd modules. Some of those information
 108 are served to you as an L<Audio::MPD::Common::Status> object.
 109
 110 An L<Audio::MPD::Common::Status> object does B<not> update itself
 111 regularly, and thus should be used immediately.
 112
 113 Note: one should B<never> ever instantiate an L<Audio::MPD::Common::Status>
 114 object directly - use the mpd modules instead.