[pulseaudio-discuss] [PATCH 5/5] man: sync_volume parameters to manual page

[Paul Menzel]

Dear Colin,


Am Donnerstag, den 14.10.2010, 20:30 +0100 schrieb Colin Guthrie:
> Subject: [PATCH] man: sync_volume parameters to manual page
> 
> Some wording teaks by Colin Guthrie
> 
> Signed-off-by: Jyri Sarha <jyri.sarha at nokia.com>
> Reviewed-by: Tanu Kaskinen <tanu.kaskinen at digia.com>
> ---
>  man/pulse-daemon.conf.5.xml.in |   26 ++++++++++++++++++++++++++
>  1 files changed, 26 insertions(+), 0 deletions(-)
> 
> diff --git a/man/pulse-daemon.conf.5.xml.in b/man/pulse-daemon.conf.5.xml.in
> index b5c9e92..f0a642b 100644
> --- a/man/pulse-daemon.conf.5.xml.in
> +++ b/man/pulse-daemon.conf.5.xml.in
> @@ -437,6 +437,32 @@ USA.
>  
>    </section>
>  
> +  <section name="Default Sync Volume Settings">
> +
> +    <p>The flat volume feature sets the sink HW volume according to the
> +    highest volume input stream and reduces the volume any other streams
> +    (with lower volumes) in SW. To make this concurrent and ensure SW and
> +    HW volume work together without any glitches, their application needs to
> +    be synchronized. The sink implementation needs to support this
> +    feature in order to these parameters to take effect.</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 unit of time by which
> +      the HW volume increases are delayed and HW volume decreases are advanced.
> +      Defaults to 8000 usec.</p>

I am not sure, but I would read it that I have to give the unit of time,
i. e., seconds, hours, milliseconds, …, as a value. So I think the
former wording is more correct. Since the unit of time is `usecs`.

> +    </option>
> +    <option>
> +      <p><opt>sync-volume-extra-delay-usec=</opt> The unit of time all HW
> +      volume changes are delayed. Negative values are also allowed.
> +      Defaults to 0.</p>
> +    </option>
> +
> +  </section>

I am still thinking that a „normal“ users does not have a clue on how to
determine to what value these options should be set. So it should be
marked as expert value or something or a hint should be given on how one
can determine what values should be used.

> +
>    <section name="Authors">
>      <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
>    </section>


Thanks,

Paul
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: This is a digitally signed message part
URL: <http://lists.freedesktop.org/archives/pulseaudio-discuss/attachments/20101015/20b9a1c6/attachment.pgp>