2e319c05ac2762929dd5fa05eee5d2036f5df27f
[WebKit-https.git] / Source / WebCore / Modules / mediastream / RTCPeerConnection.idl
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     Conditional=MEDIA_STREAM,
33     ActiveDOMObject,
34     Constructor(Dictionary rtcIceServers, optional Dictionary mediaConstraints),
35     ConstructorRaisesException,
36     CallWith=ScriptExecutionContext,
37     EventTarget,
38     InterfaceName=webkitRTCPeerConnection
39 ] interface RTCPeerConnection {
40     void createOffer(RTCSessionDescriptionCallback successCallback, [Default=Undefined] optional RTCErrorCallback failureCallback, optional Dictionary mediaConstraints)
41         raises(DOMException);
42
43     void createAnswer(RTCSessionDescriptionCallback successCallback, [Default=Undefined] optional RTCErrorCallback failureCallback, optional Dictionary mediaConstraints)
44         raises(DOMException);
45
46     void setLocalDescription(RTCSessionDescription description, [Default=Undefined] optional VoidCallback successCallback, [Default=Undefined] optional RTCErrorCallback failureCallback)
47         raises(DOMException);
48     readonly attribute RTCSessionDescription localDescription
49         getter raises(DOMException);
50
51     void setRemoteDescription(RTCSessionDescription description, [Default=Undefined] optional VoidCallback successCallback, [Default=Undefined] optional RTCErrorCallback failureCallback)
52         raises(DOMException);
53     readonly attribute RTCSessionDescription remoteDescription
54         getter raises(DOMException);
55
56     readonly attribute DOMString signalingState;
57
58     void updateIce(optional Dictionary configuration, optional Dictionary mediaConstraints)
59         raises(DOMException);
60
61     void addIceCandidate(RTCIceCandidate candidate)
62         raises(DOMException);
63
64     readonly attribute DOMString iceGatheringState;
65     readonly attribute DOMString iceConnectionState;
66
67     sequence<MediaStream> getLocalStreams();
68     sequence<MediaStream> getRemoteStreams();
69     MediaStream getStreamById(DOMString streamId);
70
71     [StrictTypeChecking] void addStream(MediaStream stream, optional Dictionary mediaConstraints)
72         raises(DOMException);
73     [StrictTypeChecking] void removeStream(MediaStream stream)
74         raises(DOMException);
75
76     void getStats(RTCStatsCallback successCallback, [Default=Undefined] optional MediaStreamTrack selector);
77
78     RTCDataChannel createDataChannel([TreatNullAs=NullString, TreatUndefinedAs=NullString] DOMString label, optional Dictionary options)
79          raises(DOMException);
80
81     RTCDTMFSender createDTMFSender(MediaStreamTrack track)
82          raises(DOMException);
83
84     void close()
85         raises(DOMException);
86
87     attribute EventListener onnegotiationneeded;
88     attribute EventListener onicecandidate;
89     attribute EventListener onsignalingstatechange;
90     attribute EventListener onaddstream;
91     attribute EventListener onremovestream;
92     attribute EventListener oniceconnectionstatechange;
93     attribute EventListener ondatachannel;
94
95     // EventTarget interface
96     void addEventListener(DOMString type,
97                           EventListener listener,
98                           optional boolean useCapture);
99     void removeEventListener(DOMString type,
100                              EventListener listener,
101                              optional boolean useCapture);
102     boolean dispatchEvent(Event event)
103         raises(EventException);
104 };
105