]> code.delx.au - pulseaudio/blobdiff - man/pulse-daemon.conf.5.xml.in
core: infrastructure for alternate sampling rate
[pulseaudio] / man / pulse-daemon.conf.5.xml.in
index 243c9e2a307e2002b063a00fba63af045c2b6ab4..33ea79204d0f40df09e7f8e7a870ac9c17187800 100644 (file)
@@ -26,14 +26,14 @@ USA.
   <synopsis>
     <p><file>~/.pulse/daemon.conf</file></p>
 
-    <p><file>@pulseconfdir@/daemon.conf</file></p>
+    <p><file>@PA_DEFAULT_CONFIG_DIR@/daemon.conf</file></p>
   </synopsis>
 
   <description>
     <p>The PulseAudio sound server reads configuration directives from
     a file <file>~/.pulse/daemon.conf</file> on startup and when that
     file doesn't exist from
-    <file>@pulseconfdir@/daemon.conf</file>. Please note that the
+    <file>@PA_DEFAULT_CONFIG_DIR@/daemon.conf</file>. Please note that the
     server also reads a configuration script on startup
     <file>default.pa</file> which also contains runtime configuration
     directives.</p>
@@ -90,19 +90,20 @@ USA.
       <opt>trivial</opt>, <opt>speex-float-N</opt>,
       <opt>speex-fixed-N</opt>, <opt>ffmpeg</opt>. See 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
-      all. The Speex resamplers take an integer quality setting in the
-      range 0..9 (bad...good). They exist in two flavours: <opt>fixed</opt> and
-      <opt>float</opt>. The former uses fixed point numbers, the latter relies on
-      floating point numbers. On most desktop CPUs the float point
-      resmampler is a lot faster, and it also offers slightly better
-      quality. See the output of <opt>dump-resample-methods</opt> for
-      a complete list of all available resamplers. Defaults to
-      <opt>speex-float-3</opt>. The <opt>--resample-method</opt>
-      command line option takes precedence. Note that some modules
-      overwrite or allow overwriting of the resampler to use.</p>
+      different src- and speex- methods, respectively. 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 all. The Speex resamplers take an
+      integer quality setting in the range 0..10 (bad...good). They
+      exist in two flavours: <opt>fixed</opt> and <opt>float</opt>. The former uses fixed point
+      numbers, the latter relies on floating point numbers. On most
+      desktop CPUs the float point resampler is a lot faster, and it
+      also offers slightly better quality. See the output of
+      <opt>dump-resample-methods</opt> for a complete list of all
+      available resamplers. Defaults to <opt>speex-float-3</opt>. The
+      <opt>--resample-method</opt> command line option takes precedence.
+      Note that some modules overwrite or allow overwriting of the
+      resampler to use.</p>
     </option>
 
     <option>
@@ -261,8 +262,8 @@ USA.
       default script file. The default behaviour is to load
       <file>~/.pulse/default.pa</file>, and if that file does not
       exist fall back to the system wide installed version
-      <file>@pulseconfdir@/default.pa</file>. If run in system-wide
-      mode the file <file>@pulseconfdir@/system.pa</file> is used
+      <file>@PA_DEFAULT_CONFIG_DIR@/default.pa</file>. If run in system-wide
+      mode the file <file>@PA_DEFAULT_CONFIG_DIR@/system.pa</file> is used
       instead. If <opt>-n</opt> is passed on the command line
       or <opt>default-script-file=</opt> is disabled the default
       configuration script is ignored.</p>
@@ -413,6 +414,15 @@ USA.
       <p><opt>default-channel-map</opt> The default channel map.</p>
     </option>
 
+    <option>
+      <p><opt>alternate-sample-rate</opt> The alternate sample
+      frequency. Sinks and sources will use either the
+      default-rate-rate value or this alternate value, typically 44.1
+      or 48kHz. Switching between default and alternate values is
+      enabled only when the sinks/sources are suspended. This option
+      is ignored in passthrough mode where the stream rate will be used.</p>
+    </option>
+
   </section>
 
   <section name="Default Fragment Settings">
@@ -437,7 +447,7 @@ USA.
 
   </section>
 
-  <section name="Default Sync Volume Settings">
+  <section name="Default Deferred 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
@@ -447,20 +457,20 @@ USA.
     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
+    implementation needs to support deferred 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
+      <p><opt>enable-deferred-volume=</opt> Enable deferred 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
+      <p><opt>deferred-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)
+      <p><opt>deferred-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>