[polypaudio-commits] r904 - /trunk/doc/modules.html.in

[svnmailer-noreply at 0pointer.de]

Author: lennart
Date: Wed May 17 17:19:30 2006
New Revision: 904

URL: http://0pointer.de/cgi-bin/viewcvs.cgi?rev=904&root=polypaudio&view=rev
Log:
add documentation for module-volume-restore

Modified:
    trunk/doc/modules.html.in

Modified: trunk/doc/modules.html.in
URL: http://0pointer.de/cgi-bin/viewcvs.cgi/trunk/doc/modules.html.in?rev=904&root=polypaudio&r1=903&r2=904&view=diff
==============================================================================
--- trunk/doc/modules.html.in (original)
+++ trunk/doc/modules.html.in Wed May 17 17:19:30 2006
@@ -464,16 +464,30 @@
 <p>Adjust the volume of a playback stream automatically based on its name.</p>
 
 <table>
-  <tr><td><tt>table=</tt></td><td>The regular expression matching table file to use</td></tr>
+  <tr><td><tt>table=</tt></td><td>The regular expression matching table file to use (defaults to <tt>~/.polypaudio/match.table</tt>)</td></tr>
 </table>
 
 <p>The table file should contain a regexp and volume on each line, seperated by spaces. An example:</p>
 
 <pre>
-^sample: 25
+^sample: 32000
 </pre>
 
-<p>The volumes of all streams with titles starting with <tt>sample:</tt> are automatically set to 25. (FYI: All sample cache streams start with <tt>sample:</tt>)</p>
+<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>
+
+<h3>module-volume-restore</h3>
+
+<p>Adjust the volume of a playback stream automatically based on its name.</p>
+
+<table>
+  <tr><td><tt>table=</tt></td><td>The table file to use (defaults to <tt>~/.polypaudio/volume.table</tt>)</td></tr>
+</table>
+
+<p>In contrast to <tt>module-match</tt> this module needs no explicit
+configuration. Instead the volumes are saved and restored in a fully
+automatical fashion depending on the client name to identify
+streams. The volume for a stream is automatically saved every time it is
+changed and than restored when a new stream is created.</p>
 
 <h3>module-detect</h3>