Merge pull request #509 from openpeer/issue497-patch

Robin Raymond · Robin Raymond · commit 3d2d4269f83e · 2016-04-25T16:49:27.000-04:00
getCapabilities and feature codec "kind"
diff --git a/ortc.html b/ortc.html
@@ -1884,14 +1884,13 @@ <h3>Interface Definition</h3>
                             </li>
                         </ol>
                     </dd>
-                    <dt>static RTCRtpCapabilities getCapabilities(optional DOMString kind)</dt>
+                    <dt>static RTCRtpCapabilities getCapabilities(DOMString kind)</dt>
                     <dd>
                         <p>
-                            Obtain the sender capabilities, based on <var>kind</var>. If <var>kind</var> is
-                            omitted or is set to "", then all capabilities are returned.
-                            Capabilities such as retransmission [[!RFC4588]], redundancy [[RFC2198]], and
-                            Forward Error Correction that do not have an associated value of <var>kind</var> are always
-                            included, regardless of the value of <var>kind</var> passed to <code>getCapabilities()</code>.
+                            Obtain the sender capabilities, based on <var>kind</var>. Capabilities that can apply to multiple
+                            values of <var>kind</var> (such as retransmission [[!RFC4588]], redundancy [[RFC2198]] and
+                            Forward Error Correction) have <var>RTCRtpCapabilities.RTCRtpCodecCapability[i].kind</var
+                            set to the value of the <var>kind</var> argument.
                         </p>
                     </dd>
                     <dt>void send(RTCRtpParameters parameters)</dt>
@@ -2059,21 +2058,13 @@ <h3>Interface Definition</h3>
                             throw an <code>InvalidParameters</code> exception.
                         </p>
                     </dd>
-                    <dt>static RTCRtpCapabilities getCapabilities(optional DOMString kind)</dt>
+                    <dt>static RTCRtpCapabilities getCapabilities(DOMString kind)</dt>
                     <dd>
                         <p>
-                            Obtain the receiver capabilities, based on <var>kind</var>. If <var>kind</var> is omitted or set to "", then
-                            all capabilities are returned.
-                            Capabilities such as retransmission [[!RFC4588]], redundancy [[RFC2198]], and
-                            Forward Error Correction that do not have an associated value of <var>kind</var> are always
-                            included, regardless of the value of <var>kind</var> passed to <code>getCapabilities()</code>.
-                            To avoid confusion, <code>getCapabilities(kind)</code> should return codecs with a matching intrinsic <var>kind</var> value,
-                            as well as codecs with no intrinsic <var>kind</var>
-                            (such as redundancy [[RFC2198]]).
-                            For codecs with no intrinsic <var>kind</var>, <var>RTCRtpCapabilities.RTCRtpCodecCapability[i].kind</var>
-                            returned by <code>getCapabilities(kind)</code> should be set to the value of <var>kind</var> if <var>kind</var> is
-                            equal to "audio" or "video". If the <var>kind</var> argument was omitted or set to "", then
-                            the value of <var>RTCRtpCapabilities.RTCRtpCodecCapability[i].kind</var> is set to "".
+                            Obtain the receiver capabilities, based on <var>kind</var>. Capabilities that can apply to multiple
+                            values of <var>kind</var> (such as retransmission [[!RFC4588]], redundancy [[RFC2198]] and
+                            Forward Error Correction) have <var>RTCRtpCapabilities.RTCRtpCodecCapability[i].kind</var
+                            set to the value of the <var>kind</var> argument.
                         </p>
                     </dd>
                     <dt>void receive(RTCRtpParameters parameters)</dt>
