<p>This module accepts exactly the same arguments as <a href="#module-oss"><tt>module-oss</tt></a>.</p>
+<h3>module-solaris</h3>
+
+<P>Provides a sink and source for the Solaris audio device.</p>
+
+<p>In addition to the general device driver options described above this module supports:</p>
+
+<table>
+ <tr><td><tt>record=</tt></td><td>Accepts a binary numerical value for enabling (resp. disabling) the recording on this device. (defaults: to 1)</td></tr>
+ <tr><td><tt>playback=</tt></td><td>Accepts a binary numerical value for enabling (resp. disabling) the playback on this device. (defaults: to 1)</td></tr>
+ <tr><td><tt>buffer_size=</tt></td><td>Record buffer size</td></tr>
+</table>
+
+<h3>module-waveout</h3>
+
+<P>Provides a sink and source for the Win32 audio device.</p>
+
+<p>This module supports all arguments thet <tt>module-oss</tt> supports except <tt>device=</tt>.</p>
+
<h3>module-combine</h3>
<p>This combines two or more sinks into one. A new virtual sink is
<tr><td><tt>cookie=</tt></td><td>The authentication cookie file to use.</td></tr>
</table>
+<h3>module-esound-sink</h3>
+
+<p>Create a playback sink using an ESOUND server as backend. Whenever you can, try to omit this
+module since it has many disadvantages including bad latency
+and even worse latency measurement. </p>
+
+<table>
+ <tr><td><tt>server=</tt></td><td>The server to connect to</td></tr>
+ <tr><td><tt>cookie=</tt></td><td>The authentication cookie file to use.</td></tr>
+</table>
+
<h2>Protocols</h2>
<a name="module-cli"/>
<p>This module exists in two versions: with the suffix <tt>-unix</tt>
the service will listen on an UNIX domain socket in the local file
system. With the suffix <tt>-tcp</tt> it will listen on a network
-transparent TCP/IP socket.</p>
+transparent TCP/IP socket. (Both IPv6 and IPv4 - if available)</p>
<p>This module supports the following options:</p>
<tr><td><tt>loopback=</tt></td><td>(only for <tt>-tcp</tt>) Accepts
a numerical binary value. If 1 the socket is bound to the loopback
device, i.e. not publicly accessible. (defaults to 1)</td></tr>
+ <tr><td><tt>listen=</tt></td><td>(only for <tt>-tcp</tt>) The IP address to listen on. If specified, supersedes the value specified in <tt>loopback=</tt></td></tr>
<tr><td><tt>socket=</tt></td><td>(only for <tt>-unix</tt>) The UNIX socket name (defaults to <tt>/tmp/polypaudio/cli</tt>)</td></tr>
</table>
<table>
<tr><td><tt>sink=</tt>, <tt>source=</tt></td><td>Specify the sink/source this service connects to</td></tr>
- <tr><td><tt>public=</tt></td><td>If set to 0 not authentication is required to connect to the service</td></tr>
+ <tr><td><tt>auth-anonymous=</tt></td><td>If set to 1 no authentication is required to connect to the service</td></tr>
<tr><td><tt>cookie=</tt></td><td>Name of the cookie file for authentication purposes</td></tr>
</table>
<p>In addition to the options supported by <a href="module-cli-protocol"><tt>module-cli-protocol-*</tt></a>, this module supports:</p>
<table>
- <tr><td><tt>public=</tt></td><td>If set to 0 not authentication is required to connect to the service</td></tr>
+ <tr><td><tt>auth-anonymous=</tt></td><td>If set to 1 no authentication is required to connect to the service</td></tr>
+ <tr><td><tt>auth-group=</tt></td><td>(only for <tt>-unix</tt>): members of the specified unix group may access the server without further auhentication.</td></tr>
<tr><td><tt>cookie=</tt></td><td>Name of the cookie file for authentication purposes</td></tr>
</table>
<p>This is used internally when auto spawning a new daemon. Don't use it directly.</p>
+<h3>module-http-protocol-tcp</h3>
+
+<p>A proof-of-concept HTTP module, which can be used to introspect
+the current status of the polypaudio daemon using HTTP. Just load this
+module and point your browser to <a
+href="http://localhost:4714/">http://localhost:4714/</a>. This module takes the same arguments
+as <tt>module-cli-protocol-tcp</tt>.</p>
+
<h2>Miscellaneous</h2>
<h3>module-x11-bell</h3>
<tr><td><tt>sink=</tt></td><td>Name of the sink to play the sample on. If ommited defaults to the default sink.</td></tr>
</table>
+<h3>module-x11-publish</h3>
+
+<p>Publishes the access credentials to the Polypaudio server in the
+X11 root window. The following properties are used:
+<tt>POLYP_SERVER</tt>, <tt>POYLP_SINK</tt>, <tt>POLYP_SOURCE</tt>,
+<tt>POLYP_COOKIE</tt>. This is very useful when using SSH or any other
+remote login tool for logging into other machines and getting audio
+playback to your local speakers. The Polypaudio client libraries make
+use of this data automatically. Instead of using this module you may
+use the tool <tt>pax11publish</tt> which may be used to access, modify
+and import credential data from/to the X11 display.</p>
+
+<table>
+ <tr><td><tt>display=</tt></td><td>X11 display to connect to. If ommited defaults to the value of <tt>$DISPLAY</tt></td></tr>
+ <tr><td><tt>sink=</tt></td><td>Name of the default sink. If ommited this property isn't stored in the X11 display.</td></tr>
+ <tr><td><tt>source=</tt></td><td>Name of the default source. If ommited this property isn't stored in the X11 display.</td></tr>
+ <tr><td><tt>cookie=</tt></td><td>Name of the cookie file of the
+cookie to store in the X11 display. If ommited the cookie of an
+already loaded protocol module is used.</td></tr> </table>
+
<h3>module-sine</h3>
<p>Creates a sink input and generates a sine waveform stream.</p>
<p>The volumes of all streams with titles starting with <tt>sample:</tt> are automatically set to 25. (FYI: All sample cache streams start with <tt>sample:</tt>)</p>
+<h3>module-detect</h3>
+
+<p>Automatically detect the available sound hardware and load modules for it. Supports OSS, ALSA, Solaris and Win32 output drivers.
+
+<table>
+ <tr><td><tt>just-one=</tt></td><td>If set to <tt>1</tt> the module will only try to load a single sink/source and than stop.</td></tr>
+</table>
+
+<h3>module-zeroconf-publish</h3>
+
+<p>Publish all local sinks/sources using mDNS Zeroconf.</p>
+
+<h3>module-mmkbd-evdev</h3>
+
+<p>Adjust the volume of a sink when the special multimedia buttons of modern keyboards are pressed.</p>
+
+<table>
+ <tr><td><tt>device=</tt></td><td>Linux input device ("<tt>evdev</tt>", defaults to <tt>/dev/input/event0</tt>)</td></tr>
+ <tr><td><tt>sink=</tt></td><td>The sink to control</td></tr>
+</table>
+
+<h3>module-lirc</h3>
+
+<p>Adjust the volume of a sink when the volume buttons of an infrared remote control are pressed (through LIRC).</p>
+
+<table>
+ <tr><td><tt>config=</tt></td><td>The LIRC configuration file</td></tr>
+ <tr><td><tt>appname=</tt></td><td>The application name to pass to LIRC (defaults to <tt>polypaudio</tt>)</td></tr>
+ <tr><td><tt>sink=</tt></td><td>The sink to control</td></tr>
+</table>
+
<hr/>
-<address class="grey">Lennart Poettering <@PACKAGE_BUGREPORT@>, September 2004</address>
+<address class="grey">Lennart Poettering <@PACKAGE_BUGREPORT@>, April 2006</address>
<div class="grey"><i>$Id$</i></div>
</body> </html>