/ 
POE-Component-Client-MPD-0.2.0
River stage one • 1 direct dependent • 1 total dependent
/ POE::Component::Client::MPD

NAME

POE::Component::Client::MPD - a full-blown mpd client library

SYNOPSIS

use POE qw[ Component::Client::MPD ];
POE::Component::Client::MPD->spawn( {
    host     => 'localhost',
    port     => 6600,
    password => 's3kr3t',  # mpd password
    alias    => 'mpd',     # poe alias
} );

# ... later on ...
$_[KERNEL]->post( 'mpd', 'next' );

DESCRIPTION

POCOCM gives a clear message-passing interface (sitting on top of POE) for talking to and controlling MPD (Music Player Daemon) servers. A connection to the MPD server is established as soon as a new POCOCM object is created.

Commands are then sent to the server as messages are passed.

PUBLIC PACKAGE METHODS

spawn( \%params )

This method will create a POE session responsible for communicating with mpd. It will return the poe id of the session newly created.

You can tune the pococm by passing some arguments as a hash reference, where the hash keys are:

  • host

    The hostname of the mpd server. If none given, defaults to MPD_HOST environment variable. If this var isn't set, defaults to localhost.

  • port

    The port of the mpd server. If none given, defaults to MPD_PORT environment variable. If this var isn't set, defaults to 6600.

  • password

    The password to sent to mpd to authenticate the client. If none given, defaults to MPD_PASSWORD environment variable. If this var isn't set, defaults to .

  • alias

    An optional string to alias the newly created POE session.

PUBLIC EVENTS

For a list of public events that you can send to a POCOCM session, check:

  • POCOCM::Commands for general commands

  • POCOCM::Playlist for playlist-related commands

  • POCOCM::Collection for collection-related commands

BUGS

Please report any bugs or feature requests to bug-poe-component-client-mpd at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POE-Component-Client-MPD. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SEE ALSO

You can find more information on the mpd project on its homepage at http://www.musicpd.org, or its wiki http://mpd.wikia.com.

POE::Component::Client::MPD development takes place on <audio-mpd at googlegroups.com>: feel free to join us. (use http://groups.google.com/group/audio-mpd to sign in). Our subversion repository is located at https://svn.musicpd.org.

You can also look for information on this module at:

AUTHOR

Jerome Quelin, <jquelin at cpan.org>

COPYRIGHT & LICENSE

Copyright 2007 Jerome Quelin, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA