[Bf-docboard-svn] bf-manual: [8500] trunk/blender_docs/manual: Adding new audio engines that were recently added and detailing panning for sound strips in the VSE.

[Joerg Mueller]

Revision: 8500
          https://developer.blender.org/rBM8500
Author:   nexyon
Date:     2021-10-22 22:26:16 +0200 (Fri, 22 Oct 2021)
Log Message:
-----------
Adding new audio engines that were recently added and detailing panning for sound strips in the VSE.

Modified Paths:
--------------
    trunk/blender_docs/manual/editors/preferences/system.rst
    trunk/blender_docs/manual/video_editing/sequencer/sidebar/strip.rst

Modified: trunk/blender_docs/manual/editors/preferences/system.rst
===================================================================
--- trunk/blender_docs/manual/editors/preferences/system.rst	2021-10-22 04:11:24 UTC (rev 8499)
+++ trunk/blender_docs/manual/editors/preferences/system.rst	2021-10-22 20:26:16 UTC (rev 8500)
@@ -125,7 +125,7 @@
 =====
 
 This panel contains the sound settings for live playback
-within Blender and are only available with *SDL* or *OpenAL*.
+within Blender and are only available with a device other than *None*.
 To control these settings for exporting sound
 see the :ref:`Encoding Panel <render-output-video-encoding-panel>`
 and :ref:`Audio Panel <data-scenes-audio>`.
@@ -134,13 +134,25 @@
    Sets the audio engine to use to process and output audio.
 
    :None:
-      No Audio support (audio strips can still be loaded normally).
+      No audio playback support (audio strips can still be loaded and rendered normally).
+   :CoreAudio:
+      On macOS, CoreAudio is the native audio API.
+      This is the default setting for macOS users and should be preferred.
+   :PulseAudio:
+      PulseAudio is the most commonly used sound server on modern Linux distributions.
+      If PulseAudio is available, this should be the preferred setting on Linux.
+   :WASAPI:
+      On Windows, WASAPI is the native audio API introduced with Windows Vista.
+      This is the default setting for Windows users and should be preferred.
+   :Jack:
+      High quality professional audio engine that needs a properly configured server running on your system.
+      Supports accurate synchronization with other professional audio applications using Jack.
+   :OpenAL:
+      Available on all platforms in case the native engines do not work.
+      The played back 3D audio might sound different than when rendered.
    :SDL:
       Uses Simple Direct Media Layer API from `libsdl.org <https://www.libsdl.org>`__
-      to render sounds directly to the sound device output. Very useful for Sequencer strips editing.
-   :OpenAL:
-      Provides buffered sound rendering with 3D/spatial support.
-      Used for 3D source support by speaker objects.
+      which supports all platforms. Might be of lower quality and thus should only be used as backup.
 
 Channels
    Sets the audio channel count.

Modified: trunk/blender_docs/manual/video_editing/sequencer/sidebar/strip.rst
===================================================================
--- trunk/blender_docs/manual/video_editing/sequencer/sidebar/strip.rst	2021-10-22 04:11:24 UTC (rev 8499)
+++ trunk/blender_docs/manual/video_editing/sequencer/sidebar/strip.rst	2021-10-22 20:26:16 UTC (rev 8500)
@@ -122,10 +122,13 @@
    Coefficient of playback speed.
    This value will affect length of the strip, that will not be represented in the timeline.
 Pan
-   Used to pan the audio from left and right channels. Only works for mono sources.
-   Values can be between -2 and 2, where 0 means front/center, -1 means to the left and 1 to the right.
-   In case of multichannel audio (rear speakers) you can pan to those with the higher values: -2, 2 is back.
-   So this value basically represents the angle at which it's played.
+   Used to pan the audio between speakers in multichannel audio. Only works for mono sources.
+   The number of audio channels can be configured in the :ref:`Audio Output <render-output-video-encoding-audio>` settings.
+   For stereo output panning works from left (-1) to right (1) .
+   When the output uses more than two channels, values can be between -2 and 2, where 0 means front/center, -1 means to the left and 1 to the right.
+   To address rear speakers, you can pan to those with the higher values: -2, 2 is back.
+   This value basically represents the angle at which it's played if you multiply the value by 90 degrees.
+   For smooth animation you can assign values outside the soft bounds, since the angle wraps around over multiple rotations.
 
 .. _bpy.types.SoundSequence.show_waveform: