Bug 19900: Clarify the default values for the AudioParam attributes of BiquadFilterNode
authorcrogers
Tue, 13 Nov 2012 13:35:21 -0800
changeset 207 8401cc23e747
parent 206 ec9cc6af6ece
child 208 c330e53a8529
Bug 19900: Clarify the default values for the AudioParam attributes of BiquadFilterNode
webaudio/specification.html
--- a/webaudio/specification.html	Tue Nov 13 13:06:38 2012 -0800
+++ b/webaudio/specification.html	Tue Nov 13 13:35:21 2012 -0800
@@ -3044,9 +3044,23 @@
 Robert Bristow-Johnson.</p>
 
 <p>
-All parameters are <em>k-rate</em>
+All parameters are <em>k-rate</em> with the following default parameter values:
 </p>
 
+<blockquote>
+<dl>
+  <dt>frequency</dt>
+    <dd>350Hz, with a nominal range of 10 to the Nyquist frequency (half the sample-rate).
+    </dd>
+  <dt><a href="http://en.wikipedia.org/wiki/Q_factor">Q</a></dt>
+    <dd>1, with a nominal range of 0.0001 to 1000.</dd>
+  <dt>gain</dt>
+    <dd>0, with a nominal range of -40 to 40.</dd>
+</dl>
+</blockquote>
+
+
+
 <div id="BiquadFilterNode-description-section" class="section">
 <h3 id="BiquadFilterNode-description">4.21.1 LOWPASS</h3>
 
@@ -3058,10 +3072,11 @@
 <blockquote>
   <dl>
     <dt>frequency</dt>
-      <dd>The cutoff frequency above which the frequencies are attenuated</dd>
-    <dt><a href="http://en.wikipedia.org/wiki/Q_factor">Q</a></dt>
+      <dd>The cutoff frequency</dd>
+    <dt>Q</dt>
       <dd>Controls how peaked the response will be at the cutoff frequency. A
-        large value makes the response more peaked.</dd>
+        large value makes the response more peaked.  Please note that for the LOWPASS type, this
+        value is not a traditional Q, but is a resonance value in decibels.</dd>
     <dt>gain</dt>
       <dd>Not used in this filter type</dd>
   </dl>
@@ -3079,9 +3094,10 @@
   <dl>
     <dt>frequency</dt>
       <dd>The cutoff frequency below which the frequencies are attenuated</dd>
-    <dt><a href="http://en.wikipedia.org/wiki/Q_factor">Q</a></dt>
+    <dt>Q</dt>
       <dd>Controls how peaked the response will be at the cutoff frequency. A
-        large value makes the response more peaked.</dd>
+        large value makes the response more peaked. Please note that for the HIGHPASS type, this
+        value is not a traditional Q, but is a resonance value in decibels.</dd>
     <dt>gain</dt>
       <dd>Not used in this filter type</dd>
   </dl>