Audio::XMMSClient::XMLRPC - XMLRPC interface to xmms2
Version 0.03
use Audio::XMMSClient::XMLRPC; my $rpc = Audio::XMMSClient::XMLRPC->new(); $rpc->loop;
my $rpc = Audio::XMMSClient::XMLRPC->new( \%options );
Creates a new Audio::XMMSClient::XMLRPC instance with the given %options. Valid options are:
%options
If passed with a "true" value, prevents the creation and storage of the HTTP::Daemon object. This allows for deployment of a server object in other environments. Note that if this is set, the loop method described below will silently attempt to use the Net::Server module.
If passed with a "true" value, prevents the loading of the default methods provided with the RPC::XML distribution. The methods themselves are described below (see "The Default Methods Provided").
These four are specific to the HTTP-based nature of the server. The path argument sets the additional URI path information that clients would use to contact the server. Internally, it is not used except in outgoing status and introspection reports. The host, port and queue arguments are passed to the HTTP::Daemon constructor if they are passed. They set the hostname, TCP/IP port, and socket listening queue, respectively. They may also be used if the server object tries to use Net::Server as an alternative server core.
$server->loop;
Enters the connection-accept loop, which generally does not return.
boolean playback_seek_ms (int)
Seek to a absolute time in the current playback.
boolean medialib_playlist_remove (string)
Remove a playlist from the medialib, keeping the songs of course.
boolean medialib_entry_property_remove (int, string)
Remove a custom field in the medialib associated with an entry.
boolean playlist_set_next (int)
Set next entry in the playlist.
int medialib_add_entry_args (string, struct)
Add a URL with arguments to the medialib.
boolean playlist_insert_args (int, string, struct)
Insert entry at given position in playlist wit args.
boolean medialib_entry_property_set_int_with_source (int, string, string, int)
Set a custom int field in the medialib associated with a entry, the same as xmms.medialib.entry_property.set_int but with specifing your own source.
boolean configval_set (string, string)
Sets a configvalue in the server.
boolean medialib_path_import_encoded (string)
Import a all files recursivly from the directory passed as argument which must already be url encoded.
array configval_list ()
Lists all configuration values.
int medialib_add_entry_encoded (string)
Add a URL to the medialib.
boolean playback_seek_samples_rel (int)
Seek to a number of samples relative to the current position in the current playback.
boolean playback_pause ()
Pause the current playback, will tell the output to not read nor write.
struct main_stats ()
Get a list of statistics from the server.
boolean medialib_entry_property_set_str_with_source (int, string, string, string)
Set a custom field in the medialib associated with a entry, the same as xmms.medialib.entry_property.set_str but with specifing your own source.
boolean medialib_playlist_export (string, string)
Export a serverside playlist to a format that could be read from another mediaplayer
string bindata_retrieve (string)
Retrieve some binary data identified by a given hash.
array medialib_select (string)
Make a SQL query to the server medialib.
boolean playlist_remove (int)
Remove an entry from the playlist.
boolean playlist_insert_id (int, int)
Insert a medialib id at given position in playlist.
boolean medialib_entry_property_set_str (int, string, string)
Associate a value with a medialib entry.
boolean playback_start ()
Starts playback if server is idle.
boolean playback_seek_samples (int)
Seek to a absoulte number of samples in the current playback.
boolean playlist_sort (string)
Sorts the playlist according to the property.
boolean playback_seek_ms_rel (int)
Seek to a time relative to the current position in the current playback.
int playback_status ()
Make server emit the playback status.
int playlist_current_pos ()
Retrive the current position in the playlist.
int medialib_get_id (string)
Search for a entry (URL) in the medialib db and return its ID number.
struct medialib_get_info (int)
Retrieve information about a entry from the medialib.
array xform_media_browse (string)
Browse available media in a path.
boolean playback_tickle ()
Stop decoding of current song.
array xform_media_browse_encoded (string)
Browse available media in a (already encoded) path.
boolean playlist_insert_encoded (int, string)
Insert entry at given position in playlist.
array plugin_list ()
Get a list of loaded plugins from the server.
boolean playlist_add_id (int)
Add a medialib id to the playlist.
struct playback_volume_get ()
Get the current volume.
boolean playlist_add (string)
Add the url to the playlist.
boolean playback_volume_set (string, int)
Set the volume on a given channel.
boolean medialib_playlist_save_current (string)
Save the current playlist to a serverside playlist.
boolean medialib_playlist_import (string, string)
Import a playlist from a playlist file.
boolean playlist_clear ()
Clears the current playlist.
boolean playlist_radd (string)
Adds a directory recursivly to the playlist.
boolean medialib_remove_entry (int)
Remove a entry from the medialib.
boolean medialib_rehash (int)
Rehash the medialib, this will check data in the medialib still is the same as the data in files.
boolean playlist_set_next_rel (int)
Same as xmms.playlist.set_next but relative to the current postion.
boolean configval_register (string, string)
Registers a config property in the server.
boolean medialib_add_to_playlist (string)
Queries the medialib for files and adds the matching ones to the current playlist.
boolean playlist_add_args (string, struct)
Add the url to the playlist with arguments.
boolean playlist_shuffle ()
Shuffles the current playlist.
boolean medialib_playlist_load (string)
Load a playlist from the medialib to the current active playlist.
boolean bindata_remove (string)
Remove some binary data identified by a given hash.
boolean medialib_entry_property_remove_with_source (int, string, string)
Remove a custom field in the medialib associated with an entry. Identical to xmms.medialib.entry_property.remove except with specifying your own source.
boolean playlist_insert (int, string)
boolean medialib_path_import (string)
Import a all files recursivly from the directory passed as argument.
boolean playlist_radd_encoded (string)
array playlist_list ()
List current playlist.
int medialib_add_entry (string)
string configval_get (string)
Retrives a list of configvalues in server.
string bindata_add (string)
Add some binary data to be stored in the server. Returns a string which uniquely identifies the data.
string userconfdir_get ()
Get the absolute path to the user config dir.
boolean quit ()
Tell the server to quit.
boolean playlist_add_encoded (string)
int playback_playtime ()
Request the playback_playtime signal.
array medialib_playlists_list ()
Returns a list of all available playlists.
boolean medialib_entry_property_set_int (int, string, int)
Associate a int value with a medialib entry.
boolean playback_stop ()
Stops the current playback.
array medialib_playlist_list (string)
This will make the server list the given playlist.
boolean playlist_move (int, int)
Move a playlist entry to a new position (absolute move).
int playback_current_id ()
Make server emit the current id.
The following methods are provided with this package, and are the ones installed on newly-created server objects unless told not to. These are identified by their published names, as they are compiled internally as anonymous subroutines and thus cannot be called directly:
returns a string value identifying the server name, version, and possibly a capability level. takes no arguments.
returns a series of struct objects that give overview documentation of one or more of the published methods. it may be called with a string identifying a single routine, in which case the return value is a struct. it may be called with an array of string values, in which case an array of struct values, one per element in, is returned. lastly, it may be called with no input parameters, in which case all published routines are documented. note that routines may be configured to be hidden from such introspection queries.
returns a list of the published methods or a subset of them as an array of string values. if called with no parameters, returns all (non-hidden) method names. if called with a single string pattern, returns only those names that contain the string as a substring of their name (case-sensitive, and this is i<not> a regular expression evaluation).
takes either a single method name as a string, or a series of them as an array of string. the return value is the help text for the method, as either a string or array of string value. if the method(s) have no help text, the string will be null.
as above, but returns the signatures that the method accepts, as array of string representations. if only one method is requests via a string parameter, then the return value is the corresponding array. if the parameter in is an array, then the returned value will be an array of array of string.
this is a simple implementation of composite function calls in a single request. it takes an array of struct values. each struct has at least a c<methodname> member, which provides the name of the method to call. if there is also a c<params> member, it refers to an array of the parameters that should be passed to the call.
takes no arguments and returns a struct containing a number of system status values including (but not limited to) the current time on the server, the time the server was started (both of these are returned in both iso 8601 and unix-style integer formats), number of requests dispatched, and some identifying information (hostname, port, etc.).
Florian Ragwitz, <rafl at debian.org>
<rafl at debian.org>
Please report any bugs or feature requests to bug-audio-xmmsclient-xmlrpc at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Audio-XMMSClient-XMLRPC. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-audio-xmmsclient-xmlrpc at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Audio::XMMSClient::XMLRPC
You can also look for information at:
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Audio-XMMSClient-XMLRPC
CPAN Ratings
http://cpanratings.perl.org/d/Audio-XMMSClient-XMLRPC
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Audio-XMMSClient-XMLRPC
Search CPAN
http://search.cpan.org/dist/Audio-XMMSClient-XMLRPC
Copyright 2006 Florian Ragwitz, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Audio::XMMSClient::XMLRPC, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Audio::XMMSClient::XMLRPC
CPAN shell
perl -MCPAN -e shell install Audio::XMMSClient::XMLRPC
For more information on module installation, please visit the detailed CPAN module installation guide.