fly/flightgear
1
0
Fork 0
Code Activity

sync with $FG_ROOT/Docs/READEM.xmlsound:

Browse source 
- <delay-sec> added
- spelling fixes
- fix mixed indentation
This commit is contained in:
mfranz 2008-05-21 15:00:20 +00:00
parent 504b74ee47
commit 8dbfe52319
1 changed files with 112 additions and 104 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
docs-mini/README.xmlsound
View file

@ -123,10 +123,10 @@ Configuration description:
once: the sample is played once. once: the sample is played once.
this is the default. this is the default.
looped: the sample plays continuesly, looped: the sample plays continuously,
until the event turns false. until the event turns false.
in-transit: the sample plays continuesly, in-transit: the sample plays continuously,
while the property is changing its value. while the property is changing its value.
<volume> / <pitch> <volume> / <pitch>
@ -141,17 +141,22 @@ Configuration description:
<property> <property>
Defines which property supplies the value for the calculation. Defines which property supplies the value for the calculation.
Either a <property> or an <internal> should be defined. Either a <property> or an <internal> should be defined.
The value is threated as a floating point number. The value is treated as a floating point number.
<internal> <internal>
Defines which internal variable should be used for the calculation. Defines which internal variable should be used for the calculation.
The value is threated as a floating point number. The value is treated as a floating point number.
The following internals are available at this time: The following internals are available at this time:
dt_play: the number of seconds since the sound started playing. dt_play: the number of seconds since the sound started playing.
dt_stop: the number of seconds after the sound has stopped. dt_stop: the number of seconds after the sound has stopped.
<delay-sec>
Delay after which the sound starts playing. This is useful to let
a property start two sounds at the same time, where the second is
delayed until the first stopped playing.
<type> <type>
Defines the function that should be used upon the property Defines the function that should be used upon the property
before it is used for calculating the net result: before it is used for calculating the net result:
@ -159,13 +164,13 @@ Configuration description:
lin: linear handling of the property value. lin: linear handling of the property value.
this is the default. this is the default.
ln: convert the absolute property value to a natural ln: convert the property value to a natural logarithmic
logarithmic value before scaling it. value before scaling it. Anything below 1 will return
Anything below 1 will return zero. zero.
log: convert the absolute property value to a true log: convert the property value to a true logarithmic
logarithmic value before scaling it. value before scaling it. Anything below 1 will return
Anything below 1 will return zero. zero.
inv: inverse linear handling (1/x). inv: inverse linear handling (1/x).
@ -196,9 +201,11 @@ Configuration description:
<position> <position>
Specify the position of the sounds source relative to the Specify the position of the sounds source relative to the
pilot's ears. The coordinate system used is a right hand aircraft center. The coordinate system used is a right hand
coordinate system where -X = left, +X = right, -Y = down, +Y = coordinate system where +Y = left, -Y = right, -Z = down, +Z =
up, -Z = forward, +Z = aft. Distances are in meters. up, -X = forward, +X = aft. Distances are in meters.
The volume calculation due to distance and orientation of the
sounds source ONLY work on mono samples!
<x> <x>
X dimension offset X dimension offset
@ -214,22 +221,23 @@ Configuration description:
Specify the orientation of the sounds source. Specify the orientation of the sounds source.
The zero vector is default, indicating that a Source is not directional. The zero vector is default, indicating that a Source is not directional.
Specifying a non-zero vector will make the Source directional. Specifying a non-zero vector will make the Source directional in
the X,Y,Z direction
<x> <x>
X dimension angle (0.0 - 360.0) X dimension
<y> <y>
Y dimension angle (0.0 - 360.0) Y dimension
<z> <z>
Z dimension angle (0.0 - 360.0) Z dimension
<inner-cone> <inner-angle>
The inner edge of the audio cone in degrees (0.0 - 360.0). 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. Any sound withing that angle will be played at the current gain.
<outer-cone> <outer-angle>
The outer edge of the audio cone in degrees (0.0 - 360.0). 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. Any sound beyond the outer cone will be played at "outer-gain" volume.
@ -247,8 +255,8 @@ Configuration description:
This can be useful for limiting cockpit sounds to the cockpit. This can be useful for limiting cockpit sounds to the cockpit.
Creating a configration file: Creating a configuration file:
---------------------------- ------------------------------
To make things easy, there is a default value for most entries to allow a To make things easy, there is a default value for most entries to allow a
sane configuration when a certain entry is omitted. sane configuration when a certain entry is omitted.