mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-01 06:35:42 +00:00
157 lines
5.9 KiB
Plaintext
157 lines
5.9 KiB
Plaintext
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
* You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* The origin of this IDL file is
|
|
* http://dev.w3.org/2011/webrtc/editor/webrtc.html#idl-def-RTCPeerConnection
|
|
*/
|
|
|
|
callback RTCSessionDescriptionCallback = void (mozRTCSessionDescription sdp);
|
|
callback RTCPeerConnectionErrorCallback = void (DOMString errorInformation);
|
|
callback VoidFunction = void ();
|
|
callback RTCStatsCallback = void (RTCStatsReport report);
|
|
|
|
enum RTCSignalingState {
|
|
"stable",
|
|
"have-local-offer",
|
|
"have-remote-offer",
|
|
"have-local-pranswer",
|
|
"have-remote-pranswer",
|
|
"closed"
|
|
};
|
|
|
|
enum RTCIceGatheringState {
|
|
"new",
|
|
"gathering",
|
|
"complete"
|
|
};
|
|
|
|
enum RTCIceConnectionState {
|
|
"new",
|
|
"checking",
|
|
"connected",
|
|
"completed",
|
|
"failed",
|
|
"disconnected",
|
|
"closed"
|
|
};
|
|
|
|
dictionary RTCDataChannelInit {
|
|
boolean ordered = true;
|
|
unsigned short? maxRetransmitTime = null;
|
|
unsigned short? maxRetransmits = null;
|
|
DOMString protocol = "";
|
|
boolean negotiated = false; // spec currently says 'true'; we disagree
|
|
unsigned short? id = null;
|
|
|
|
// these are deprecated due to renaming in the spec, but still supported for Fx22
|
|
boolean outOfOrderAllowed; // now ordered, and the default changes to keep behavior the same
|
|
unsigned short maxRetransmitNum; // now maxRetransmits
|
|
boolean preset; // now negotiated
|
|
unsigned short stream; // now id
|
|
};
|
|
|
|
// Misnomer dictionaries housing PeerConnection-specific constraints.
|
|
//
|
|
// Important! Do not ever add members that might need tracing (e.g. object)
|
|
// to MediaConstraintSet or any dictionary marked XxxInternal here
|
|
|
|
dictionary MediaConstraintSet {
|
|
boolean OfferToReceiveAudio;
|
|
boolean OfferToReceiveVideo;
|
|
boolean MozDontOfferDataChannel;
|
|
boolean MozBundleOnly;
|
|
};
|
|
|
|
// MediaConstraint = single-property-subset of MediaConstraintSet
|
|
// Implemented as full set. Test Object.keys(pair).length == 1
|
|
|
|
// typedef MediaConstraintSet MediaConstraint; // TODO: Bug 913053
|
|
|
|
dictionary MediaConstraints {
|
|
object mandatory; // so we can see unknown + unsupported constraints
|
|
sequence<MediaConstraintSet> _optional; // a.k.a. MediaConstraint
|
|
};
|
|
|
|
dictionary MediaConstraintsInternal {
|
|
MediaConstraintSet mandatory; // holds only supported constraints
|
|
sequence<MediaConstraintSet> _optional; // a.k.a. MediaConstraint
|
|
};
|
|
|
|
interface RTCDataChannel;
|
|
|
|
[Pref="media.peerconnection.enabled",
|
|
JSImplementation="@mozilla.org/dom/peerconnection;1",
|
|
Constructor (optional RTCConfiguration configuration,
|
|
optional object? constraints)]
|
|
// moz-prefixed until sufficiently standardized.
|
|
interface mozRTCPeerConnection : EventTarget {
|
|
void createOffer (RTCSessionDescriptionCallback successCallback,
|
|
RTCPeerConnectionErrorCallback failureCallback,
|
|
optional MediaConstraints constraints);
|
|
void createAnswer (RTCSessionDescriptionCallback successCallback,
|
|
RTCPeerConnectionErrorCallback failureCallback,
|
|
optional MediaConstraints constraints);
|
|
void setLocalDescription (mozRTCSessionDescription description,
|
|
optional VoidFunction successCallback,
|
|
optional RTCPeerConnectionErrorCallback failureCallback);
|
|
void setRemoteDescription (mozRTCSessionDescription description,
|
|
optional VoidFunction successCallback,
|
|
optional RTCPeerConnectionErrorCallback failureCallback);
|
|
readonly attribute mozRTCSessionDescription? localDescription;
|
|
readonly attribute mozRTCSessionDescription? remoteDescription;
|
|
readonly attribute RTCSignalingState signalingState;
|
|
void updateIce (optional RTCConfiguration configuration,
|
|
optional MediaConstraints constraints);
|
|
void addIceCandidate (mozRTCIceCandidate candidate,
|
|
optional VoidFunction successCallback,
|
|
optional RTCPeerConnectionErrorCallback failureCallback);
|
|
readonly attribute RTCIceGatheringState iceGatheringState;
|
|
readonly attribute RTCIceConnectionState iceConnectionState;
|
|
sequence<MediaStream> getLocalStreams ();
|
|
sequence<MediaStream> getRemoteStreams ();
|
|
MediaStream? getStreamById (DOMString streamId);
|
|
void addStream (MediaStream stream, optional MediaConstraints constraints);
|
|
void removeStream (MediaStream stream);
|
|
void close ();
|
|
attribute EventHandler onnegotiationneeded;
|
|
attribute EventHandler onicecandidate;
|
|
attribute EventHandler onsignalingstatechange;
|
|
attribute EventHandler onaddstream;
|
|
attribute EventHandler onremovestream;
|
|
attribute EventHandler oniceconnectionstatechange;
|
|
|
|
void getStats (MediaStreamTrack? selector,
|
|
RTCStatsCallback successCallback,
|
|
RTCPeerConnectionErrorCallback failureCallback);
|
|
|
|
[ChromeOnly]
|
|
void getStatsInternal (MediaStreamTrack? selector,
|
|
RTCStatsCallback successCallback,
|
|
RTCPeerConnectionErrorCallback failureCallback);
|
|
|
|
// Data channel.
|
|
RTCDataChannel createDataChannel (DOMString label,
|
|
optional RTCDataChannelInit dataChannelDict);
|
|
attribute EventHandler ondatachannel;
|
|
attribute EventHandler onconnection;
|
|
attribute EventHandler onclosedconnection;
|
|
};
|
|
|
|
callback RTCLogCallback = void (sequence<DOMString> logMessages);
|
|
|
|
[JSImplementation="@mozilla.org/dom/webrtcglobalinformation;1",
|
|
ChromeOnly,
|
|
Constructor ()]
|
|
interface WebrtcGlobalInformation {
|
|
void getAllStats(RTCStatsCallback callback,
|
|
RTCPeerConnectionErrorCallback errorCallback);
|
|
void getCandPairLogs(DOMString candPairId,
|
|
RTCLogCallback callback,
|
|
RTCPeerConnectionErrorCallback errorCallback);
|
|
};
|
|
|
|
|
|
|