Skip to content

Commit 0ef9668

Browse files
authored
Merge pull request #9522 from skyace65/AudioStream
Update audio streams page for Godot 4.3
2 parents acd5c65 + 5e5156d commit 0ef9668

17 files changed

+23
-14
lines changed

tutorials/audio/audio_streams.rst

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,24 @@ played back often.
2828
AudioStreamPlayer
2929
-----------------
3030

31-
.. image:: img/audio_stream_player.png
31+
.. image:: img/audio_stream_player.webp
3232

3333
This is the standard, non-positional stream player. It can play to any bus.
3434
In 5.1 sound setups, it can send audio to stereo mix or front speakers.
3535

36+
Playback Type is an experimental setting, and could change in future versions
37+
of Godot. It exists so Web exports use Web Audio-API based samples instead of
38+
streaming all sounds to the browser, unlike most platforms. This prevents the
39+
audio from being garbled in single-threaded Web exports. By default, only the
40+
Web platform will use samples. Changing this setting is not recommended, unless
41+
you have an explicit reason to. You can change the default playback type
42+
for the web and other platforms in the project settings under **Audio > General**
43+
(advanced settings must be turned on to see the setting).
44+
3645
AudioStreamPlayer2D
3746
-------------------
3847

39-
.. image:: img/audio_stream_2d.png
48+
.. image:: img/audio_stream_2d.webp
4049

4150
This is a variant of AudioStreamPlayer, but emits sound in a 2D positional
4251
environment. When close to the left of the screen, the panning will go left.
@@ -49,20 +58,20 @@ When close to the right side, it will go right.
4958
different reverb or sound qualities to handle action happening in a
5059
particular parts of your game world.
5160

52-
.. image:: img/audio_stream_2d_area.png
61+
.. image:: img/audio_stream_2d_area.webp
5362

5463
AudioStreamPlayer3D
5564
-------------------
5665

57-
.. image:: img/audio_stream_3d.png
66+
.. image:: img/audio_stream_3d.webp
5867

5968
This is a variant of AudioStreamPlayer, but emits sound in a 3D positional
6069
environment. Depending on the location of the player relative to the screen,
6170
it can position sound in stereo, 5.1 or 7.1 depending on the chosen audio setup.
6271

63-
Similar to AudioStreamPlayer2D, an Area can divert the sound to an audio bus.
72+
Similar to AudioStreamPlayer2D, an Area3D can divert the sound to an audio bus.
6473

65-
.. image:: img/audio_stream_3d_area.png
74+
.. image:: img/audio_stream_3d_area.webp
6675

6776
Unlike for 2D, the 3D version of AudioStreamPlayer has a few more advanced options:
6877

@@ -71,20 +80,20 @@ Unlike for 2D, the 3D version of AudioStreamPlayer has a few more advanced optio
7180
Reverb buses
7281
~~~~~~~~~~~~
7382

74-
Godot allows for 3D audio streams that enter a specific Area node to send dry
83+
Godot allows for 3D audio streams that enter a specific Area3D node to send dry
7584
and wet audio to separate buses. This is useful when you have several reverb
7685
configurations for different types of rooms. This is done by enabling this type
77-
of reverb in the **Reverb Bus** section of the Area's properties:
86+
of reverb in the **Reverb Bus** section of the Area3D's properties:
7887

79-
.. image:: img/audio_stream_reverb_bus.png
88+
.. image:: img/audio_stream_reverb_bus.webp
8089

81-
At the same time, a special bus layout is created where each area receives the
82-
reverb info from each area. A Reverb effect needs to be created and configured
90+
At the same time, a special bus layout is created where each Area3D receives the
91+
reverb info from each Area3D. A Reverb effect needs to be created and configured
8392
in each reverb bus to complete the setup for the desired effect:
8493

85-
.. image:: img/audio_stream_reverb_bus2.png
94+
.. image:: img/audio_stream_reverb_bus2.webp
8695

87-
The Area's **Reverb Bus** section also has a parameter named **Uniformity**.
96+
The Area3D's **Reverb Bus** section also has a parameter named **Uniformity**.
8897
Some types of rooms bounce sounds more than others (like a warehouse), so
8998
reverberation can be heard almost uniformly across the room even though the
9099
source may be far away. Playing around with this parameter can simulate
@@ -98,7 +107,7 @@ perceived as an increase or decrease in the pitch of the emitted sound.
98107
Godot can track velocity changes in the AudioStreamPlayer3D and Camera nodes.
99108
Both nodes have this property, which must be enabled manually:
100109

101-
.. image:: img/audio_stream_doppler.png
110+
.. image:: img/audio_stream_doppler.webp
102111

103112
Enable it by setting it depending on how objects will be moved:
104113
use **Idle** for objects moved using ``_process``, or **Physics**
-6.09 KB
Binary file not shown.
10.7 KB
Binary file not shown.
-7.01 KB
Binary file not shown.
5.71 KB
Binary file not shown.
-8.22 KB
Binary file not shown.
12.4 KB
Binary file not shown.
-7.33 KB
Binary file not shown.
6.33 KB
Binary file not shown.
-3.89 KB
Binary file not shown.

0 commit comments

Comments
 (0)