/ 
Net-Shoutcast-Admin-0.02
River stage zero No dependents
/ Net::Shoutcast::Admin

NAME

Net::Shoutcast::Admin - administration of Shoutcast servers

VERSION

This document describes Net::Shoutcast::Admin version 0.0.2

SYNOPSIS

  use Net::Shoutcast::Admin;

  my $shoutcast = Net::Shoutcast::Admin->new(
                                  host => 'server hostname',
                                  port => 8000,
                                  admin_password => 'mypassword',
  );
  
  if ($shoutcast->source_connected) {
      printf "%s is currently playing %s by %s",
          $shoutcast->dj_name,
          $shoutcast->currentsong->title,
          $shoutcast->currentsong->artist
      ;
  } else {
      print "No source is currently connected.";
  }

DESCRIPTION

A module to interact with Shoutcast servers to retrieve information about their current status (and perhaps in later versions of the module, to also control the server in various ways).

INTERFACE

new

$shoutcast = Net::Shoutcast::Admin->new( %params );

Creates a new Net::Shoutcast::Admin object. Takes a hash of options as follows:

host

The hostname of the Shoutcast server you wish to query.

port

The port on which Shoutcast is running. Defaults to 8000 if not specified.

admin_password

The admin password for the Shoutcast server.

timeout

The number of seconds to wait for a response. Defaults to 10 seconds if not specified.

agent

The HTTP User-Agent header which will be sent in HTTP requests to the Shoutcast server. If not supplied, a suitable default will be used.

currentsong

Returns a Net::Shoutcast::Admin::Song object representing the current song.

song_history

Returns a list of Net::Shoutcast::Admin::Song objects representing the the last few songs played

listeners

In scalar context, returns the number of listeners currently connected. In list context, returns a list of Net::Shoutcast::Admin::Listener objects representing each listener.

source_connected

Returns true if the stream is currently up (a source is connected and streaming audio to the server)

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-net-shoutcast-admin@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

David Precious <davidp@preshweb.co.uk>

LICENCE AND COPYRIGHT

Copyright (c) 2008, David Precious <davidp@preshweb.co.uk>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.