From 2d87bd2d2f088220ccf98af93073cfd807dc2d1b Mon Sep 17 00:00:00 2001
From: Lennart Poettering
Date: Mon, 20 Sep 2004 20:52:35 +0000
Subject: documentation update
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@225 fefdeb5f-60dc-0310-8127-8f9354f1896f
---
doc/README.html.in | 46 +++++++++++++++++++++++++++++++++++++++-------
1 file changed, 39 insertions(+), 7 deletions(-)
(limited to 'doc/README.html.in')
diff --git a/doc/README.html.in b/doc/README.html.in
index 837cb012..0a33d6f0 100644
--- a/doc/README.html.in
+++ b/doc/README.html.in
@@ -44,6 +44,14 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+Mon Sep 20 2004:
Version 0.5 released;
+changes include: extensive API improvements, new module
+module-combine for combining multiple sound cards into one,
+gcc 2.95 compatibility, configuration files, add "lazy" samples,
+support for source and network latency measurements, add
+module-pipe-source, many other fixes and improvements.
+
Wed Sep 8 2004:
Version 0.4 released;
changes include: daemon auto spawning, support for SCHED_FIFO scheduling, three new modules, proper logging, CPU load watchdog, many fixes.
@@ -79,6 +87,8 @@ Daemon (ESOUND). In addition to the features ESOUND provides
Flexible, implicit sample type conversion and resampling
"Zero-Copy" architecture
Module autoloading
+ Very accurate latency measurement for playback and recordin.
+ May be used to combine multiple sound cards to one (with sample rate adjustment)
Both the core and the client API are completely asynchronous making
@@ -89,15 +99,35 @@ available through polyplib is quite difficult to use there is
a simplified synchronous API wrapper polyplib-simple
available. A simple main loop implementation is available as well.
+The following modules are currently available:
+
+
+ - module-oss: driver for Open Sound System audio sinks and sources.
+ - module-oss-mmap: same as above, but uses mmap() access to the audio buffer. Not as compatible
+ - module-alsa-sink, module-alsa-source: drivers for ALSA sinks and sources
+ - module-pipe-sink, module-pipe-source: demonstration module providing UNIX fifos backed sinks/sources
+ - module-combine: combine multiple sinks into one.
+ - module-sine: a sine generate sink input.
+ - module-x11-bell: play a sample from the sample cache on every X11 bell event.
+ - module-esound-protocol-tcp, module-esound-protocol-unix: ESOUND compatibility modules (for TCP/IP resp. UNIX domain sockets)
+ - module-native-protocol-tcp, module-native-protocol-unix: Native polypaudio protocol (for TCP/IP resp. UNIX domain sockets)
+ - module-simple-protocol-tcp, module-simple-protocol-unix: Simplistic protocol for playback/capture for usage with tools like netcat (for TCP/IP resp. UNIX domain sockets)
+ - module-cli-protocol-tcp, module-cli-protocol-unix, module-cli: Expose polypaudio's internals whith a simple command line interface. (for TCP/IP resp. UNIX domain sockets resp. STDIN/STDOUT)
+
+
polypaudio is the successor of my previous, ill-fated
-attempt to write a sound server asd.
A GTK GUI manager application for polypaudio is the Polypaudio
-Manager. Another GTK GUI tool for Polypaudio is the Polypaudio Volume Meter. There are output plugins for . Another GTK GUI tool for Polypaudio is the Polypaudio Volume
+Meter. There are output plugins for XMMS and libao.
+href="http://0pointer.de/lennart/projects/libao-polyp/">libao. Drivers
+for gstreamer and MPlayer will be released shortly.
@@ -116,9 +146,9 @@ href="daemon.html">daemon.html, FAQ.htmlFirst Steps
-Simply start the polypaudio daemon with the argument -C
+Simply start the polypaudio daemon with the argument -nC
-polypaudio -C
+polypaudio -nC
This will present you a screen like this:
@@ -130,10 +160,12 @@ href="cli.html">cli.html. Another way to start
polypaudio is by specifying a configuration script like that one included in the distribution on the
command line :
-polypaudio -F polypaudio.pa
+polypaudio -nF polypaudio.pa
This will load some drivers and protocols automatically.
+The best idea is to configure your daemon in /etc/polypaudio/daemon.conf and /etc/polypaudio/default.pa and to run polypaudio without any arguments.
+
Developing polypaudio Clients
You may browse the Doxygen generated for the client API. (Run make doxygen to generate thi
Protocol support beyond ESOUND's protocol and the native protocol. (such as NAS or a subset of aRts)
New programming interfaces such as XMLRPC or DBUS for controlling the daemon.
Hooking audio event sources directly into polypaudio (similar to module-x11-bell)
- For low latency applications such as VOIP: load the VOIP core directly into polypaudio and have a slim GUI frontend to control it.
+ For low latency applications such as VOIP: load the VOIP core directly into polypaudio and have a slim GUI frontend to control it.
There is currently no documentation how to write loadable modules
--
cgit