This is the README file for lirc-xmms-plugin, a LIRC (Linux Infrared
Remote Control) plugin for XMMS (X Multimedia System).

You can get more information about XMMS at http://www.xmms.org.
Current versions of this package and LIRC will be available at the
LIRC homepage at http://www.lirc.org/

This plugin has been tested with Xmms 1.2.7. You also will need at
least LIRC 0.6.0. Both packages have to be installed before you
compile this plugin.

Configuration is done with a standard LIRC .lircrc config file. You
will have to give xmms to the prog token. Read the LIRC documentation
for details. The plugin does understand the following quite obvious
commands (<tracks> defaults to 1; <sec>, <min> and <percent> defaults
to 5):

	PLAY				ONE
	STOP				TWO
	PAUSE				THREE
	PLAYPAUSE			FOUR
	NEXT [<tracks>]			FIVE
	PREV [<tracks>]			SIX
	SHUFFLE				SEVEN
	REPEAT				EIGHT
	FWD [<sec>]			NINE
	BWD [<sec>]			ZERO
	VOL_UP [<percent>]		SETPOS
	VOL_DOWN [<percent]		QUIT
	BAL_LEFT [<percent>]		LIST
	BAL_RIGHT [<percent>]		SELECT <chars>
	BAL_CENTER			MUTE
	PLAYLIST_ADD <file>		SLEEP [<min>]
	PLAYLIST_SET <file>
	PLAYLIST_CLEAR
	PLAYLIST_REMOVE

If you have IBM ViaVoice TTS installed additionally the following
commands are supported:

	SAYTITLE

You can download ViaVoice TTS for free from
http://www-4.ibm.com/software/speech/enterprise/te_5.html. [Actually I
haven't checked this link for ages. If you can't find it and know where
it is available for download drop me a note.]  There's one known issue
with speech output support: xmms will crash when you quit the
program. I also heard from some people that it will freeze after
saying the first title, but I couldn't reproduce that.  I suspect that
it's a problem in xmms. I'd be grateful for any hints what causes the
problem. [Actually this doesn't seem to happen with Xmms 1.2.7
anymore.]

An example configuration can be found in the file 'lircrc'.
You can use it directly or append it to your .lircrc. It will start
and stop xmms if you press button 'power'. Therefore, the tool 'irexec'
has to be running on the system. Select tracks from your playlist by
skipping through it with the skip_forw/skip_back keys or use the
numerical keys to enter a playlist position and press 'enter' on
your remote-control to select that track for playing.

You can also select tracks by writing their titles with the SELECT
command.  You can map any number of characters to a button. I
recommend a similar mapping like you can find it on many mobile
phones. So, if you can write a SMS you will also be able to select a
title from thousands of songs with a couple of keystrokes! Only
alpha-numerical characters are relevant. All other characters like
whitespace and punctuation marks will be ignored. It works like this:
as soon as you press a button that is mapped to a SELECT command the
plugin will display all titles that begin with the characters you
specified. This list will also show you what character has to be typed
next in order to select a title, so you only will have to type in
distinguishing characters and not the whole title. Currently this list
is displayed in a simple, tool-tip-like popup. This popup still lacks
some features (redraw, etc.) but I did not yet implement this due to
lack of time. I'd be grateful to anybody who volunteers to implement
this...  You will have to enter buttons as long as there's only the
title left that you wanted to select or there's no match. As a
short-cut, the meaning of the ZERO, ONE, ..., NINE commands changes if
there's a list of titles generated by the SELECT command. Then you can
select the titles 1 to 10 directly with the according buttons. It
probably sounds more complicated than it really is.

The 'play' button starts playback, if xmms is in stop mode.

Don't forget to enable the plugin in xmms!

This package will be maintained but I will give no support for
it. That means I won't answer any mails regarding this plugin but
patches for possible problems are welcome and will be included in
future releases.

Christoph Bartelmus <xmms@bartelmus.de>
