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

Clarify difference between Capture and Record audio effects #85468

Merged

Conversation

RedMser
Copy link
Contributor

@RedMser RedMser commented Nov 28, 2023

Updated documentation of AudioEffectCapture and AudioEffectRecord:

  • Capture returns a raw audio buffer, while Record encodes it into an audio stream.
  • The note about enable_input setting was confusing in Capture docs, since the microphone use-case is only one of the many listed.
  • Additionally, the demo project listed uses the Record effect, not Capture! So moved that note and link to the Record effect instead.
  • Record also had a very weird wording in its docs ("It sets, It checks, It returns"...) which I cleaned up.

Copy link
Member

@fire fire left a comment

Choose a reason for hiding this comment

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

@lyuma I think this looks ok.

@YuriSizov YuriSizov modified the milestones: 4.x, 4.3 Dec 13, 2023
@akien-mga akien-mga merged commit 2bbe1e8 into godotengine:master Jan 9, 2024
15 checks passed
@akien-mga
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants