diff --git a/tutorials/audio/audio_streams.rst b/tutorials/audio/audio_streams.rst index b831fa14e..6419c0b22 100644 --- a/tutorials/audio/audio_streams.rst +++ b/tutorials/audio/audio_streams.rst @@ -28,15 +28,24 @@ played back often. AudioStreamPlayer ----------------- -.. image:: img/audio_stream_player.png +.. image:: img/audio_stream_player.webp This is the standard, non-positional stream player. It can play to any bus. In 5.1 sound setups, it can send audio to stereo mix or front speakers. +Playback Type is an experimental setting, and could change in future versions +of Godot. It exists so Web exports use Web Audio-API based samples instead of +streaming all sounds to the browser, unlike most platforms. This prevents the +audio from being garbled in single-threaded Web exports. By default, only the +Web platform will use samples. Changing this setting is not recommended, unless +you have an explicit reason to. You can change the default playback type +for the web and other platforms in the project settings under **Audio > General** +(advanced settings must be turned on to see the setting). + AudioStreamPlayer2D ------------------- -.. image:: img/audio_stream_2d.png +.. image:: img/audio_stream_2d.webp This is a variant of AudioStreamPlayer, but emits sound in a 2D positional 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. different reverb or sound qualities to handle action happening in a particular parts of your game world. -.. image:: img/audio_stream_2d_area.png +.. image:: img/audio_stream_2d_area.webp AudioStreamPlayer3D ------------------- -.. image:: img/audio_stream_3d.png +.. image:: img/audio_stream_3d.webp This is a variant of AudioStreamPlayer, but emits sound in a 3D positional environment. Depending on the location of the player relative to the screen, it can position sound in stereo, 5.1 or 7.1 depending on the chosen audio setup. -Similar to AudioStreamPlayer2D, an Area can divert the sound to an audio bus. +Similar to AudioStreamPlayer2D, an Area3D can divert the sound to an audio bus. -.. image:: img/audio_stream_3d_area.png +.. image:: img/audio_stream_3d_area.webp Unlike for 2D, the 3D version of AudioStreamPlayer has a few more advanced options: @@ -71,20 +80,20 @@ Unlike for 2D, the 3D version of AudioStreamPlayer has a few more advanced optio Reverb buses ~~~~~~~~~~~~ -Godot allows for 3D audio streams that enter a specific Area node to send dry +Godot allows for 3D audio streams that enter a specific Area3D node to send dry and wet audio to separate buses. This is useful when you have several reverb configurations for different types of rooms. This is done by enabling this type -of reverb in the **Reverb Bus** section of the Area's properties: +of reverb in the **Reverb Bus** section of the Area3D's properties: -.. image:: img/audio_stream_reverb_bus.png +.. image:: img/audio_stream_reverb_bus.webp -At the same time, a special bus layout is created where each area receives the -reverb info from each area. A Reverb effect needs to be created and configured +At the same time, a special bus layout is created where each Area3D receives the +reverb info from each Area3D. A Reverb effect needs to be created and configured in each reverb bus to complete the setup for the desired effect: -.. image:: img/audio_stream_reverb_bus2.png +.. image:: img/audio_stream_reverb_bus2.webp -The Area's **Reverb Bus** section also has a parameter named **Uniformity**. +The Area3D's **Reverb Bus** section also has a parameter named **Uniformity**. Some types of rooms bounce sounds more than others (like a warehouse), so reverberation can be heard almost uniformly across the room even though the 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. Godot can track velocity changes in the AudioStreamPlayer3D and Camera nodes. Both nodes have this property, which must be enabled manually: -.. image:: img/audio_stream_doppler.png +.. image:: img/audio_stream_doppler.webp Enable it by setting it depending on how objects will be moved: use **Idle** for objects moved using ``_process``, or **Physics** diff --git a/tutorials/audio/img/audio_stream_2d.png b/tutorials/audio/img/audio_stream_2d.png deleted file mode 100644 index 23f899fbe..000000000 Binary files a/tutorials/audio/img/audio_stream_2d.png and /dev/null differ diff --git a/tutorials/audio/img/audio_stream_2d.webp b/tutorials/audio/img/audio_stream_2d.webp new file mode 100644 index 000000000..c992e5219 Binary files /dev/null and b/tutorials/audio/img/audio_stream_2d.webp differ diff --git a/tutorials/audio/img/audio_stream_2d_area.png b/tutorials/audio/img/audio_stream_2d_area.png deleted file mode 100644 index 4f46a72f6..000000000 Binary files a/tutorials/audio/img/audio_stream_2d_area.png and /dev/null differ diff --git a/tutorials/audio/img/audio_stream_2d_area.webp b/tutorials/audio/img/audio_stream_2d_area.webp new file mode 100644 index 000000000..e15378f9d Binary files /dev/null and b/tutorials/audio/img/audio_stream_2d_area.webp differ diff --git a/tutorials/audio/img/audio_stream_3d.png b/tutorials/audio/img/audio_stream_3d.png deleted file mode 100644 index 200b87435..000000000 Binary files a/tutorials/audio/img/audio_stream_3d.png and /dev/null differ diff --git a/tutorials/audio/img/audio_stream_3d.webp b/tutorials/audio/img/audio_stream_3d.webp new file mode 100644 index 000000000..f2ad40bfb Binary files /dev/null and b/tutorials/audio/img/audio_stream_3d.webp differ diff --git a/tutorials/audio/img/audio_stream_3d_area.png b/tutorials/audio/img/audio_stream_3d_area.png deleted file mode 100644 index 86f8b9516..000000000 Binary files a/tutorials/audio/img/audio_stream_3d_area.png and /dev/null differ diff --git a/tutorials/audio/img/audio_stream_3d_area.webp b/tutorials/audio/img/audio_stream_3d_area.webp new file mode 100644 index 000000000..3f6e9dbda Binary files /dev/null and b/tutorials/audio/img/audio_stream_3d_area.webp differ diff --git a/tutorials/audio/img/audio_stream_doppler.png b/tutorials/audio/img/audio_stream_doppler.png deleted file mode 100644 index 4c7bf2bd7..000000000 Binary files a/tutorials/audio/img/audio_stream_doppler.png and /dev/null differ diff --git a/tutorials/audio/img/audio_stream_doppler.webp b/tutorials/audio/img/audio_stream_doppler.webp new file mode 100644 index 000000000..f540dc110 Binary files /dev/null and b/tutorials/audio/img/audio_stream_doppler.webp differ diff --git a/tutorials/audio/img/audio_stream_player.png b/tutorials/audio/img/audio_stream_player.png deleted file mode 100644 index b70011e8a..000000000 Binary files a/tutorials/audio/img/audio_stream_player.png and /dev/null differ diff --git a/tutorials/audio/img/audio_stream_player.webp b/tutorials/audio/img/audio_stream_player.webp new file mode 100644 index 000000000..855471b54 Binary files /dev/null and b/tutorials/audio/img/audio_stream_player.webp differ diff --git a/tutorials/audio/img/audio_stream_reverb_bus.png b/tutorials/audio/img/audio_stream_reverb_bus.png deleted file mode 100644 index d7eb79420..000000000 Binary files a/tutorials/audio/img/audio_stream_reverb_bus.png and /dev/null differ diff --git a/tutorials/audio/img/audio_stream_reverb_bus.webp b/tutorials/audio/img/audio_stream_reverb_bus.webp new file mode 100644 index 000000000..4fc921662 Binary files /dev/null and b/tutorials/audio/img/audio_stream_reverb_bus.webp differ diff --git a/tutorials/audio/img/audio_stream_reverb_bus2.png b/tutorials/audio/img/audio_stream_reverb_bus2.png deleted file mode 100644 index 726104adb..000000000 Binary files a/tutorials/audio/img/audio_stream_reverb_bus2.png and /dev/null differ diff --git a/tutorials/audio/img/audio_stream_reverb_bus2.webp b/tutorials/audio/img/audio_stream_reverb_bus2.webp new file mode 100644 index 000000000..265ed211a Binary files /dev/null and b/tutorials/audio/img/audio_stream_reverb_bus2.webp differ