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