Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update audio streams page for Godot 4.3 #9522

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

skyace65
Copy link
Contributor

Documents the new Playback Type property in audio streams (Added in this PR). I've also updated every image on the page for Godot 4.3.

@skyace65 skyace65 added enhancement area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Jun 22, 2024
@skyace65 skyace65 added this to the 4.3 milestone Jun 22, 2024
@skyace65 skyace65 requested a review from adamscott June 22, 2024 16:18
@adamscott
Copy link
Member

Thank you so much! I'll review it asap.

Copy link
Member

@mhilbrunner mhilbrunner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I'll leave time for Adam to also review :) Great work!

@mhilbrunner
Copy link
Member

gentle reminder poke @adamscott

@adamscott
Copy link
Member

@mhilbrunner Thanks for the poke. It was needed indeed.

Copy link
Member

@adamscott adamscott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than my small nitpicks, it seems fine! Thanks!

Comment on lines +36 to +42
Playback Type is an experimental setting, and could change in future versions
of Godot. It exists so web exports use samples for audio instead of streams,
this prevents the audio from being garbled in single threaded web exports. By
default only the web platform will use samples, changing this 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).
Copy link
Member

@adamscott adamscott Jun 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Playback Type is an experimental setting, and could change in future versions
of Godot. It exists so web exports use samples for audio instead of streams,
this prevents the audio from being garbled in single threaded web exports. By
default only the web platform will use samples, changing this 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).
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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants