Interface RTCPeerConnection

    A WebRTC connection between the local computer and a remote peer. It provides methods to connect to a remote peer, maintain and monitor the connection, and close the connection once it's no longer needed.

    MDN Reference

    interface RTCPeerConnection {
        canTrickleIceCandidates: boolean;
        connectionState: RTCPeerConnectionState;
        currentLocalDescription: RTCSessionDescription;
        currentRemoteDescription: RTCSessionDescription;
        iceConnectionState: RTCIceConnectionState;
        iceGatheringState: RTCIceGatheringState;
        localDescription: RTCSessionDescription;
        onconnectionstatechange: (this: RTCPeerConnection, ev: Event) => any;
        ondatachannel: (this: RTCPeerConnection, ev: RTCDataChannelEvent) => any;
        onicecandidate: (
            this: RTCPeerConnection,
            ev: RTCPeerConnectionIceEvent,
        ) => any;
        onicecandidateerror: (
            this: RTCPeerConnection,
            ev: RTCPeerConnectionIceErrorEvent,
        ) => any;
        oniceconnectionstatechange: (this: RTCPeerConnection, ev: Event) => any;
        onicegatheringstatechange: (this: RTCPeerConnection, ev: Event) => any;
        onnegotiationneeded: (this: RTCPeerConnection, ev: Event) => any;
        onsignalingstatechange: (this: RTCPeerConnection, ev: Event) => any;
        ontrack: (this: RTCPeerConnection, ev: RTCTrackEvent) => any;
        pendingLocalDescription: RTCSessionDescription;
        pendingRemoteDescription: RTCSessionDescription;
        remoteDescription: RTCSessionDescription;
        sctp: RTCSctpTransport;
        signalingState: RTCSignalingState;
        addEventListener<K extends keyof RTCPeerConnectionEventMap>(
            type: K,
            listener: (
                this: RTCPeerConnection,
                ev: RTCPeerConnectionEventMap[K],
            ) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addIceCandidate(candidate?: RTCIceCandidateInit): Promise<void>;
        addIceCandidate(
            candidate: RTCIceCandidateInit,
            successCallback: VoidFunction,
            failureCallback: RTCPeerConnectionErrorCallback,
        ): Promise<void>;
        addTrack(track: MediaStreamTrack, ...streams: MediaStream[]): RTCRtpSender;
        addTransceiver(
            trackOrKind: string | MediaStreamTrack,
            init?: RTCRtpTransceiverInit,
        ): RTCRtpTransceiver;
        close(): void;
        createAnswer(
            options?: RTCAnswerOptions,
        ): Promise<RTCSessionDescriptionInit>;
        createAnswer(
            successCallback: RTCSessionDescriptionCallback,
            failureCallback: RTCPeerConnectionErrorCallback,
        ): Promise<void>;
        createDataChannel(
            label: string,
            dataChannelDict?: RTCDataChannelInit,
        ): RTCDataChannel;
        createOffer(options?: RTCOfferOptions): Promise<RTCSessionDescriptionInit>;
        createOffer(
            successCallback: RTCSessionDescriptionCallback,
            failureCallback: RTCPeerConnectionErrorCallback,
            options?: RTCOfferOptions,
        ): Promise<void>;
        dispatchEvent(event: Event): boolean;
        getConfiguration(): RTCConfiguration;
        getReceivers(): RTCRtpReceiver[];
        getSenders(): RTCRtpSender[];
        getStats(selector?: MediaStreamTrack): Promise<RTCStatsReport>;
        getTransceivers(): RTCRtpTransceiver[];
        removeEventListener<K extends keyof RTCPeerConnectionEventMap>(
            type: K,
            listener: (
                this: RTCPeerConnection,
                ev: RTCPeerConnectionEventMap[K],
            ) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        removeTrack(sender: RTCRtpSender): void;
        restartIce(): void;
        setConfiguration(configuration?: RTCConfiguration): void;
        setLocalDescription(
            description?: RTCLocalSessionDescriptionInit,
        ): Promise<void>;
        setLocalDescription(
            description: RTCLocalSessionDescriptionInit,
            successCallback: VoidFunction,
            failureCallback: RTCPeerConnectionErrorCallback,
        ): Promise<void>;
        setRemoteDescription(description: RTCSessionDescriptionInit): Promise<void>;
        setRemoteDescription(
            description: RTCSessionDescriptionInit,
            successCallback: VoidFunction,
            failureCallback: RTCPeerConnectionErrorCallback,
        ): Promise<void>;
    }
    Hierarchy

    Properties

    canTrickleIceCandidates connectionState currentLocalDescription currentRemoteDescription iceConnectionState iceGatheringState localDescription onconnectionstatechange ondatachannel onicecandidate onicecandidateerror oniceconnectionstatechange onicegatheringstatechange onnegotiationneeded onsignalingstatechange ontrack pendingLocalDescription pendingRemoteDescription remoteDescription sctp signalingState

    Methods

    addEventListener addIceCandidate addTrack addTransceiver close createAnswer createDataChannel createOffer dispatchEvent getConfiguration getReceivers getSenders getStats getTransceivers removeEventListener removeTrack restartIce setConfiguration setLocalDescription setRemoteDescription

    Properties

    ReadonlycanTrickleIceCandidates

    canTrickleIceCandidates: boolean

    MDN Reference

    ReadonlyconnectionState

    connectionState: RTCPeerConnectionState

    MDN Reference

    ReadonlycurrentLocalDescription

    currentLocalDescription: RTCSessionDescription

    MDN Reference

    ReadonlycurrentRemoteDescription

    currentRemoteDescription: RTCSessionDescription

    MDN Reference

    ReadonlyiceConnectionState

    iceConnectionState: RTCIceConnectionState

    MDN Reference

    ReadonlyiceGatheringState

    iceGatheringState: RTCIceGatheringState

    MDN Reference

    ReadonlylocalDescription

    localDescription: RTCSessionDescription

    MDN Reference

    onconnectionstatechange

    onconnectionstatechange: (this: RTCPeerConnection, ev: Event) => any

    MDN Reference

    ondatachannel

    ondatachannel: (this: RTCPeerConnection, ev: RTCDataChannelEvent) => any

    MDN Reference

    onicecandidate

    onicecandidate: (this: RTCPeerConnection, ev: RTCPeerConnectionIceEvent) => any

    MDN Reference

    onicecandidateerror

    onicecandidateerror: (
        this: RTCPeerConnection,
        ev: RTCPeerConnectionIceErrorEvent,
    ) => any

    MDN Reference

    oniceconnectionstatechange

    oniceconnectionstatechange: (this: RTCPeerConnection, ev: Event) => any

    MDN Reference

    onicegatheringstatechange

    onicegatheringstatechange: (this: RTCPeerConnection, ev: Event) => any

    MDN Reference

    onnegotiationneeded

    onnegotiationneeded: (this: RTCPeerConnection, ev: Event) => any

    MDN Reference

    onsignalingstatechange

    onsignalingstatechange: (this: RTCPeerConnection, ev: Event) => any

    MDN Reference

    ontrack

    ontrack: (this: RTCPeerConnection, ev: RTCTrackEvent) => any

    MDN Reference

    ReadonlypendingLocalDescription

    pendingLocalDescription: RTCSessionDescription

    MDN Reference

    ReadonlypendingRemoteDescription

    pendingRemoteDescription: RTCSessionDescription

    MDN Reference

    ReadonlyremoteDescription

    remoteDescription: RTCSessionDescription

    MDN Reference

    Readonlysctp

    sctp: RTCSctpTransport

    MDN Reference

    ReadonlysignalingState

    signalingState: RTCSignalingState

    MDN Reference

    Methods

    addEventListener

    • addEventListener<K extends keyof RTCPeerConnectionEventMap>(
          type: K,
          listener: (
              this: RTCPeerConnection,
              ev: RTCPeerConnectionEventMap[K],
          ) => any,
          options?: boolean | AddEventListenerOptions,
      ): void

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Type Parameters

      Parameters

      Returns void

    • addEventListener(
          type: string,
          listener: EventListenerOrEventListenerObject,
          options?: boolean | AddEventListenerOptions,
      ): void

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Parameters

      Returns void

    addIceCandidate

    addTrack

    addTransceiver

    close

    createAnswer

    createDataChannel

    createOffer

    dispatchEvent

    • dispatchEvent(event: Event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      MDN Reference

      Parameters

      Returns boolean

    getConfiguration

    getReceivers

    getSenders

    getStats

    getTransceivers

    removeEventListener

    removeTrack

    restartIce

    setConfiguration

    setLocalDescription

    setRemoteDescription

    Settings

    Member Visibility

    On This Page

    Properties
    Methods