Fix: Update AudioBuffer parameters to remove deprecated options #36562
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FizanMuhammedFaisal
requested review from
wbamberg
and removed request for
a team
github-actions
bot
added
Content:WebAPI
|
Preview URLs (comment last updated: 2024-10-29 17:27:09) |
wbamberg
reviewed
Oct 29, 2024
There was a problem hiding this comment.
I would just delete these three options, and the context option as well for that matter. I can't find any references to them in the specs. #36555 points out that there used to be a gain attribute, and that perhaps they were used for initializing that, but this also seems to be long gone.
cc @chrisdavidmills who knows about Web Audio.
|
@wbamberg so I could just remove the "Deprecated parameters' section. Like you said |
Yes, I think so! |
|
@wbamberg so could you please check the pull request I have made the changes |
wbamberg
approved these changes
Oct 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of Changes
AudioBufferdocumentation to remove deprecated parameters (channelCount,channelCountMode,channelInterpretation,context).Reason for Change
The deprecated parameters were causing confusion, and removing them helps to clarify the expected usage of the
AudioBufferconstructor.Related Issues
Motivation
The issue was put up by a reader knowledgeable about the topic, so I looked it up and fixed it.
Additional Details
current AudioBufferOptions: https://webaudio.github.io/web-audio-api/#AudioBufferOptions
current options(AudioBufferOptions) of AudioBuffer constructor in mdn web docs: https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer/AudioBuffer#options
Testing
Impact
These changes do not affect any existing functionality but clarify the documentation for future contributors.
Feedback Request
I’d appreciate any feedback on the clarity of the changes made to the documentation.