Home | History | Annotate | Download | only in mediastream
      1 /*
      2  * Copyright (C) 2012 Google Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions
      6  * are met:
      7  *
      8  * 1. Redistributions of source code must retain the above copyright
      9  *    notice, this list of conditions and the following disclaimer.
     10  * 2. Redistributions in binary form must reproduce the above copyright
     11  *    notice, this list of conditions and the following disclaimer
     12  *    in the documentation and/or other materials provided with the
     13  *    distribution.
     14  * 3. Neither the name of Google Inc. nor the names of its contributors
     15  *    may be used to endorse or promote products derived from this
     16  *    software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 [
     32     ActiveDOMObject,
     33     Constructor(Dictionary rtcIceServers, optional Dictionary mediaConstraints),
     34     ConstructorCallWith=ExecutionContext,
     35     NoInterfaceObject,
     36     RaisesException=Constructor,
     37 ] interface RTCPeerConnection : EventTarget {
     38     [RaisesException] void createOffer(RTCSessionDescriptionCallback successCallback, [Default=Undefined] optional RTCErrorCallback failureCallback, optional Dictionary mediaConstraints);
     39 
     40     [RaisesException] void createAnswer(RTCSessionDescriptionCallback successCallback, [Default=Undefined] optional RTCErrorCallback failureCallback, optional Dictionary mediaConstraints);
     41 
     42     [RaisesException] void setLocalDescription(RTCSessionDescription description, [Default=Undefined] optional VoidCallback successCallback, [Default=Undefined] optional RTCErrorCallback failureCallback);
     43     [RaisesException=Getter] readonly attribute RTCSessionDescription localDescription;
     44 
     45     [RaisesException] void setRemoteDescription(RTCSessionDescription description, [Default=Undefined] optional VoidCallback successCallback, [Default=Undefined] optional RTCErrorCallback failureCallback);
     46     [RaisesException=Getter] readonly attribute RTCSessionDescription remoteDescription;
     47 
     48     readonly attribute DOMString signalingState;
     49 
     50     [RaisesException] void updateIce(optional Dictionary configuration, optional Dictionary mediaConstraints);
     51 
     52     // DEPRECATED
     53     [RaisesException] void addIceCandidate(RTCIceCandidate candidate);
     54 
     55     [RaisesException] void addIceCandidate(RTCIceCandidate candidate, VoidCallback successCallback, RTCErrorCallback failureCallback);
     56 
     57     readonly attribute DOMString iceGatheringState;
     58     readonly attribute DOMString iceConnectionState;
     59 
     60     sequence<MediaStream> getLocalStreams();
     61     sequence<MediaStream> getRemoteStreams();
     62     MediaStream getStreamById(DOMString streamId);
     63 
     64     [StrictTypeChecking, RaisesException] void addStream(MediaStream stream, optional Dictionary mediaConstraints);
     65     [StrictTypeChecking, RaisesException] void removeStream(MediaStream stream);
     66 
     67     void getStats(RTCStatsCallback successCallback, [Default=Undefined] optional MediaStreamTrack selector);
     68 
     69     [RaisesException] RTCDataChannel createDataChannel([TreatNullAs=NullString, TreatUndefinedAs=NullString] DOMString label, optional Dictionary options);
     70 
     71     [RaisesException] RTCDTMFSender createDTMFSender(MediaStreamTrack track);
     72 
     73     [RaisesException] void close();
     74 
     75     attribute EventHandler onnegotiationneeded;
     76     attribute EventHandler onicecandidate;
     77     attribute EventHandler onsignalingstatechange;
     78     attribute EventHandler onaddstream;
     79     attribute EventHandler onremovestream;
     80     attribute EventHandler oniceconnectionstatechange;
     81     attribute EventHandler ondatachannel;
     82 };
     83 
     84