lib/Audio/MPD/Common.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 Audio::MPD::Common;
  11
  12 use warnings;
  13 use strict;
  14 our $VERSION = '0.1.2';
  15
  16 1;
  17
  18 __END__
  19
  20
  21 =head1 NAME
  22
  23 Audio::MPD::Common - a bunch of common helper classes for mpd
  24
  25
  26 =head1 DESCRIPTION
  27
  28 Depending on whether you're using a POE-aware environment or not, people
  29 wanting to tinker with mpd (Music Player Daemon) will use either
  30 L<POE::Component::Client::MPD> or L<Audio::MPD>.
  31
  32 But even if the run-cores of those two modules differ completely, they
  33 are using the exact same common classes to represent the various mpd
  34 states and information.
  35
  36 Therefore, those common classes have been outsourced to
  37 L<Audio::MPD::Common>.
  38
  39 This module does not export any methods, but the dist provides the
  40 following classes that you can query with perldoc:
  41
  42 =over 4
  43
  44 =item o L<Audio::MPD::Common::Item>
  45
  46 =item o L<Audio::MPD::Common::Item::Directory>
  47
  48 =item o L<Audio::MPD::Common::Item::Playlist>
  49
  50 =item o L<Audio::MPD::Common::Item::Song>
  51
  52 =item o L<Audio::MPD::Common::Stats>
  53
  54 =item o L<Audio::MPD::Common::Status>
  55
  56 =item o L<Audio::MPD::Common::Time>
  57
  58 =back
  59
  60
  61 Note that those modules should not be of any use outside the two mpd
  62 modules afore-mentioned.
  63
  64
  65 =head1 SEE ALSO
  66
  67 =over 4
  68
  69 =item L<Audio::MPD>
  70
  71 =item L<POE::Component::Client::MPD>
  72
  73 =back
  74
  75
  76 =head1 AUTHOR
  77
  78 Jerome Quelin, C<< <jquelin at cpan.org> >>
  79
  80
  81 =head1 COPYRIGHT & LICENSE
  82
  83 Copyright (c) 2007 Jerome Quelin, all rights reserved.
  84
  85 This program is free software; you can redistribute it and/or modify
  86 it under the same terms as Perl itself.
  87
  88 =cut