From 7871f41f2e49978b8c5451516e7a464b0985828b Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Sun, 16 Apr 2006 13:34:09 +0000 Subject: add documentation for the new RTP modules git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@731 fefdeb5f-60dc-0310-8127-8f9354f1896f --- doc/modules.html.in | 108 +++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 89 insertions(+), 19 deletions(-) (limited to 'doc/modules.html.in') diff --git a/doc/modules.html.in b/doc/modules.html.in index 67f0e172..54cec804 100644 --- a/doc/modules.html.in +++ b/doc/modules.html.in @@ -283,7 +283,7 @@ module and point your browser to http://localhost:4714/. This module takes the same arguments as module-cli-protocol-tcp.

-

Miscellaneous

+

X Window System

module-x11-bell

@@ -315,6 +315,94 @@ and import credential data from/to the X11 display.

cookie to store in the X11 display. If ommited the cookie of an already loaded protocol module is used. +

Volume Control

+ +

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
+ + +

RTP/SDP/SAP Transport

+ +

Polypaudio can stream audio data to an IP multicast group via the +standard protocols RTP, +SAP +and SDP +(RFC3550, RFC3551, RFC2327, RFC2327). This can be used for multiple +different purposes: for sharing a single microphone on multiple +computers on the local LAN, for streaming music from a single +controlling PC to multiple PCs with speakers or to implement a simple +"always-on" teleconferencing solution.

+ +

The current implementation is designed to be used exlusively in +local area networks, though Internet multicasting is theoretically +supported. Only uncompressed audio is supported, hence you won't be +able to multicast more than a few streams at the same time over a +standard LAN.

+ +

Polypaudio implements both a sender and a reciever for RTP +traffic. The sender announces itself via SAP/SDP on the same multicast +group as it sends the RTP data to. The reciever picks up the SAP/SDP +announcements and creates a playback stream for each +session. Alternatively you can use any RTP capable client to +recieve and play back the RTP data (such as mplayer).

+ +

module-rtp-send

+ +

This is the sender side of the RTP/SDP/SAP implementation. It reads +audio data from an existing source and forwards it to the network +encapsulated in RTP. In addition it sends SAP packets with an SDP +session description.

+ +

In combination with the monitor source of module-null-sink +you can use this module to create an RTP sink.

+ + + + + + + + +
source=The source to read the audio data from. If ommited defaults to the default source.
format=, rate=, channels=Sample format to use, defaults to the source's.
destination=Destination multicast group for both RTP and SAP packets, defaults to 224.0.0.56
port=Destination port number of the RTP +traffic. If ommited defaults to a randomly chosen even port +number. Please keep in mind that the RFC suggests to use only even +port numbers for RTP traffic.
mtu=Maximum payload size for RTP packets. If ommited defaults to 1280
loop=Takes a boolean value, specifying whether locally generated RTP traffic should be looped back to the local host. Disabled by default.
+ +

module-rtp-recv

+ +

This is the reciever side of the RTP/SDP/SAP implementation. It +picks up SAP session announcements and creates an RTP playback stream +for each.

+ +

In combination with module-null-sink you can use this +module to create an RTP source.

+ + + + +
sink=The sink to connect to. If ommited defaults to the default sink.
sap_address=The multicast group to join for SAP announcements, defaults to 224.0.0.56.
+ +

Miscellaneous

+

module-sine

Creates a sink input and generates a sine waveform stream.

@@ -360,24 +448,6 @@ already loaded protocol module is used.

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@>, April 2006
-- cgit