From c35052aa5a109013b8ed3326aaeede3bd5b2325e Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Tue, 18 Apr 2006 17:43:32 +0000 Subject: add JACK module documentation git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@749 fefdeb5f-60dc-0310-8127-8f9354f1896f --- doc/modules.html.in | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/doc/modules.html.in b/doc/modules.html.in index 54cec804..3785912c 100644 --- a/doc/modules.html.in +++ b/doc/modules.html.in @@ -401,6 +401,32 @@ module to create an RTP source.

sap_address=The multicast group to join for SAP announcements, defaults to 224.0.0.56. +

JACK Connectivity

+ +

Polypaudio can be hooked up to a JACK Audio Connection Kit server which is a specialized sound server used for professional audio production on Unix/Linux. Both a +Polypaudio sink and a source are available. For each channel a port is +created in the JACK server.

+ +

module-jack-sink

+ +

This module implements a Polypaudio sink that connects to JACK and registers as many output ports as requested.

+ + + + + + + +
sink_name=The name for the Polypaudio sink. If ommited defaults to jack_out.
server_name=The JACK server to connect to. If ommited defaults to the default server.
client_name=The client name to tell the JACK server. If ommited defaults to polypaudio.
channels=Number of channels to register. If ommited defaults to the number of physical playback ports of the JACK server.
connect=Takes a boolean value. If enabled (the default) Polypaudio will try to connect its ports to the physicial playback ports of the JACK server
+ +

module-jack-source

+ +

This module implements a Polypaudio source that connects to JACK +and registers as many input ports as requested. Takes the same +arguments as module-jack-sink, except for sink_name +which is replaced by source_name (with a default of jack_in) for obvious reasons.

+

Miscellaneous

module-sine

-- cgit