* Cleanup AudioNode connect() and disconnect() method descriptions.
authorcrogers
Fri, 13 Apr 2012 16:32:42 -0700
changeset 41 7011f54ec0db
parent 40 38fc7dcef032
child 42 e2e433d4ecc0
* Cleanup AudioNode connect() and disconnect() method descriptions.
* Add AudioNode connect() to AudioParam method.
webaudio/specification.html
--- a/webaudio/specification.html	Fri Apr 13 16:16:57 2012 -0700
+++ b/webaudio/specification.html	Fri Apr 13 16:32:42 2012 -0700
@@ -1022,8 +1022,15 @@
 
     interface <dfn id="dfn-AudioNode">AudioNode</dfn> {
 
-        void connect(in AudioNode destination, in unsigned long output = 0, in unsigned long input = 0);
-        void disconnect(in int output = 0);
+        void connect(in AudioNode destination, in [Optional] unsigned long output = 0, in [Optional] unsigned long input = 0)
+            raises(DOMException);
+
+        void connect(in AudioParam destination, in [Optional] unsigned long output = 0)
+            raises(DOMException);
+
+        void disconnect(in [Optional] unsigned long output = 0)
+            raises(DOMException);
+
         readonly attribute AudioContext context;
         readonly attribute unsigned long numberOfInputs;
         readonly attribute unsigned long numberOfOutputs;
@@ -1057,7 +1064,7 @@
 <div id="methodsandparams-AudioNode-section" class="section">
 <h3 id="methodsandparams-AudioNode">4.2.2. Methods and Parameters</h3>
 <dl>
-  <dt id="dfn-connect">The <code>connect</code> method</dt>
+  <dt id="dfn-connect">The <code>connect</code> to AudioNode method</dt>
     <dd><p>Connects the AudioNode to another AudioNode.</p>
       <p>The <dfn id="dfn-destination_2">destination</dfn> parameter is the
       AudioNode to connect to.</p>
@@ -1072,10 +1079,24 @@
     </dd>
 </dl>
 <dl>
+  <dt id="dfn-connect">The <code>connect</code> to AudioParam method</dt>
+    <dd><p>Connects the AudioNode to an AudioParam, controlling the parameter
+      value with an audio-rate signal.</p>
+      <p>The <dfn id="dfn-destination_3">destination</dfn> parameter is the
+      AudioParam to connect to.</p>
+      <p>The <dfn id="dfn-output_3">output</dfn> parameter is an index
+      describing which output of the AudioNode from which to connect. An
+      out-of-bound value throws an exception.</p>
+      <p>It is possible to connect an AudioNode output to more than one AudioParam
+      with multiple calls to connect(). Thus, "fanout" is supported. </p>
+    </dd>
+</dl>
+<dl>
   <dt id="dfn-disconnect">The <code>disconnect</code> method</dt>
     <dd><p>Disconnects an AudioNode's output.</p>
       <p>The <dfn id="dfn-output_3">output</dfn> parameter is an index
-      describing which output of the AudioNode to disconnect. </p>
+      describing which output of the AudioNode to disconnect.  An out-of-bound
+      value throws an exception.</p>
     </dd>
 </dl>
 </div>
@@ -3826,6 +3847,10 @@
 <pre>
 
 date:        Tue Apr 13 2012
+* Cleanup AudioNode connect() and disconnect() method descriptions.
+* Add AudioNode connect() to AudioParam method.
+
+date:        Tue Apr 13 2012
 * Add Oscillator and WaveTable
 * Define default values for optional arguments in createJavaScriptNode(), createChannelSplitter(), createChannelMerger()
 * Define default filter type for BiquadFilterNode as LOWPASS