mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-31 06:05:44 +00:00
3544a8c613
--HG-- extra : transplant_source : %D9Y%3EecN%F2AJ%01%0A%D6%188.p%11%9C%29%C9
180 lines
6.9 KiB
Plaintext
180 lines
6.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 (DOMError error);
|
|
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
|
|
};
|
|
|
|
dictionary RTCOfferAnswerOptions {
|
|
// boolean voiceActivityDetection = true; // TODO: support this (Bug 1184712)
|
|
};
|
|
|
|
dictionary RTCAnswerOptions : RTCOfferAnswerOptions {
|
|
};
|
|
|
|
dictionary RTCOfferOptions : RTCOfferAnswerOptions {
|
|
long offerToReceiveVideo;
|
|
long offerToReceiveAudio;
|
|
boolean mozDontOfferDataChannel;
|
|
boolean mozBundleOnly;
|
|
|
|
// TODO: Remove old constraint-like RTCOptions support soon (Bug 1064223).
|
|
DeprecatedRTCOfferOptionsSet mandatory;
|
|
sequence<DeprecatedRTCOfferOptionsSet> _optional;
|
|
};
|
|
|
|
dictionary DeprecatedRTCOfferOptionsSet {
|
|
boolean OfferToReceiveAudio; // Note the uppercase 'O'
|
|
boolean OfferToReceiveVideo; // Note the uppercase 'O'
|
|
boolean MozDontOfferDataChannel; // Note the uppercase 'M'
|
|
boolean MozBundleOnly; // Note the uppercase 'M'
|
|
};
|
|
|
|
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 {
|
|
[Throws, StaticClassOverride="mozilla::dom::RTCCertificate"]
|
|
static Promise<RTCCertificate> generateCertificate (AlgorithmIdentifier keygenAlgorithm);
|
|
|
|
[Pref="media.peerconnection.identity.enabled"]
|
|
void setIdentityProvider (DOMString provider,
|
|
optional DOMString protocol,
|
|
optional DOMString username);
|
|
[Pref="media.peerconnection.identity.enabled"]
|
|
Promise<DOMString> getIdentityAssertion();
|
|
Promise<mozRTCSessionDescription> createOffer (optional RTCOfferOptions options);
|
|
Promise<mozRTCSessionDescription> createAnswer (optional RTCAnswerOptions options);
|
|
Promise<void> setLocalDescription (mozRTCSessionDescription description);
|
|
Promise<void> setRemoteDescription (mozRTCSessionDescription description);
|
|
readonly attribute mozRTCSessionDescription? localDescription;
|
|
readonly attribute mozRTCSessionDescription? remoteDescription;
|
|
readonly attribute RTCSignalingState signalingState;
|
|
void updateIce (optional RTCConfiguration configuration);
|
|
Promise<void> addIceCandidate (mozRTCIceCandidate candidate);
|
|
readonly attribute RTCIceGatheringState iceGatheringState;
|
|
readonly attribute RTCIceConnectionState iceConnectionState;
|
|
[Pref="media.peerconnection.identity.enabled"]
|
|
readonly attribute Promise<RTCIdentityAssertion> peerIdentity;
|
|
[Pref="media.peerconnection.identity.enabled"]
|
|
readonly attribute DOMString? idpLoginUrl;
|
|
|
|
[ChromeOnly]
|
|
attribute DOMString id;
|
|
|
|
RTCConfiguration getConfiguration ();
|
|
[UnsafeInPrerendering]
|
|
sequence<MediaStream> getLocalStreams ();
|
|
[UnsafeInPrerendering]
|
|
sequence<MediaStream> getRemoteStreams ();
|
|
[UnsafeInPrerendering]
|
|
MediaStream? getStreamById (DOMString streamId);
|
|
void addStream (MediaStream stream);
|
|
void removeStream (MediaStream stream);
|
|
|
|
// replaces addStream; fails if already added
|
|
// because a track can be part of multiple streams, stream parameters
|
|
// indicate which particular streams should be referenced in signaling
|
|
|
|
RTCRtpSender addTrack(MediaStreamTrack track,
|
|
MediaStream stream,
|
|
MediaStream... moreStreams);
|
|
void removeTrack(RTCRtpSender sender);
|
|
|
|
sequence<RTCRtpSender> getSenders();
|
|
sequence<RTCRtpReceiver> getReceivers();
|
|
|
|
void close ();
|
|
attribute EventHandler onnegotiationneeded;
|
|
attribute EventHandler onicecandidate;
|
|
attribute EventHandler onsignalingstatechange;
|
|
attribute EventHandler onaddstream;
|
|
attribute EventHandler onaddtrack; // replaces onaddstream; see AddTrackEvent
|
|
attribute EventHandler onremovestream;
|
|
attribute EventHandler oniceconnectionstatechange;
|
|
|
|
Promise<RTCStatsReport> getStats (optional MediaStreamTrack? selector);
|
|
|
|
// Data channel.
|
|
RTCDataChannel createDataChannel (DOMString label,
|
|
optional RTCDataChannelInit dataChannelDict);
|
|
attribute EventHandler ondatachannel;
|
|
};
|
|
|
|
// Legacy callback API
|
|
|
|
partial interface mozRTCPeerConnection {
|
|
|
|
// Dummy Promise<void> return values avoid "WebIDL.WebIDLError: error:
|
|
// We have overloads with both Promise and non-Promise return types"
|
|
|
|
Promise<void> createOffer (RTCSessionDescriptionCallback successCallback,
|
|
RTCPeerConnectionErrorCallback failureCallback,
|
|
optional RTCOfferOptions options);
|
|
Promise<void> createAnswer (RTCSessionDescriptionCallback successCallback,
|
|
RTCPeerConnectionErrorCallback failureCallback);
|
|
Promise<void> setLocalDescription (mozRTCSessionDescription description,
|
|
VoidFunction successCallback,
|
|
RTCPeerConnectionErrorCallback failureCallback);
|
|
Promise<void> setRemoteDescription (mozRTCSessionDescription description,
|
|
VoidFunction successCallback,
|
|
RTCPeerConnectionErrorCallback failureCallback);
|
|
Promise<void> addIceCandidate (mozRTCIceCandidate candidate,
|
|
VoidFunction successCallback,
|
|
RTCPeerConnectionErrorCallback failureCallback);
|
|
Promise<void> getStats (MediaStreamTrack? selector,
|
|
RTCStatsCallback successCallback,
|
|
RTCPeerConnectionErrorCallback failureCallback);
|
|
};
|