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     WillBeGarbageCollected,
     33     ActiveDOMObject,
     34     Constructor(Dictionary rtcIceServers, optional Dictionary mediaConstraints),
     35     ConstructorCallWith=ExecutionContext,
     36     NoInterfaceObject,
     37     RaisesException=Constructor,
     38 ] interface RTCPeerConnection : EventTarget {
     39     [RaisesException] void createOffer(RTCSessionDescriptionCallback successCallback, [Default=Undefined] optional RTCErrorCallback failureCallback, optional Dictionary mediaConstraints);
     40 
     41     [RaisesException] void createAnswer(RTCSessionDescriptionCallback successCallback, [Default=Undefined] optional RTCErrorCallback failureCallback, optional Dictionary mediaConstraints);
     42 
     43     [RaisesException] void setLocalDescription(RTCSessionDescription description, [Default=Undefined] optional VoidCallback successCallback, [Default=Undefined] optional RTCErrorCallback failureCallback);
     44     [RaisesException=Getter] readonly attribute RTCSessionDescription localDescription;
     45 
     46     [RaisesException] void setRemoteDescription(RTCSessionDescription description, [Default=Undefined] optional VoidCallback successCallback, [Default=Undefined] optional RTCErrorCallback failureCallback);
     47     [RaisesException=Getter] readonly attribute RTCSessionDescription remoteDescription;
     48 
     49     readonly attribute DOMString signalingState;
     50 
     51     [RaisesException] void updateIce(optional Dictionary configuration, optional Dictionary mediaConstraints);
     52 
     53     // DEPRECATED
     54     [RaisesException] void addIceCandidate(RTCIceCandidate candidate);
     55 
     56     [RaisesException] void addIceCandidate(RTCIceCandidate candidate, VoidCallback successCallback, RTCErrorCallback failureCallback);
     57 
     58     readonly attribute DOMString iceGatheringState;
     59     readonly attribute DOMString iceConnectionState;
     60 
     61     sequence<MediaStream> getLocalStreams();
     62     sequence<MediaStream> getRemoteStreams();
     63     MediaStream getStreamById(DOMString streamId);
     64 
     65     [TypeChecking=Interface|Nullable, RaisesException] void addStream(MediaStream? stream, optional Dictionary mediaConstraints);
     66     [TypeChecking=Interface|Nullable, RaisesException] void removeStream(MediaStream? stream);
     67 
     68     void getStats(RTCStatsCallback successCallback, [Default=Undefined] optional MediaStreamTrack selector);
     69 
     70     [RaisesException] RTCDataChannel createDataChannel([TreatNullAs=NullString, TreatUndefinedAs=NullString] DOMString label, optional Dictionary options);
     71 
     72     [RaisesException] RTCDTMFSender createDTMFSender(MediaStreamTrack track);
     73 
     74     [RaisesException] void close();
     75 
     76     attribute EventHandler onnegotiationneeded;
     77     attribute EventHandler onicecandidate;
     78     attribute EventHandler onsignalingstatechange;
     79     attribute EventHandler onaddstream;
     80     attribute EventHandler onremovestream;
     81     attribute EventHandler oniceconnectionstatechange;
     82     attribute EventHandler ondatachannel;
     83 };
     84