trivial: Mention speex as a resampler reference in pulse-daemon.conf

[pulseaudio] / man / pulse-daemon.conf.5.xml.in

diff --git a/man/pulse-daemon.conf.5.xml.in b/man/pulse-daemon.conf.5.xml.in
index b5c9e9219f35a6547ef76e909b700aba6942a141..243c9e2a307e2002b063a00fba63af045c2b6ab4 100644 (file)
--- a/man/pulse-daemon.conf.5.xml.in
+++ b/man/pulse-daemon.conf.5.xml.in
@@ -89,7 +89,7 @@ USA.
       <opt>src-zero-order-hold</opt>, <opt>src-linear</opt>,
       <opt>trivial</opt>, <opt>speex-float-N</opt>,
       <opt>speex-fixed-N</opt>, <opt>ffmpeg</opt>. See the
-      documentation of libsamplerate for an explanation for the
+      documentation of libsamplerate and speex for explanations of the
       different src- methods. The method <opt>trivial</opt> is the most basic
       algorithm implemented. If you're tight on CPU consider using
       this. On the other hand it has the worst quality of them
@@ -122,13 +122,13 @@ USA.
     </option>
 
     <option>
-      <p><opt>use-pid-file=</opt> Create a PID file in
-      <file>/tmp/pulse-$USER/pid</file>. Of this is enabled you may
+      <p><opt>use-pid-file=</opt> Create a PID file in the runtime directory
+      (<file>$HOME/.pulse/*-runtime/pid</file>). If this is enabled you may
       use commands like <opt>--kill</opt> or <opt>--check</opt>. If
       you are planning to start more than one PulseAudio process per
       user, you better disable this option since it effectively
       disables multiple instances. Takes a boolean argument, defaults
-      to <opt>yes</opt>. The <opt>--no-cpu-limit</opt> command line
+      to <opt>yes</opt>. The <opt>--use-pid-file</opt> command line
       option takes precedence.</p>
     </option>
 
@@ -437,6 +437,36 @@ USA.
 
   </section>
 
+  <section name="Default Sync Volume Settings">
+
+    <p>With the flat volume feature enabled, the sink HW volume is set
+    to the same level as the highest volume input stream. Any other streams
+    (with lower volumes) have the appropriate adjustment applied in SW to
+    bring them to the correct overall level. Sadly hadware mixer changes
+    cannot be timed accurately and thus this change of volumes can somtimes
+    cause the resulting output sound to be momentarily too loud or too soft.
+    So to ensure SW and HW volumes are applied concurrently without any
+    glitches, their application needs to be synchronized. The sink
+    implementation needs to support synchronized volumes. The following
+    parameters can be used to refine the process.</p>
+
+    <option>
+      <p><opt>enable-sync-volume=</opt> Enable sync volume for the sinks that
+      support it. This feature is enabled by default.</p>
+    </option>
+    <option>
+      <p><opt>sync-volume-safety-margin-usec=</opt> The amount of time (in
+      usec) by which the HW volume increases are delayed and HW volume
+      decreases are advanced. Defaults to 8000 usec.</p>
+    </option>
+    <option>
+      <p><opt>sync-volume-extra-delay-usec=</opt> The amount of time (in usec)
+      by which HW volume changes are delayed. Negative values are also allowed.
+      Defaults to 0.</p>
+    </option>
+
+  </section>
+
   <section name="Authors">
     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
   </section>