@types/webrtc

// W3 Spec: https://www.w3.org/TR/webrtc/ // // Note: Commented out definitions clash with definitions in lib.es6.d.ts. I // still kept them in here though, as sometimes they're more specific than the // ES6 library ones. /// <reference path='MediaStream.d.ts' /> // https://www.w3.org/TR/webrtc/#idl-def-rtcerror interface RTCError extends DOMException { readonly errorDetail: RTCErrorDetailType; readonly httpRequestStatusCode: number | null; readonly receivedAlert: number | null; readonly sctpCauseCode: number | null; readonly sdpLineNumber: number | null; readonly sentAlert: number | null; } // https://www.w3.org/TR/webrtc/#idl-def-rtcerrorinit interface RTCErrorInit { errorDetail: RTCErrorDetailType; httpRequestStatusCode?: number | undefined; receivedAlert?: number | undefined; sctpCauseCode?: number | undefined; sdpLineNumber?: number | undefined; sentAlert?: number | undefined; } declare var RTCError: { prototype: RTCError; new(init: RTCErrorInit, message?: string): RTCError; }; // https://www.w3.org/TR/webrtc/#idl-def-rtcerrorevent interface RTCErrorEvent extends Event { readonly error: RTCError; } // https://www.w3.org/TR/webrtc/#idl-def-rtcerroreventinit interface RTCErrorEventInit extends EventInit { error: RTCError; } declare var RTCErrorEvent: { prototype: RTCErrorEvent; new(type: string, eventInitDict: RTCErrorEventInit): RTCErrorEvent; }; // https://www.w3.org/TR/webrtc/#idl-def-rtcicecandidatepair interface RTCIceCandidatePair { local: RTCIceCandidate; remote: RTCIceCandidate; } // https://www.w3.org/TR/webrtc/#idl-def-rtcofferansweroptions interface RTCOfferAnswerOptions { voiceActivityDetection?: boolean | undefined; // default = true } // https://www.w3.org/TR/webrtc/#idl-def-rtcofferoptions interface RTCOfferOptions extends RTCOfferAnswerOptions { iceRestart?: boolean | undefined; // default = false } // https://www.w3.org/TR/webrtc/#idl-def-rtcansweroptions interface RTCAnswerOptions extends RTCOfferAnswerOptions { } // https://www.w3.org/TR/webrtc/#idl-def-rtciceserver interface RTCIceServer { credential?: string | undefined; urls: string | string[]; username?: string | undefined; } // https://www.w3.org/TR/webrtc/#idl-def-rtciceparameters interface RTCIceParameters { iceLite?: boolean | undefined; password?: string | undefined; usernameFragment?: string | undefined; } // https://www.w3.org/TR/webrtc/#idl-def-rtcicerole type RTCIceRole = "controlled" | "controlling" | "unknown"; interface RTCIceTransportEventMap { "gatheringstatechange": Event; "selectedcandidatepairchange": Event; "statechange": Event; } // https://www.w3.org/TR/webrtc/#idl-def-rtcicetransport type IceTransportEventHandler = ((this: RTCIceTransport, ev: Event) => any) | null; interface RTCIceTransport extends EventTarget { readonly role: RTCIceRole; // readonly component: RTCIceComponent; // readonly state: RTCIceTransportState; readonly gatheringState: RTCIceGatheringState; getLocalCandidates(): RTCIceCandidate[]; getRemoteCandidates(): RTCIceCandidate[]; getLocalParameters(): RTCIceParameters | null; getRemoteParameters(): RTCIceParameters | null; getSelectedCandidatePair(): RTCIceCandidatePair | null; onstatechange: IceTransportEventHandler; ongatheringstatechange: IceTransportEventHandler; onselectedcandidatepairchange: IceTransportEventHandler; addEventListener<K extends keyof RTCIceTransportEventMap>( type: K, listener: (this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any, options?: boolean | AddEventListenerOptions, ): void; addEventListener( type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions, ): void; removeEventListener<K extends keyof RTCIceTransportEventMap>( type: K, listener: (this: RTCIceTransport, ev: RTCIceTransportEventMap[K]) => any, options: boolean | EventListenerOptions, ): void; removeEventListener( type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions, ): void; } interface RTCDtlsTransportEventMap { "error": Event; "statechange": Event; } // https://www.w3.org/TR/webrtc/#idl-def-rtcdtlstransport type DtlsTransportEventHandler<E extends Event> = ((this: RTCDtlsTransport, ev: E) => any) | null; interface RTCDtlsTransport extends EventTarget { readonly iceTransport: RTCIceTransport; readonly state: RTCDtlsTransportState; getRemoteCertificates(): ArrayBuffer[]; onerror: DtlsTransportEventHandler<Event>; onstatechange: DtlsTransportEventHandler<Event>; addEventListener<K extends keyof RTCDtlsTransportEventMap>( type: K, listener: (this: RTCDtlsTransport, ev: RTCDtlsTransportEventMap[K]) => any, options?: boolean | AddEventListenerOptions, ): void; addEventListener( type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions, ): void; removeEventListener<K extends keyof RTCDtlsTransportEventMap>( type: K, listener: (this: RTCDtlsTransport, ev: RTCDtlsTransportEventMap[K]) => any, options?: boolean | EventListenerOptions, ): void; removeEventListener( type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions, ): void; } // https://www.w3.org/TR/webrtc/#idl-def-rtcrtpcodeccapability interface RTCRtpCodecCapability { mimeType: string; } // https://www.w3.org/TR/webrtc/#idl-def-rtcrtpheaderextensioncapability interface RTCRtpHeaderExtensionCapability { uri: string; } // https://www.w3.org/TR/webrtc/#idl-def-rtcrtpcapabilities interface RTCRtpCapabilities { // codecs: RTCRtpCodecCapability[]; // headerExtensions: RTCRtpHeaderExtensionCapability[]; } // https://www.w3.org/TR/webrtc/#idl-def-rtcrtprtxparameters interface RTCRtpRtxParameters { // ssrc: number; } // https://www.w3.org/TR/webrtc/#idl-def-rtcrtpfecparameters interface RTCRtpFecParameters { // ssrc: number; } // https://www.w3.org/TR/webrtc/#idl-def-rtcrtpencodingparameters interface RTCRtpEncodingParameters { // ssrc: number; // rtx: RTCRtpRtxParameters; // fec: RTCRtpFecParameters; // dtx?: RTCDtxStatus; // active: boolean; // priority: RTCPriorityType; // maxBitrate: number; rid: string; scaleResolutionDownBy?: number | undefined; // default = 1 } // https://www.w3.org/TR/webrtc/#idl-def-rtcrtpheaderextensionparameters interface RTCRtpHeaderExtensionParameters { // uri: string; // id: number; encrypted?: boolean | undefined; } // https://www.w3.org/TR/webrtc/#idl-def-rtcrtcpparameters interface RTCRtcpParameters { // cname: string; // reducedSize: boolean; } // https://www.w3.org/TR/webrtc/#idl-def-rtcrtpcodecparameters interface RTCRtpCodecParameters { // payloadType: number; mimeType: string; // clockRate: number; channels?: number | undefined; // default = 1 sdpFmtpLine?: string | undefined; } // https://www.w3.org/TR/webrtc/#idl-def-rtcrtpparameters interface RTCRtpParameters { transactionId: string; // encodings: RTCRtpEncodingParameters[]; // headerExtensions: RTCRtpHeaderExtensionParameters[]; // rtcp: RTCRtcpParameters; // codecs: RTCRtpCodecParameters[]; // degradationPreference?: RTCDegradationPreference; // default = 'balanced' } // https://www.w3.org/TR/webrtc/#dom-rtcrtpcontributingsource interface RTCRtpContributingSource { // readonly timestamp: number; source: number; // readonly audioLevel: number | null; readonly voiceActivityFlag?: boolean | undefined; } // https://www.w3.org/TR/webrtc/#dom-rtcrtpsender interface RTCRtpSender { // readonly track?: MediaStreamTrack; // readonly transport?: RTCDtlsTransport; // readonly rtcpTransport?: RTCDtlsTransport; setParameters(parameters?: RTCRtpParameters): Promise<void>; getParameters(): RTCRtpParameters; replaceTrack(withTrack: MediaStreamTrack): Promise<void>; } // https://www.w3.org/TR/webrtc/#idl-def-rtcrtpreceiver interface RTCRtpReceiver { // readonly track?: MediaStreamTrack; // readonly transport?: RTCDtlsTransport; // readonly rtcpTransport?: RTCDtlsTransport; getParameters(): RTCRtpParameters; getContributingSources(): RTCRtpContributingSource[]; } // https://www.w3.org/TR/webrtc/#idl-def-rtcrtptransceiver interface RTCRtpTransceiver { readonly mid: string | null; readonly sender: RTCRtpSender; readonly receiver: RTCRtpReceiver; readonly stopped: boolean; direction: RTCRtpTransceiverDirection; setDirection(direction: RTCRtpTransceiverDirection): void; stop(): void; setCodecPreferences(codecs: RTCRtpCodecCapability[]): void; } // https://www.w3.org/TR/webrtc/#idl-def-rtcrtptransceiverinit interface RTCRtpTransceiverInit { direction?: RTCRtpTransceiverDirection | undefined; // default = 'sendrecv' streams?: MediaStream[] | undefined; sendEncodings?: RTCRtpEncodingParameters[] | undefined; } // https://www.w3.org/TR/webrtc/#dom-rtccertificate interface RTCCertificate { readonly expires: number; getAlgorithm(): string; } // https://www.w3.org/TR/webrtc/#idl-def-rtcconfiguration interface RTCConfiguration { iceServers?: RTCIceServer[] | undefined; iceTransportPolicy?: RTCIceTransportPolicy | undefined; // default = 'all' bundlePolicy?: RTCBundlePolicy | undefined; // default = 'balanced' rtcpMuxPolicy?: RTCRtcpMuxPolicy | undefined; // default = 'require' peerIdentity?: string | undefined; // default = null certificates?: RTCCertificate[] | undefined; iceCandidatePoolSize?: number | undefined; // default = 0 } // Compatibility for older definitions on DefinitelyTyped. type RTCPeerConnectionConfig = RTCConfiguration; // https://www.w3.org/TR/webrtc/#idl-def-rtcsctptransport interface RTCSctpTransport { readonly transport: RTCDtlsTransport; readonly maxMessageSize: number; } // https://www.w3.org/TR/webrtc/#idl-def-rtcdatachannelinit interface RTCDataChannelInit { ordered?: boolean | undefined; // default = true maxPacketLifeTime?: number | undefined; maxRetransmits?: number | undefined; protocol?: string | undefined; // default = '' negotiated?: boolean | undefined; // default = false id?: number | undefined; } // https://www.w3.org/TR/webrtc/#idl-def-rtcdatachannel type DataChannelEventHandler<E extends Event> = ((this: RTCDataChannel, ev: E) => any) | null; interface RTCDataChannel extends EventTarget { readonly label: string; readonly ordered: boolean; readonly maxPacketLifeTime: number | null; readonly maxRetransmits: number | null; readonly protocol: string; readonly negotiated: boolean; readonly id: number | null; readonly readyState: RTCDataChannelState; readonly bufferedAmount: number; bufferedAmountLowThreshold: number; // binaryType: string; close(): void; send(data: string | Blob | ArrayBuffer | ArrayBufferView): void; onopen: DataChannelEventHandler<Event>; onmessage: DataChannelEventHandler<MessageEvent>; onbufferedamountlow: DataChannelEventHandler<Event>; // onerror: DataChannelEventHandler<RTCErrorEvent>; onclose: DataChannelEventHandler<Event>; } // https://www.w3.org/TR/webrtc/#h-rtctrackevent interface RTCTrackEvent extends Event { readonly receiver: RTCRtpReceiver; readonly track: MediaStreamTrack; readonly streams: readonly MediaStream[]; readonly transceiver: RTCRtpTransceiver; } // https://www.w3.org/TR/webrtc/#h-rtcpeerconnectioniceevent interface RTCPeerConnectionIceEvent extends Event { readonly url: string | null; } // https://www.w3.org/TR/webrtc/#h-rtcpeerconnectioniceerrorevent interface RTCPeerConnectionIceErrorEvent extends Event { readonly hostCandidate: string; readonly url: string; readonly errorCode: number; readonly errorText: string; } // https://www.w3.org/TR/webrtc/#h-rtcdatachannelevent interface RTCDataChannelEvent { readonly channel: RTCDataChannel; } // https://www.w3.org/TR/webrtc/#idl-def-rtcpeerconnection type PeerConnectionEventHandler<E extends Event> = ((this: RTCPeerConnection, ev: E) => any) | null; interface RTCPeerConnection extends EventTarget { createOffer(options?: RTCOfferOptions): Promise<RTCSessionDescriptionInit>; createAnswer(options?: RTCAnswerOptions): Promise<RTCSessionDescriptionInit>; setLocalDescription(description: RTCSessionDescriptionInit): Promise<void>; readonly localDescription: RTCSessionDescription | null; readonly currentLocalDescription: RTCSessionDescription | null; readonly pendingLocalDescription: RTCSessionDescription | null; setRemoteDescription(description: RTCSessionDescriptionInit): Promise<void>; readonly remoteDescription: RTCSessionDescription | null; readonly currentRemoteDescription: RTCSessionDescription | null; readonly pendingRemoteDescription: RTCSessionDescription | null; addIceCandidate(candidate?: RTCIceCandidateInit | RTCIceCandidate): Promise<void>; readonly signalingState: RTCSignalingState; readonly connectionState: RTCPeerConnectionState; getConfiguration(): RTCConfiguration; setConfiguration(configuration: RTCConfiguration): void; close(): void; onicecandidateerror: PeerConnectionEventHandler<RTCPeerConnectionIceErrorEvent>; onconnectionstatechange: PeerConnectionEventHandler<Event>; // Extension: https://www.w3.org/TR/webrtc/#h-rtcpeerconnection-interface-extensions getSenders(): RTCRtpSender[]; getReceivers(): RTCRtpReceiver[]; getTransceivers(): RTCRtpTransceiver[]; addTrack(track: MediaStreamTrack, ...streams: MediaStream[]): RTCRtpSender; removeTrack(sender: RTCRtpSender): void; addTransceiver(trackOrKind: MediaStreamTrack | string, init?: RTCRtpTransceiverInit): RTCRtpTransceiver; ontrack: PeerConnectionEventHandler<RTCTrackEvent>; // Extension: https://www.w3.org/TR/webrtc/#h-rtcpeerconnection-interface-extensions-1 readonly sctp: RTCSctpTransport | null; createDataChannel(label: string | null, dataChannelDict?: RTCDataChannelInit): RTCDataChannel; ondatachannel: PeerConnectionEventHandler<RTCDataChannelEvent>; // Extension: https://www.w3.org/TR/webrtc/#h-rtcpeerconnection-interface-extensions-2 getStats(selector?: MediaStreamTrack | null): Promise<RTCStatsReport>; // Extension: https://www.w3.org/TR/webrtc/#legacy-interface-extensions // Deprecated! createOffer( successCallback: RTCSessionDescriptionCallback, failureCallback: RTCPeerConnectionErrorCallback, options?: RTCOfferOptions, ): Promise<void>; setLocalDescription( description: RTCSessionDescriptionInit, successCallback: () => void, failureCallback: RTCPeerConnectionErrorCallback, ): Promise<void>; createAnswer( successCallback: RTCSessionDescriptionCallback, failureCallback: RTCPeerConnectionErrorCallback, ): Promise<void>; setRemoteDescription( description: RTCSessionDescriptionInit, successCallback: () => void, failureCallback: RTCPeerConnectionErrorCallback, ): Promise<void>; addIceCandidate( candidate: RTCIceCandidateInit | RTCIceCandidate, successCallback: () => void, failureCallback: RTCPeerConnectionErrorCallback, ): Promise<void>; getStats( selector: MediaStreamTrack | null, successCallback: (report: RTCStatsReport) => void, failureCallback: RTCPeerConnectionErrorCallback, ): Promise<void>; } interface RTCPeerConnectionStatic { new(configuration?: RTCConfiguration, options?: any): RTCPeerConnection; readonly defaultIceServers: RTCIceServer[]; // Extension: https://www.w3.org/TR/webrtc/#sec.cert-mgmt generateCertificate(keygenAlgorithm: string): Promise<RTCCertificate>; } interface Window { RTCPeerConnection: RTCPeerConnectionStatic; }