eboxy XMMS Control plugin (xmmsctrl) 0.1
----------------------------------------

Xmmsctrl is a plugin for eboxy which allows control of the XMMS music player
from inside eboxy. Please see http://www.xmms.org for more information on
XMMS. This plugin requires XMMS version 1.2.6 or later.


Compiling
---------

Run make and (as root) make install.

If your system is set up in a non-standard way you may have to modify the
makefile slightly. In the future this plugin will use autoconf/automake to
avoid this.


Usage
-----

To load the plugin, you need to add a <plugin> section into your XML file,
and then access the plugin through the xmmsctrl object that the plugin
creates. Here's a quick example (assuming XMMS is already running):

...
<pages>
  <page...>
    <plugin module="xmmsctrl" />
    ...
    <button caption="Play" ...>
      xmmsctrl.play
    </button>
    <button caption="Pause" ...>
      xmmsctrl.stop
    </button>
    <button caption="Stop" ...>
      xmmsctrl.stop
    </button>
    ...
  </page>
</pages>
...



Reference
---------

Properties:

  session
    Sets/gets the session you wish to control. Defaults to 0 (the first
    running copy of XMMS). Generally you won't need to use this property.

  running
    Read-only. "true" if XMMS is running, otherwise "false".

  playing
    Read-only. "true" if XMMS is currently playing, otherwise "false".

  showmainwindow
    "true" to show the main XMMS window, "false" to hide it.

  playlistcount
    Read-only. Number of items in the current playlist.

  playlistpos
    Current position in the playlist (1 being the first item).

Methods:

  play
    Start playing the currently open file or playlist.

  stop
    Stop playing.

  pause
    Pause playing.

  nexttrack
    Jump to the next track in the playlist.

  prevtrack
    Jump to the previous track in the playlist.

  exit
    Quit XMMS. The plugin will stop working after you call this unless you
    change the session property to point to another running session of XMMS.

Events:

none.


eboxy
-----

eboxy is a GUI system for set-top boxes. For more information on eboxy, visit:

  http://www.bluelightning.org/eboxy

Please contact me, Paul Eggleton, at bluelightning@bluelightning.org with any
questions or suggestions.


Licence
-------

This plugin is released under the GPL, version 2 (or a later version, at your
option). For more information on the GNU GPL please visit http://www.fsf.org.
