- From: CVS User abergkvi <cvsmail@w3.org>
- Date: Fri, 22 Feb 2013 13:37:09 +0000
- To: public-dap-commits@w3.org
Update of /sources/public/2011/webrtc/editor In directory roscoe:/tmp/cvs-serv23485 Modified Files: webrtc.html Log Message: Added 20130222 archived version. --- /sources/public/2011/webrtc/editor/webrtc.html 2013/01/16 15:16:24 1.31 +++ /sources/public/2011/webrtc/editor/webrtc.html 2013/02/22 13:37:09 1.32 @@ -8,12 +8,7 @@ <title>WebRTC 1.0: Real-time Communication Between Browsers</title> <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> <!-- - After making changes to this document in the github repo, run: - ./publish.sh webrtc.html - to publish a new editor's draft to the W3C CVS. This assumes your - CVS checkout is located at ../2011/webrtc, you can specify the location - as the second argument, for example: - ./publish.sh webrtc.html ~/path/to/w3/2011/webrtc + To publish this document, see instructions in README --> <script class="remove" src="http://www.w3.org/Tools/respec/respec-w3c-common" @@ -857,7 +852,7 @@ and the order does not have to stable between calls.</p> </dd> - <dt>MediaStream getStreamById(DOMString streamId)</dt> + <dt>MediaStream? getStreamById(DOMString streamId)</dt> <dd> <p>If a <code><a>MediaStream</a></code> object, with an <code> @@ -886,75 +881,6 @@ </div> </dd> - <dt>RTCDataChannel createDataChannel([TreatNullAs=EmptyString] - DOMString label, optional RTCDataChannelInit dataChannelDict)</dt> - - <dd> - <p>Creates a new <code><a>RTCDataChannel</a></code> object with the - given label. The <code><a>RTCDataChannelInit</a></code> dictionary - can be used to configure properties of the underlying channel such - as <!--priority and--> data reliability. A corresponding - <code><a>RTCDataChannel</a></code> object is dispatched at the - other peer if the channel setup was successful.</p> - - <p>When the <dfn id= - "dom-peerconnection-createdatachannel"><code>createDataChannel()</code></dfn> - method is invoked, the user agent MUST run the following steps.</p> - - <ol> - <li> - <p>If the <code><a>RTCPeerConnection</a></code> object’s - <a href= - "#dom-peerconnection-signaling-state"><code>RTCPeerConnection</code> - signalingState</a> is <code>closed</code>, throw an - <code>INVALID_STATE</code> exception.</p> - </li> - - <li> - <p>Let <var>channel</var> be a newly created - <code><a>RTCDataChannel</a></code> object.</p> - </li> - - <li> - <p>Initialize <var>channel</var>'s <code><a href= - "#dom-datachannel-label">label</a></code> attribute to the - value of the first argument.</p> - </li> - - <li> - <p>Initialize <var>channel</var>'s <code><a href= - "#dom-datachannel-reliable">reliable</a></code> attribute to - true.</p> - </li> - - <li> - <p>If the second argument is present and it contains a - <code><a href= - "#widl-RTCDataChannelInit-reliable">reliable</a></code> - dictionary member, then set <var>channel</var>'s <code><a href= - "#dom-rtcdatachannel-reliable">reliable</a></code> attribute to - the dictionary member value.</p> - </li> - - <li> - <p>Return <var>channel</var> and continue these steps in the - background.</p> - </li> - - <li> - <p>Create <var>channel</var>'s associated <a>underlying data - transport</a>.</p> - </li> - </ol> - </dd> - - <dt>attribute EventHandler ondatachannel</dt> - - <dd>This event handler, of type <code><a href= - "#event-peerconnection-datachannel">datachannel</a></code> , MUST be - supported by all objects implementing the - <code><a>RTCPeerConnection</a></code> interface.</dd> - <!-- <dt>void send (DOMString text)</dt> @@ -1116,158 +1042,6 @@ </ol> </dd> - <dt>RTCDTMFSender createDTMFSender (MediaStreamTrack track)</dt> - - <dd> - <p>The createDTMFSender() method creates an RTCDTMFSender that - references the given MediaStreamTrack. The - MediaStreamTrack MUST be an element of a MediaStream - that's currently in the <code><a>RTCPeerConnection</a></code> - object's <a href= "#local-streams-set">local streams set</a>; if - not, throw an exception with an <code>RTCError</code> object of type - <code>INVALID_MEDIASTREAMTRACK</code>.</p> - </dd> - - <dt>void setIdentityProvider(DOMString provider, optional DOMString - protocol, DOMString username)</dt> - - <dd> - <p>Sets the identity provider to be used for a given - <code>PeerConnection</code> object. Applications need not make this - call; if the browser is already configured for an IdP, then that - configured IdP will be used to get an assertion.</p> - - <p>When the <dfn id= - "dom-peerconnection-setidentityprovider"><code title= - "">setIdentityProvider()</code></dfn> method is invoked, the user - agent MUST run the following steps:</p> - - <ol> - <li> - <p>Set the current identity values to the triplet - (<code>provider</code>, <code>protocol</code>, - <code>username</code>).</p> - </li> - - <li> - <p>If the <code><a>RTCPeerConnection</a></code> object's - <a href= - "#peerconnection-signaling-state"><code>RTCPeerConnection</code> - signalingState</a> is <code>stable</code>, and any of - the identity settings have changed, queue a task to run the - following substeps:</p> - - <ol> - <li> - <p>If the <var>connection</var>'s <a href= - "#peerconnection-signaling-state"><code>RTCPeerConnection</code> - signalingState</a> is <code>closed</code>, abort these - steps, and throw an exception with an <code>RTCError</code> - object of type <code>INVALID_STATE</code>.</p> - </li> - - <li> - <p>Instantiate a new IdP proxy and request an identity - assertion.</p> - </li> - - <li> - <p>If/when the assertion is obtained, fire a <a href= - "#event-negotiation">negotiationneeded</a> event.</p> - </li> - </ol> - </li> - </ol> - </dd> - - <dt>void getIdentityAssertion()</dt> - - <dd> - <p>Initiates the process of obtaining an identity assertion. - Applications need not make this call. It is merely intended to - allow them to start the process of obtaining identity assertions - before a call is initiated. If an identity is needed, either - because the browser has been configured with a default identity - provider or because the <code>setIdentityProvider()</code> method - was called, then an identity will be automatically requested when - an offer or answer is created.</p> - - <p>Queue a task to run the following substeps.</p> - - <ol> - <li> - <p>If the <var>connection</var>'s <a href= - "#peerconnection-signaling-state"><code>RTCPeerConnection</code> - signalingState</a> is <code>closed</code>, abort these - steps.</p> - </li><!-- close() was probably called just before this - task ran --> - - <li> - <p>Instantiate a new IdP proxy and request an identity - assertion.</p> - </li> - </ol> - </dd> - - <dt>readonly attribute RTCIdentityAssertion? peerIdentity</dt> - - <dd> - <p>Contains the peer identity assertion information if an identity - assertion was provided and verified.</p> - </dd> - - <dt>void getStats(MediaStreamTrack? selector, RTCStatsCallback - successCallback, RTCPeerConnectionErrorCallback failureCallback)</dt> - - <dd> - <p>When the <dfn id="dom-peerconnection-getStats"><code title= - "">getStats()</code></dfn> method is invoked, the user agent MUST - queue a task to run the following substeps:</p> - - <ol> - <li> - <p>If the <code><a>RTCPeerConnection</a></code> object's - <a href= - "#dom-peerconnection-signaling-state"><code>RTCPeerConnection</code> - signalingState</a> is <code>closed</code>, throw an - <code>INVALID_STATE</code> exception.</p> - </li> - - <li> - <p>Gather the stats indicated by the selector. If the selector - is invalid, call the failureCallback.</p> - </li> - - <li> - <p>Call the successCallback, supplying the relevant statistics - object.</p> - </li> - </ol> - - <p>The "selector" may be a <code>MediaStreamTrack</code> that is a - member of a <code>MediaStream</code> on the incoming or outgoing - streams. The callback reports on all relevant statistics for that - selector. If the selector is blank or missing, stats for the whole - <code>RTCPeerConnection</code> are reported. TODO: Evaluate the - need for other selectors than MediaStreamTrack.</p> - - <p>The returned structure contains a list of - <code>RTCStatsElement</code>s, each reporting stats for one object - that the implementation thinks is relevant for the selector. One - achieves the total for the selector by summing over all the - elements; for instance, if a <code>MediaStreamTrack</code> is - carried by multiple SSRCs over the network, the - <code>getStats()</code> function may return one - <code>RTCStatsElement</code> per SSRC (which can be distinguished - by the value of the “ssrc” stats attribute).</p> - - <p>An <code>RTCPeerConnection</code> MUST return consistent stats - for each element in the array, adding new elements to the end as - needed; this is needed so that an application can simply correlate - a value read at one moment to a value read at a later moment.</p> - </dd> - <dt>void close ()</dt> <dd> @@ -1372,14 +1146,6 @@ "#event-icechange">icechange</a></code>, MUST be fired by all objects implementing the <code><a>RTCPeerConnection</a></code> interface. It is called any time the <var>iceConnectionState</var> changes.</dd> - - <dt>attribute EventHandler onidentityresult</dt> - - <dd>This event handler, of event handler event type <code><a href= - "#event-identityresult">identityresult</a></code>, MUST be fired by - all objects implementing the <code><a>RTCPeerConnection</a></code> - interface. It is called any time an identity verification succeeds or - fails.</dd> </dl> </section> @@ -1909,16 +1675,83 @@ <p>The Peer-to-peer Data API lets a web application send and receive generic application data peer-to-peer.</p> - <div class="issue" title="More Open Issues"> - <ul> - <li>Data channel setup signaling (signaling via SDP and application - specific signaling channel or first channel via SDP and consecutive - channels via internal signaling).</li> + <section> + <h3>RTCPeerConnection Interface Extensions</h3> - <li>What can be shared with the WebSocket API specification regarding - actual interfaces.</li> - </ul> - </div> + <p>The Peer-to-peer data API extends the + <code><a>RTCPeerConnection</a></code> interface as described below.</p> + + <dl class="idl" title="partial interface RTCPeerConnection"> + <dt>RTCDataChannel createDataChannel([TreatNullAs=EmptyString] + DOMString label, optional RTCDataChannelInit dataChannelDict)</dt> + + <dd> + <p>Creates a new <code><a>RTCDataChannel</a></code> object with the + given label. The <code><a>RTCDataChannelInit</a></code> dictionary + can be used to configure properties of the underlying channel such + as <!--priority and--> data reliability. A corresponding + <code><a>RTCDataChannel</a></code> object is dispatched at the + other peer if the channel setup was successful.</p> + + <p>When the <dfn id="dom-peerconnection-createdatachannel"> + <code>createDataChannel()</code></dfn> method is invoked, the user + agent MUST run the following steps.</p> + + <ol> + <li> + <p>If the <code><a>RTCPeerConnection</a></code> object’s + <a href= + "#dom-peerconnection-signaling-state"><code>RTCPeerConnection</code> + signalingState</a> is <code>closed</code>, throw an + <code>INVALID_STATE</code> exception.</p> + </li> + + <li> + <p>Let <var>channel</var> be a newly created + <code><a>RTCDataChannel</a></code> object.</p> + </li> + + <li> + <p>Initialize <var>channel</var>'s <code><a href= + "#dom-datachannel-label">label</a></code> attribute to the + value of the first argument.</p> + </li> + + <li> + <p>Initialize <var>channel</var>'s <code><a href= + "#dom-datachannel-reliable">reliable</a></code> attribute to + true.</p> + </li> + + <li> + <p>If the second argument is present and it contains a + <code><a href= + "#widl-RTCDataChannelInit-reliable">reliable</a></code> + dictionary member, then set <var>channel</var>'s <code><a href= + "#dom-rtcdatachannel-reliable">reliable</a></code> attribute to + the dictionary member value.</p> + </li> + + <li> + <p>Return <var>channel</var> and continue these steps in the + background.</p> + </li> + + <li> + <p>Create <var>channel</var>'s associated <a>underlying data + transport</a>.</p> + </li> + </ol> + </dd> + + <dt>attribute EventHandler ondatachannel</dt> + + <dd>This event handler, of type <code><a href= + "#event-peerconnection-datachannel">datachannel</a></code> , MUST be + supported by all objects implementing the + <code><a>RTCPeerConnection</a></code> interface.</dd> + </dl> + </section> <section> <h3>RTCDataChannel</h3> @@ -2491,6 +2324,27 @@ <p>In order to send DTMF (phone keypad) values across an <code><a>RTCPeerConnection</a></code>, the user agent needs to know which <code><a>MediaStreamTrack</a></code> on which <code><a>RTCPeerConnection</a></code> will carry the DTMF. This section describes an interface on <code><a>RTCPeerConnection</a></code> to associate DTMF capability with a <code><a>MediaStreamTrack</a></code> for that <code><a>RTCPeerConnection</a></code>.</p> + <section> + <h3>RTCPeerConnection Interface Extensions</h3> + + <p>The Peer-to-peer DTMF API extends the + <code><a>RTCPeerConnection</a></code> interface as described below.</p> + + <dl class="idl" title="partial interface RTCPeerConnection"> + <dt>RTCDTMFSender createDTMFSender (MediaStreamTrack track)</dt> + + <dd> + <p>The createDTMFSender() method creates an RTCDTMFSender that + references the given MediaStreamTrack. The + MediaStreamTrack MUST be an element of a MediaStream + that's currently in the <code><a>RTCPeerConnection</a></code> + object's <a href= "#local-streams-set">local streams set</a>; if + not, throw an exception with an <code>RTCError</code> object of type + <code>INVALID_MEDIASTREAMTRACK</code>.</p> + </dd> + </dl> + </section> + <section> <h4>RTCDTMFSender</h4> @@ -2537,34 +2391,32 @@ <ol> <li>If the associated <code>MediaStreamTrack</code> is not connected to the associated <code><a>RTCPeerConnection</a></code>, return.</li> [570 lines skipped]
Received on Friday, 22 February 2013 13:37:12 UTC