Specify getFloatTimeDomainData() encoding range #40544
Conversation
github-actions
bot
added
Content:WebAPI
| @@ -10,6 +10,8 @@ browser-compat: api.AnalyserNode.getFloatTimeDomainData | |||
|
|
|||
| The **`getFloatTimeDomainData()`** method of the {{ domxref("AnalyserNode") }} Interface copies the current waveform, or time-domain, data into a {{jsxref("Float32Array")}} array passed into it. Each array value is a _sample_, the magnitude of the signal at a particular time. | |||
|
|
|||
| The waveform is encoded as PCM data, which has a nominal range of -1.0 to 1.0, but values can exceed the range such as when down-mixing stereo to mono. | |||
There was a problem hiding this comment.
It's a bit of a duplicate of the paragraph above, that says it's a copy of the waveform data. But I looked elsewhere on MDN, and I think we should say that waveform data are nominally in [-1, 1] at least once, e.g. in https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Basic_concepts_behind_Web_Audio_API in which we say it's float 32-bits.
encoded might be a bit strange because the data is copied unaltered (which is important).
There was a problem hiding this comment.
Re: duplication, "A sample, the magnitude of the signal" sounds a bit less straightforward than "PCM data" to me as an amateur. The guide page you linked doesn't really talk about the data encoding at all, so I think this looks like the best place to put it. Would "represented" be a better word?
Fix #25571. Wondering if you could advise @padenot—thanks!