view release on metacpan or  search on metacpan

lib/Audio/XMMSClient/XMLRPC.pm  view on Meta::CPAN

=item B<medialib_playlist_list>

    array medialib_playlist_list (string)

This will make the server list the given playlist.

=item B<playlist_move>

    boolean playlist_move (int, int)

Move a playlist entry to a new position (absolute move).

=item B<playback_current_id>

    int playback_current_id ()

Make server emit the current id.

=back

=head2 The Default Methods Provided

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:

=over

=item B<system.identity>

returns a B<string> value identifying the server name, version, and possibly a
capability level. takes no arguments.

=item B<system.introspection>

returns a series of B<struct> objects that give overview documentation of one
or more of the published methods. it may be called with a B<string>
identifying a single routine, in which case the return value is a
B<struct>. it may be called with an B<array> of B<string> values, in which
case an B<array> of B<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.

=item B<system.listmethods>

returns a list of the published methods or a subset of them as an B<array> of
B<string> values. if called with no parameters, returns all (non-hidden)
method names. if called with a single B<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).

=item B<system.methodhelp>

takes either a single method name as a B<string>, or a series of them as an
B<array> of B<string>. the return value is the help text for the method, as
either a B<string> or B<array> of B<string> value. if the method(s) have no
help text, the string will be null.

=item B<system.methodsignature>

as above, but returns the signatures that the method accepts, as B<array> of
B<string> representations. if only one method is requests via a B<string>
parameter, then the return value is the corresponding array. if the parameter
in is an B<array>, then the returned value will be an B<array> of B<array> of
B<string>.

=item B<system.multicall>

this is a simple implementation of composite function calls in a single
request. it takes an B<array> of B<struct> values. each B<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 B<array> of the parameters
that should be passed to the call.

=item B<system.status>

takes no arguments and returns a B<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.).

=back

=head1 AUTHOR

Florian Ragwitz, C<< <rafl at debian.org> >>

=head1 BUGS

Please report any bugs or feature requests to
C<bug-audio-xmmsclient-xmlrpc at rt.cpan.org>, or through the web interface at
L<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.

=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Audio::XMMSClient::XMLRPC

You can also look for information at:

=over 4

=item * AnnoCPAN: Annotated CPAN documentation

L<http://annocpan.org/dist/Audio-XMMSClient-XMLRPC>

=item * CPAN Ratings

L<http://cpanratings.perl.org/d/Audio-XMMSClient-XMLRPC>

=item * RT: CPAN's request tracker

L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Audio-XMMSClient-XMLRPC>

=item * Search CPAN