Update polyp plugin

From: Pierre Ossman <ossman@cendio.se>

Here is a final update to the plugin and the documentation. This release
adds capture volume and mute switches. This should also be the last API
change in polypaudio before the next release, so this plugin should be
stable for now.

1 files changed, 41 insertions, 0 deletions

diff --git a/doc/README-polyp b/doc/README-polyp
new file mode 100644
index 0000000..de46c3d
--- /dev/null
+++ b/doc/README-polyp
@@ -0,0 +1,41 @@
+Polypaudio <--> ALSA plugins
+============================
+
+This plugin allows any program that uses the ALSA API to access a Polypaudio
+sound daemon. In other words, native ALSA applications can play and record
+sound across a network.
+
+There are two plugins in the suite, one for PCM and one for mixer control. A
+typical configuration will look like:
+
+    pcm.polyp {
+        type polyp
+    }
+
+    ctl.polyp {
+        type polyp
+    }
+
+Put the above in ~/.asoundrc, or /etc/asound.conf, and use "polyp" as device
+in your ALSA applications. For example:
+
+    % aplay -Dpolyp foo.wav
+    % amixer -Dpolyp
+
+Polypaudio will accept more or less any format you throw at it. So a plug
+wrapper is unnecessary. Mixing is also handled so dmix will only cause a
+performance hit without any gain.
+
+The plugins will respect your Polypaudio environment variables (like
+POLYP_SERVER), but you can override these in ALSA's configuration files.
+
+Both plugins accept the "server" parameter, specifying which Polypaudio server
+to contact. Both also accept the "device" parameter, which indicate which
+source and sink to use.
+
+The mixer control plugin also accepts the parameters "source" and "sink" for
+when you need to specify a sink/source combination with different names. If
+you need to do this with PCM:s then specify two PCM:s with different "device".
+
+If you do not specify any source and/or sink, then the server's defaults will
+be used.