Bring up to date.

[flightgear.git] / docs-mini / README.xmlsound

diff --git a/docs-mini/README.xmlsound b/docs-mini/README.xmlsound
index c8ed950cf2efc990aa805b042f66ac36f6930c1d..4c8b22073752124e51e9dbb3e1c23071a8c5a09c 100644 (file)
--- a/docs-mini/README.xmlsound
+++ b/docs-mini/README.xmlsound
@@ -209,6 +209,59 @@ Configuration description:
        This is usefull if sounds gets to loud. Anything higher will be
        truncated to this value.
 
+   <position>
+        Specify the position of the sounds source relative to the
+        pilot's ears.  The coordinate system used is a right hand
+        coordinate system where -X = left, +X = right, -Y = down, +Y =
+        up, -Z = forward, +Z = aft.  Distances are in meters.
+
+     <x>
+        X dimension offset
+
+     <y>
+        Y dimension offset
+
+     <z>
+        Z dimension offset
+
+
+   <orientation>
+        Specify the orientation of the sounds source.
+
+        The zero vector is default, indicating that a Source is not directional.
+        Specifying a non-zero vector will make the Source directional.
+
+     <x>
+        X dimension angle (0.0 - 360.0)
+
+     <y>
+        Y dimension angle (0.0 - 360.0)
+
+     <z>
+        Z dimension angle (0.0 - 360.0)
+
+     <inner-cone>
+        The inner edge of the audio cone in degrees (0.0 - 360.0).
+        Any sound withing that angle will be played at the current gain.
+
+     <outer-cone>
+        The outer edge of the audio cone in degrees (0.0 - 360.0).
+        Any sound beyond the outer cone will be played at "outer-gain" volume.
+
+     <outer-gain>
+        The gain at the outer edge of the cone.
+
+
+   <reference-dist>
+        Set a reference distance of sound in meters.  This is the
+        distance where the gain/volume will be halved.  This can be
+        useful for limiting cockpit sounds to the cockpit.
+
+   <max-dist>
+        Set the maximum audible distance for the sound in meters.
+        This can be useful for limiting cockpit sounds to the cockpit.
+
+
 Creating a configrationfile:
 ---------------------------