code.delx.au - pulseaudio/blob - doc/modules.html.in

   1 <?xml version="1.0" encoding="iso-8859-1"?> <!-- -*-html-helper-*- -->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>PulseAudio: Loadable Modules</title>
   6 <link rel="stylesheet" type="text/css" href="style.css" />
   7 </head>
   8
   9 <body>
  10
  11 <h1>Loadable Modules</h1>
  12
  13 <p>The following loadable modules are provided with the PulseAudio distribution:</p>
  14
  15 <h2>Device Drivers</h2>
  16
  17 <p>All device driver modules support the following parameters:</p>
  18 <table>
  19   <tr><td><tt>format=</tt></td><td>The sample format (one of <tt>u8</tt>, <tt>s16</tt>, <tt>s16le</tt>, <tt>s16le</tt>, <tt>float32</tt>, <tt>float32be</tt>, <tt>float32le</tt>, <tt>alaw</tt>, <tt>ulaw</tt>) (defaults to <tt>s16</tt>)</td></tr>
  20   <tr><td><tt>rate=</tt></td><td>The sample rate (defaults to 44100)</td></tr>
  21   <tr><td><tt>channels=</tt></td><td>Audio channels (defaults to 2)</td></tr>
  22   <tr><td><tt>sink_name=</tt>, <tt>source_name=</tt></td><td>Name for the sink (resp. source)</td></tr>
  23   <tr><td><tt>channel_map=</tt></td><td>Channel map. A list of
  24 comma-seperated channel names. The currently defined channel names
  25 are: <tt>left</tt>, <tt>right</tt>, <tt>mono</tt>, <tt>center</tt>,
  26 <tt>front-left</tt>, <tt>front-right</tt>, <tt>front-center</tt>,
  27 <tt>rear-center</tt>, <tt>rear-left</tt>, <tt>rear-right</tt>,
  28 <tt>lfe</tt>, <tt>subwoofer</tt>, <tt>front-left-of-center</tt>,
  29 <tt>front-right-of-center</tt>, <tt>side-left</tt>,
  30 <tt>side-right</tt>, <tt>aux0</tt>, <tt>aux1</tt> to <tt>aux15</tt>,
  31 <tt>top-center</tt>, <tt>top-front-left</tt>,
  32 <tt>top-front-right</tt>, <tt>top-front-center</tt>,
  33 <tt>top-rear-left</tt>, <tt>top-rear-right</tt>,
  34 <tt>top-rear-center</tt>, (Default depends on the number of channels
  35 and the driver)</td></tr> </table>
  36
  37 <h3>module-pipe-sink</h3>
  38
  39 <p>Provides a simple test sink that writes the audio data to a FIFO
  40 special file in the file system. The sink name defaults to <tt>pipe_output</tt>.</p>
  41
  42 <p>The following option is supported:</p>
  43
  44 <table>
  45   <tr><td><tt>file=</tt></td><td>The name of the FIFO special file to use. (defaults to: <tt>/tmp/music.output</tt>)</td></tr>
  46 </table>
  47
  48 <h3>module-pipe-source</h3>
  49
  50 <p>Provides a simple test source that reads the audio data from a FIFO
  51 special file in the file system. The source name defaults to <tt>pipe_input</tt>.</p>
  52
  53 <p>The following option is supported:</p>
  54
  55 <table>
  56   <tr><td><tt>file=</tt></td><td>The name of the FIFO special file to use. (defaults to: <tt>/tmp/music.input</tt>)</td></tr>
  57 </table>
  58
  59
  60 <h3>module-null-sink</h3>
  61
  62 <p>Provides a simple null sink. All data written to this sink is silently dropped. This sink is clocked using the system time.</p>
  63
  64 <p>This module doesn't support any special parameters</p>
  65
  66 <a name="module-alsa-sink"/>
  67
  68 <h3>module-alsa-sink</h3>
  69
  70 <p>Provides a playback sink for devices supported by the <a href="http://www.alsa-project.org/">Advanced Linux
  71 Sound Architecture</a> (ALSA). The sink name defaults to <tt>alsa_output</tt>.</p>
  72
  73 <p>In addition to the general device driver options described above this module supports:</p>
  74
  75 <table>
  76   <tr><td><tt>device=</tt></td><td>The ALSA device to use. (defaults to "plughw:0,0")</td></tr>
  77   <tr><td><tt>fragments=</tt></td><td>The desired fragments when opening the device. (defaults to 12)</td></tr>
  78   <tr><td><tt>fragment_size=</tt></td><td>The desired fragment size in bytes when opening the device (defaults to 1024)</td></tr>
  79 </table>
  80
  81 <h3>module-alsa-source</h3>
  82
  83 <p>Provides a recording source for devices supported by the Advanced
  84 Linux Sound Architecture (ALSA). The source name defaults to <tt>alsa_input</tt>.</p>
  85
  86 <p>This module supports <tt>device=</tt>, <tt>fragments=</tt> and <tt>fragment_size=</tt> arguments the same way as <a href="#module-alsa-sink"><tt>module-alsa-sink</tt></a>.</p>
  87
  88 <a name="module-oss"/>
  89
  90 <h3>module-oss</h3>
  91
  92 <p>Provides both a sink and a source for playback, resp. recording on
  93 <a href="http://www.opensound.com">Open Sound System</a> (OSS) compatible devices.</p>
  94
  95 <p>This module supports <tt>device=</tt> (which defaults to <tt>/dev/dsp</tt>), <tt>fragments=</tt> and <tt>fragment_size=</tt> arguments the same way as <a href="#module-alsa-sink"><tt>module-alsa-sink</tt></a>.</p>
  96
  97 <p>In addition this module supports the following options:</p>
  98
  99 <table>
 100   <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>
 101   <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>
 102 </table>
 103
 104 <p>The sink name (resp. source name) defaults to <tt>oss_output</tt> (resp. <tt>oss_input</tt>).</p>
 105
 106 <h3>module-oss-mmap</h3>
 107
 108 <p>Similar to <tt>module-oss</tt> but uses memory mapped
 109 (<tt>mmap()</tt>) access to the input/output buffers of the audio
 110 device. This provides better latency behaviour but is not as
 111 compatible as <tt>module-oss</tt>.</p>
 112
 113 <p>This module accepts exactly the same arguments as <a href="#module-oss"><tt>module-oss</tt></a>.</p>
 114
 115 <h3>module-solaris</h3>
 116
 117 <P>Provides a sink and source for the Solaris audio device.</p>
 118
 119 <p>In addition to the general device driver options described above this module supports:</p>
 120
 121 <table>
 122   <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>
 123   <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>
 124   <tr><td><tt>buffer_size=</tt></td><td>Record buffer size</td></tr>
 125 </table>
 126
 127 <h3>module-waveout</h3>
 128
 129 <P>Provides a sink and source for the Win32 audio device.</p>
 130
 131 <p>This module supports all arguments thet <tt>module-oss</tt> supports except <tt>device=</tt>.</p>
 132
 133 <a name="module-combine"/>
 134 <h3>module-combine</h3>
 135
 136 <p>This combines two or more sinks into one. A new virtual sink is
 137 allocated. All data written to it is forwarded to all connected
 138 sinks. In aequidistant intervals the sample rates of the output sinks
 139 is recalculated: i.e. even when the sinks' crystals deviate (which is
 140 normally the case) output appears synchronously to the human ear. The
 141 resampling required for this may be very CPU intensive.</p>
 142
 143 <table>
 144   <tr><td><tt>sink_name=</tt></td><td>The name for the combined sink. (defaults to  <tt>combined</tt>)</td></tr>
 145   <tr><td><tt>master=</tt></td><td>The name of the first sink to link into the combined think. The sample rate/type is taken from this sink.</td></tr>
 146   <tr><td><tt>slaves=</tt></td><td>Name of additional sinks to link into the combined think, seperated by commas.</td></tr>
 147   <tr><td><tt>adjust_time=</tt></td><td>Time in seconds when to readjust the sample rate of all sinks. (defaults to 20)</td></tr>
 148   <tr><td><tt>resample_method=</tt></td><td>Resampling algorithm to
 149 use. See <tt>libsamplerate</tt>'s documentation for more
 150 information. Use one of <tt>sinc-best-quality</tt>,
 151 <tt>sinc-medium-quality</tt>, <tt>sinc-fastest</tt>,
 152 <tt>zero-order-hold</tt>, <tt>linear</tt>. If the default happens to
 153 be to slow on your machine try using <tt>zero-order-hold</tt>. This
 154 will decrease output quality however. (defaults to
 155 <tt>sinc-fastest</tt>)</td></tr> </table>
 156
 157 <h3>module-tunnel-{sink,source}</h3>
 158
 159 <p>Tunnel a remote sink/source to a local "ghost"
 160 sink/source. Requires a running PulseAudio daemon on the remote server
 161 with <tt>module-native-protocol-tcp</tt> loaded. It's probably a
 162 better idea to connect to the remote sink/source directly since some
 163 buffer control is lost through this tunneling.</p>
 164
 165 <table>
 166   <tr><td><tt>server=</tt></td><td>The server to connect to</td></tr>
 167   <tr><td><tt>source=</tt></td><td>The source on the remote server. Only available for <tt>module-tunnel-source</tt>.</td></tr>
 168   <tr><td><tt>sink=</tt></td><td>The sink on the remote server. Only available for <tt>module-tunnel-sink</tt>.</td></tr>
 169   <tr><td><tt>cookie=</tt></td><td>The authentication cookie file to use.</td></tr>
 170 </table>
 171
 172 <h3>module-esound-sink</h3>
 173
 174 <p>Create a playback sink using an <a href="http://www.tux.org/~ricdude/apps.html">ESOUND</a> server as backend. Whenever you can, try to omit this
 175 module since it has many disadvantages including bad latency
 176 and even worse latency measurement. </p>
 177
 178 <table>
 179   <tr><td><tt>server=</tt></td><td>The server to connect to</td></tr>
 180   <tr><td><tt>cookie=</tt></td><td>The authentication cookie file to use.</td></tr>
 181 </table>
 182
 183 <h2>Protocols</h2>
 184
 185 <a name="module-cli"/>
 186
 187 <h3>module-cli</h3>
 188
 189 <p>Provides the user with a simple command line interface on the
 190 controlling TTY of the daemon. This module may not be loaded more than
 191 once.</p>
 192
 193 <p>For an explanation of the simple command line language used by this
 194 module see <a href="cli.html"><tt>cli.html</tt></a>.
 195
 196 <table>
 197   <tr><td><tt>exit_on_eof=</tt></td><td>Accepts a binary numerical argument specifying whether the daemon shuld exit after an EOF was recieved from STDIN (default: 0)</td></tr>
 198 </table>
 199
 200 <a name="module-cli-protocol-unix"/>
 201 <a name="module-cli-protocol-tcp"/>
 202 <a name="module-cli-protocol"/>
 203
 204 <h3>module-cli-protocol-{unix,tcp}</h3>
 205
 206 <p>An implemenation of a simple command line based protocol for
 207 controlling the PulseAudio daemon. If loaded, the user may
 208 connect with tools like <tt>netcat</tt>, <tt>telnet</tt> or
 209 <a href="http://0pointer.de/lennart/projects/bidilink/"><tt>bidilink</tt></a> to the listening sockets and execute commands the
 210 same way as with <tt>module-cli</tt>.</p>
 211
 212 <p><b>Beware!</b> Users are not authenticated when connecting to this
 213 service.</p>
 214
 215 <p>This module exists in two versions: with the suffix <tt>-unix</tt>
 216 the service will listen on an UNIX domain socket in the local file
 217 system. With the suffix <tt>-tcp</tt> it will listen on a network
 218 transparent TCP/IP socket. (Both IPv6 and IPv4 - if available)</p>
 219
 220 <p>This module supports the following options:</p>
 221
 222 <table>
 223   <tr><td><tt>port=</tt></td><td>(only for <tt>-tcp</tt>) The port number to listen on (defaults to 4712)</td></tr>
 224   <tr><td><tt>loopback=</tt></td><td>(only for <tt>-tcp</tt>) Accepts
 225 a numerical binary value. If 1 the socket is bound to the loopback
 226 device, i.e. not publicly accessible. (defaults to 1)</td></tr>
 227   <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>
 228   <tr><td><tt>socket=</tt></td><td>(only for <tt>-unix</tt>) The UNIX socket name (defaults to <tt>/tmp/pulse/cli</tt>)</td></tr>
 229 </table>
 230
 231 <h3>module-simple-protocol-{unix,tcp}</h3>
 232
 233 <p>An implementation of a simple protocol which allows playback by using
 234 simple tools like <tt>netcat</tt>. Just connect to the listening
 235 socket of this module and write the audio data to it, or read it from
 236 it for playback, resp. recording.</p>
 237
 238 <p><b>Beware!</b> Users are not authenticated when connecting to this
 239 service.</p>
 240
 241 <p>See <tt>module-cli-protocol-{unix,tcp}</tt> for more information
 242 about the two possible suffixes of this module.</p>
 243
 244 <p>In addition to the options supported by <a href="module-cli-protocol"><tt>module-cli-protocol-*</tt></a>, this module supports:</p>
 245
 246 <table>
 247   <tr><td><tt>rate=</tt>, <tt>format=</tt>, <tt>channels=</tt></td><td>Sample format for streams connecting to this service.</td></tr>
 248   <tr><td><tt>playback=</tt>, <tt>record=</tt></td><td>Enable/disable playback/recording</td></tr>
 249   <tr><td><tt>sink=</tt>, <tt>source=</tt></td><td>Specify the sink/source this service connects to</td></tr>
 250 </table>
 251
 252 <h3>module-esound-protocol-{unix,tcp}</h3>
 253
 254 <p>An implemenation of a protocol compatible with the <a
 255 href="http://www.tux.org/~ricdude/EsounD.html">Enlightened Sound
 256 Daemon</a> (ESOUND, <tt>esd</tt>). When you load this module you may
 257 access the PulseAudio daemon with tools like <tt>esdcat</tt>,
 258 <tt>esdrec</tt> or even <tt>esdctl</tt>. Many applications, such as
 259 XMMS, include support for this protocol.</p>
 260
 261 <p>See <tt>module-cli-protocol-{unix,tcp}</tt> for more information
 262 about the two possible suffixes of this module.</p>
 263
 264 <p>In addition to the options supported by <a href="module-cli-protocol"><tt>module-cli-protocol-*</tt></a>, this module supports:</p>
 265
 266 <table>
 267   <tr><td><tt>sink=</tt>, <tt>source=</tt></td><td>Specify the sink/source this service connects to</td></tr>
 268   <tr><td><tt>auth-anonymous=</tt></td><td>If set to 1 no authentication is required to connect to the service</td></tr>
 269   <tr><td><tt>cookie=</tt></td><td>Name of the cookie file for authentication purposes</td></tr>
 270 </table>
 271
 272 <p>This implementation misses some features the original ESOUND has: e.g. there is no sample cache yet. However: XMMS works fine.</p>
 273
 274 <h3>module-native-protocol-{unix,tcp}</h3>
 275
 276 <p>The native protocol of PulseAudio.</p>
 277
 278 <p>See <tt>module-cli-protocol-{unix,tcp}</tt> for more information
 279 about the two possible suffixes of this module.</p>
 280
 281 <p>In addition to the options supported by <a href="module-cli-protocol"><tt>module-cli-protocol-*</tt></a>, this module supports:</p>
 282
 283 <table>
 284   <tr><td><tt>auth-anonymous=</tt></td><td>If set to 1 no authentication is required to connect to the service</td></tr>
 285   <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>
 286   <tr><td><tt>cookie=</tt></td><td>Name of the cookie file for authentication purposes</td></tr>
 287 </table>
 288
 289 <h3>module-native-protocol-fd</h3>
 290
 291 <p>This is used internally when auto spawning a new daemon. Don't use it directly.</p>
 292
 293 <h3>module-http-protocol-tcp</h3>
 294
 295 <p>A proof-of-concept HTTP module, which can be used to introspect
 296 the current status of the PulseAudio daemon using HTTP. Just load this
 297 module and point your browser to <a
 298 href="http://localhost:4714/">http://localhost:4714/</a>. This module takes the same arguments
 299 as <tt>module-cli-protocol-tcp</tt>.</p>
 300
 301 <h2>X Window System</h2>
 302
 303 <h3>module-x11-bell</h3>
 304
 305 <p>Intercepts X11 bell events and plays a sample from the sample cache on each occurence.</p>
 306
 307 <table>
 308   <tr><td><tt>display=</tt></td><td>X11 display to connect to. If ommited defaults to the value of <tt>$DISPLAY</tt></td></tr>
 309   <tr><td><tt>sample=</tt></td><td>The sample to play. If ommited defaults to <tt>x11-bell</tt>.</td></tr>
 310   <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>
 311 </table>
 312
 313 <h3>module-x11-publish</h3>
 314
 315 <p>Publishes the access credentials to the PulseAudio server in the
 316 X11 root window. The following properties are used:
 317 <tt>PULSE_SERVER</tt>, <tt>POYLP_SINK</tt>, <tt>PULSE_SOURCE</tt>,
 318 <tt>PULSE_COOKIE</tt>. This is very useful when using SSH or any other
 319 remote login tool for logging into other machines and getting audio
 320 playback to your local speakers. The PulseAudio client libraries make
 321 use of this data automatically. Instead of using this module you may
 322 use the tool <tt>pax11publish</tt> which may be used to access, modify
 323 and import credential data from/to the X11 display.</p>
 324
 325 <table>
 326   <tr><td><tt>display=</tt></td><td>X11 display to connect to. If ommited defaults to the value of <tt>$DISPLAY</tt></td></tr>
 327   <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>
 328   <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>
 329   <tr><td><tt>cookie=</tt></td><td>Name of the cookie file of the
 330 cookie to store in the X11 display. If ommited the cookie of an
 331 already loaded protocol module is used.</td></tr> </table>
 332
 333 <h2>Volume Control</h2>
 334
 335 <h3>module-mmkbd-evdev</h3>
 336
 337 <p>Adjust the volume of a sink when the special multimedia buttons of modern keyboards are pressed.</p>
 338
 339 <table>
 340   <tr><td><tt>device=</tt></td><td>Linux input device ("<tt>evdev</tt>", defaults to <tt>/dev/input/event0</tt>)</td></tr>
 341   <tr><td><tt>sink=</tt></td><td>The sink to control</td></tr>
 342 </table>
 343
 344 <h3>module-lirc</h3>
 345
 346 <p>Adjust the volume of a sink when the volume buttons of an infrared remote control are pressed (through LIRC).</p>
 347
 348 <table>
 349   <tr><td><tt>config=</tt></td><td>The LIRC configuration file</td></tr>
 350   <tr><td><tt>appname=</tt></td><td>The application name to pass to LIRC (defaults to <tt>pulseaudio</tt>)</td></tr>
 351   <tr><td><tt>sink=</tt></td><td>The sink to control</td></tr>
 352 </table>
 353
 354 <a name="rtp"/>
 355 <h2>RTP/SDP/SAP Transport</h2>
 356
 357 <p>PulseAudio can stream audio data to an IP multicast group via the
 358 standard protocols <a
 359 href="http://en.wikipedia.org/wiki/Real-time_Transport_Protocol">RTP</a>,
 360 <a
 361 href="http://en.wikipedia.org/wiki/Session_Announcement_Protocol">SAP</a>
 362 and <a
 363 href="http://en.wikipedia.org/wiki/Session_Description_Protocol">SDP</a>
 364 (RFC3550, RFC3551, RFC2327, RFC2327). This can be used for multiple
 365 different purposes: for sharing a single microphone on multiple
 366 computers on the local LAN, for streaming music from a single
 367 controlling PC to multiple PCs with speakers or to implement a simple
 368 "always-on" teleconferencing solution.</p>
 369
 370 <p>The current implementation is designed to be used exlusively in
 371 local area networks, though Internet multicasting is theoretically
 372 supported. Only uncompressed audio is supported, hence you won't be
 373 able to multicast more than a few streams at the same time over a
 374 standard LAN.</p>
 375
 376 <p>PulseAudio implements both a sender and a reciever for RTP
 377 traffic. The sender announces itself via SAP/SDP on the same multicast
 378 group as it sends the RTP data to. The reciever picks up the SAP/SDP
 379 announcements and creates a playback stream for each
 380 session. Alternatively you can use any RTP capable client to
 381 recieve and play back the RTP data (such as <tt>mplayer</tt>).</p>
 382
 383 <h3>module-rtp-send</h3>
 384
 385 <p>This is the sender side of the RTP/SDP/SAP implementation. It reads
 386 audio data from an existing source and forwards it to the network
 387 encapsulated in RTP. In addition it sends SAP packets with an SDP
 388 session description.</p>
 389
 390 <p>In combination with the monitor source of <tt>module-null-sink</tt>
 391 you can use this module to create an RTP sink.</p>
 392
 393 <table>
 394   <tr><td><tt>source=</tt></td><td>The source to read the audio data from. If ommited defaults to the default source.</td></tr>
 395   <tr><td><tt>format=, rate=, channels=</tt></td><td>Sample format to use, defaults to the source's.</td></tr>
 396   <tr><td><tt>destination=</tt></td><td>Destination multicast group for both RTP and SAP packets, defaults to <tt>224.0.0.56</tt></td></tr>
 397   <tr><td><tt>port=</tt></td><td>Destination port number of the RTP
 398 traffic. If ommited defaults to a randomly chosen even port
 399 number. Please keep in mind that the RFC suggests to use only even
 400 port numbers for RTP traffic.</td></tr>
 401   <tr><td><tt>mtu=</tt></td><td>Maximum payload size for RTP packets. If ommited defaults to 1280</td></tr>
 402   <tr><td><tt>loop=</tt></td><td>Takes a boolean value, specifying whether locally generated RTP traffic should be looped back to the local host. Disabled by default.</td></tr>
 403 </table>
 404
 405 <h3>module-rtp-recv</h3>
 406
 407 <p>This is the reciever side of the RTP/SDP/SAP implementation. It
 408 picks up SAP session announcements and creates an RTP playback stream
 409 for each.</p>
 410
 411 <p>In combination with <tt>module-null-sink</tt> you can use this
 412 module to create an RTP source.</p>
 413
 414 <table>
 415   <tr><td><tt>sink=</tt></td><td>The sink to connect to. If ommited defaults to the default sink.</td></tr>
 416   <tr><td><tt>sap_address=</tt></td><td>The multicast group to join for SAP announcements, defaults to <tt>224.0.0.56</tt>.</td></tr>
 417 </table>
 418
 419 <h2>JACK Connectivity</h2>
 420
 421 <p>PulseAudio can be hooked up to a <a
 422 href="http://jackit.sourceforge.net/">JACK Audio Connection Kit</a> server which is a specialized sound server used for professional audio production on Unix/Linux. Both a
 423 PulseAudio sink and a source are available. For each channel a port is
 424 created in the JACK server.</p>
 425
 426 <h3>module-jack-sink</h3>
 427
 428 <p>This module implements a PulseAudio sink that connects to JACK and registers as many output ports as requested.</p>
 429
 430 <table>
 431   <tr><td><tt>sink_name=</tt></td><td>The name for the PulseAudio sink. If ommited defaults to <tt>jack_out</tt>.</td></tr>
 432   <tr><td><tt>server_name=</tt></td><td>The JACK server to connect to. If ommited defaults to the default server.</td></tr>
 433   <tr><td><tt>client_name=</tt></td><td>The client name to tell the JACK server. If ommited defaults to <tt>PulseAudio</tt>.</td></tr>
 434   <tr><td><tt>channels=</tt></td><td>Number of channels to register. If ommited defaults to the number of physical playback ports of the JACK server.</td></tr>
 435   <tr><td><tt>connect=</tt></td><td>Takes a boolean value. If enabled (the default) PulseAudio will try to connect its ports to the physicial playback ports of the JACK server</td></tr>
 436 </table>
 437
 438 <h3>module-jack-source</h3>
 439
 440 <p>This module implements a PulseAudio source that connects to JACK
 441 and registers as many input ports as requested. Takes the same
 442 arguments as <tt>module-jack-sink</tt>, except for <tt>sink_name</tt>
 443 which is replaced by <tt>source_name</tt> (with a default of <tt>jack_in</tt>) for obvious reasons.</p>
 444
 445 <h2>Miscellaneous</h2>
 446
 447 <h3>module-sine</h3>
 448
 449 <p>Creates a sink input and generates a sine waveform stream.</p>
 450
 451 <table>
 452   <tr><td><tt>sink=</tt></td><td>The sink to connect to. If ommited defaults to the default sink.</td></tr>
 453   <tr><td><tt>frequency=</tt></td><td>The frequency to generate in Hertz. Defaults to 440.</td></tr>
 454 </table>
 455
 456 <h3>module-esound-compat-spawnfd</h3>
 457
 458 <p>This is a compatibility module for <tt>libesd</tt> based autospawning of PulseAudio. Don't use it directly.</p>
 459
 460 <h3>module-esound-compat-spawnpid</h3>
 461
 462 <p>This is a compatibility module for <tt>libesd</tt> based autospawning of PulseAudio. Don't use it directly.</p>
 463
 464 <h3>module-match</h3>
 465
 466 <p>Adjust the volume of a playback stream automatically based on its name.</p>
 467
 468 <table>
 469   <tr><td><tt>table=</tt></td><td>The regular expression matching table file to use (defaults to <tt>~/.pulse/match.table</tt>)</td></tr>
 470 </table>
 471
 472 <p>The table file should contain a regexp and volume on each line, seperated by spaces. An example:</p>
 473
 474 <pre>
 475 ^sample: 32000
 476 </pre>
 477
 478 <p>The volumes of all streams with titles starting with <tt>sample:</tt> are automatically set to 32000. (FYI: All sample cache streams start with <tt>sample:</tt>)</p>
 479
 480 <h3>module-volume-restore</h3>
 481
 482 <p>Adjust the volume of a playback stream automatically based on its name.</p>
 483
 484 <table>
 485   <tr><td><tt>table=</tt></td><td>The table file to use (defaults to <tt>~/.pulse/volume.table</tt>)</td></tr>
 486 </table>
 487
 488 <p>In contrast to <tt>module-match</tt> this module needs no explicit
 489 configuration. Instead the volumes are saved and restored in a fully
 490 automatical fashion depending on the client name to identify
 491 streams. The volume for a stream is automatically saved every time it is
 492 changed and than restored when a new stream is created.</p>
 493
 494 <h3>module-detect</h3>
 495
 496 <p>Automatically detect the available sound hardware and load modules for it. Supports OSS, ALSA, Solaris and Win32 output drivers.
 497
 498 <table>
 499   <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>
 500 </table>
 501
 502 <h3>module-zeroconf-publish</h3>
 503
 504 <p>Publish all local sinks/sources using mDNS Zeroconf.</p>
 505
 506
 507 <hr/>
 508 <address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, April 2006</address>
 509 <div class="grey"><i>$Id$</i></div>
 510 </body> </html>