Fix #1299: add audio param tables#1359
Conversation
Adds a simple table to show explicitly the default, min, and max values of each AudioParam, including whether the param is a-rate or k-rate.
Replace the +/- infinity values with most-positive-single-float and most-negative-single-float and add dfn's for these so that the actual value is specified precisely.
|
PTAL. Don't think it's controversial; it just formalizes the default, min, and max values for each AudioParam in a readable table, and also adds a note on whether the parameter is a-rate or k-rate. Removes a bunch of text and makes it all uniform. |
|
2.17.1 Attributes These all still include the old description eg This parameter is a-rate when used with a PannerNode that has a panningModel set to "equalpower" , k-rate otherwise. Its nominal range is (−∞,∞). Same with I'm assuming this is unintentional duplication |
|
Thanks for catching those errors. I thought I had fixed them all. :-( |
These should all be in the table and not in a paragraph.
|
Looks good to me now @rtoy |
|
Thanks for the quick review @mdjp |
|
Changing to -FLT_MIN and FLT_MIN is a breaking change. It would. have been good to open an issue about it. I'm not opposed to it though, I think it makes more sense. |
|
Why is this a breaking change? Previously we said the nominal range was (-infinity, +infinity), so the limits aren't included. |
|
I see a couple with I found this because the Pretty minor though, and now that I think of it, it must have been a typo from one of use to have square brackets here. I'm uploading the patch to align with the spec (and Chrome) as we speak. I find uses on github though: https://github.com/craigharvi3/audibly/blob/9433b4e7c1bc9361aa46a9f14e03d657f47ca214/src/js/API/Audibly/Node/Source/AudiblyAudioBufferSourceNode.js#L49 |
|
Oops. Sorry about that. I think allowing infinity for the limit is a bad idea because it probably very quickly causes audio to be infinity or, more likely, NaN. Of course, FLT_MAX will also probably quickly produce that too, but that's a different issue. |
For each AudioParam, add a simple table giving the values that the AudioParam object would have by default. Also mention whether the param is a-rate or k-rate. While not necessary, I think it makes it easier to see what the AudioParam values should be and how the nominal range is really the min and max values of the parameter.
And this makes the description of the AudioParam consistent everywhere.
Preview | Diff