From df108afe352a4f0e8d67510f923878e954714c94 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 13 Apr 2006 15:10:55 +0000 Subject: update documentation for release 0.8 git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@699 fefdeb5f-60dc-0310-8127-8f9354f1896f --- doc/modules.html.in | 65 +++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 58 insertions(+), 7 deletions(-) (limited to 'doc/modules.html.in') diff --git a/doc/modules.html.in b/doc/modules.html.in index a549396d..64bc4bbc 100644 --- a/doc/modules.html.in +++ b/doc/modules.html.in @@ -100,6 +100,24 @@ compatible as module-oss.

This module accepts exactly the same arguments as module-oss.

+

module-solaris

+ +

Provides a sink and source for the Solaris audio device.

+ +

In addition to the general device driver options described above this module supports:

+ + + + + +
record=Accepts a binary numerical value for enabling (resp. disabling) the recording on this device. (defaults: to 1)
playback=Accepts a binary numerical value for enabling (resp. disabling) the playback on this device. (defaults: to 1)
buffer_size=Record buffer size
+ +

module-waveout

+ +

Provides a sink and source for the Win32 audio device.

+ +

This module supports all arguments thet module-oss supports except device=.

+

module-combine

This combines two or more sinks into one. A new virtual sink is @@ -168,7 +186,7 @@ module see cli.html. -

module-cli-protocol-{unix,tcp,tcp6}

+

module-cli-protocol-{unix,tcp}

An implemenation of a simple command line based protocol for controlling the polypaudio daemon. If loaded, the user may @@ -182,7 +200,7 @@ service.

This module exists in two versions: with the suffix -unix the service will listen on an UNIX domain socket in the local file system. With the suffix -tcp it will listen on a network -transparent TCP/IP socket.

+transparent TCP/IP socket. (Both IPv6 and IPv4 - if available)

This module supports the following options:

@@ -191,10 +209,11 @@ transparent TCP/IP socket.

loopback=(only for -tcp) Accepts a numerical binary value. If 1 the socket is bound to the loopback device, i.e. not publicly accessible. (defaults to 1) + listen=(only for -tcp) The IP address to listen on. If specified, supersedes the value specified in loopback= socket=(only for -unix) The UNIX socket name (defaults to /tmp/polypaudio/cli) -

module-simple-protocol-{unix,tcp,tcp6}

+

module-simple-protocol-{unix,tcp}

An implementation of a simple protocol which allows playback by using simple tools like netcat. Just connect to the listening @@ -231,13 +250,13 @@ about the two possible suffixes of this module.

- +
sink=, source=Specify the sink/source this service connects to
public=If set to 0 not authentication is required to connect to the service
auth-anonymous=If set to 1 no authentication is required to connect to the service
cookie=Name of the cookie file for authentication purposes

This implementation misses some features the original ESOUND has: e.g. there is no sample cache yet. However: XMMS works fine.

-

module-native-protocol-{unix,tcp,tcp6}

+

module-native-protocol-{unix,tcp}

The native protocol of polypaudio.

@@ -247,7 +266,8 @@ about the two possible suffixes of this module.

In addition to the options supported by module-cli-protocol-*, this module supports:

- + +
public=If set to 0 not authentication is required to connect to the service
auth-anonymous=If set to 1 no authentication is required to connect to the service
auth-group=(only for -unix): members of the specified unix group may access the server without further auhentication.
cookie=Name of the cookie file for authentication purposes
@@ -320,7 +340,38 @@ already loaded protocol module is used.

The volumes of all streams with titles starting with sample: are automatically set to 25. (FYI: All sample cache streams start with sample:)

+

module-detect

+ +

Automatically detect the available sound hardware and load modules for it. Supports OSS, ALSA, Solaris and Win32 output drivers. + + + +
just-one=If set to 1 the module will only try to load a single sink/source and than stop.
+ +

module-zeroconf-publish

+ +

Publish all local sinks/sources using mDNS Zeroconf.

+ +

module-mmkbd-evdev

+ +

Adjust the volume of a sink when the special multimedia buttons of modern keyboards are pressed.

+ + + + +
device=Linux input device ("evdev", defaults to /dev/input/event0)
sink=The sink to control
+ +

module-lirc

+ +

Adjust the volume of a sink when the volume buttons of an infrared remote control are pressed (through LIRC).

+ + + + + +
config=The LIRC configuration file
appname=The application name to pass to LIRC (defaults to polypaudio)
sink=The sink to control
+
-
Lennart Poettering <@PACKAGE_BUGREPORT@>, November 2004
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, April 2006
$Id$
-- cgit