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

Incorrect description of function output for getFloatFrequencyData() #36071

Closed
gabriel-bric-yud opened this issue Sep 27, 2024 · 1 comment · Fixed by #36164
Closed

Incorrect description of function output for getFloatFrequencyData() #36071

gabriel-bric-yud opened this issue Sep 27, 2024 · 1 comment · Fixed by #36164
Labels
area: Web Audio Content:WebAPI Web API docs help wanted If you know something about this topic, we would love your help!

Comments

@gabriel-bric-yud
Copy link

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getFloatFrequencyData

What specific section or headline is this issue about?

In the initial description

What information was incorrect, unhelpful, or incomplete?

"Each array value is a sample, the magnitude of the signal at a particular time."

What did you expect to see?

This is incorrect, as each array value is not a sample but the amplitude of a specific frequency component of the audio signal at that moment as directed by the fftSize. This is stated correctly in the next line: "Each item in the array represents the decibel value for a specific frequency."

Do you have any supporting links, references, or citations?

This next line of the article states: "Each item in the array represents the decibel value for a specific frequency." So that is one of my sources.

Do you have anything more you want to share?

Seems like it was copy and pasted sentence from getFloatTimeDomainData() article. It doesn't hold true for this function.

MDN metadata

Page report details
@gabriel-bric-yud gabriel-bric-yud added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Sep 27, 2024
@github-actions github-actions bot added the Content:WebAPI Web API docs label Sep 27, 2024
@Josh-Cena
Copy link
Member

This was changed in #25878. Welcoming fixes.

@Josh-Cena Josh-Cena added help wanted If you know something about this topic, we would love your help! area: Web Audio and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Web Audio Content:WebAPI Web API docs help wanted If you know something about this topic, we would love your help!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants