Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

Index

Properties

EventTarget

EventTarget: { constructor: any; prototype: EventTarget }

Type declaration

Readonly canTrickleIceCandidates

canTrickleIceCandidates: boolean | null

Readonly connectionState

connectionState: RTCPeerConnectionState

Readonly currentLocalDescription

currentLocalDescription: RTCSessionDescription | null

Readonly currentRemoteDescription

currentRemoteDescription: RTCSessionDescription | null

Readonly iceConnectionState

iceConnectionState: RTCIceConnectionState

Readonly iceGatheringState

iceGatheringState: RTCIceGatheringState

Readonly idpErrorInfo

idpErrorInfo: string | null

Readonly idpLoginUrl

idpLoginUrl: string | null

Readonly localDescription

localDescription: RTCSessionDescription | null

onconnectionstatechange

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

ondatachannel

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

onicecandidate

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

onicecandidateerror

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

oniceconnectionstatechange

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

onicegatheringstatechange

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

onnegotiationneeded

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

onsignalingstatechange

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

onstatsended

onstatsended: ((this: RTCPeerConnection, ev: RTCStatsEvent) => any) | null

ontrack

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

Readonly peerIdentity

Readonly pendingLocalDescription

pendingLocalDescription: RTCSessionDescription | null

Readonly pendingRemoteDescription

pendingRemoteDescription: RTCSessionDescription | null

Readonly remoteDescription

remoteDescription: RTCSessionDescription | null

Readonly sctp

sctp: RTCSctpTransport | null

Readonly signalingState

signalingState: RTCSignalingState

Methods

addEventListener

addIceCandidate

addTrack

addTransceiver

close

  • close(): void
  • Returns void

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.

    Parameters

    Returns boolean

getConfiguration

  • Returns RTCConfiguration

getIdentityAssertion

  • getIdentityAssertion(): Promise<string>
  • Returns Promise<string>

getReceivers

  • Returns RTCRtpReceiver[]

getSenders

  • Returns RTCRtpSender[]

getStats

getTransceivers

  • Returns RTCRtpTransceiver[]

removeEventListener

removeTrack

  • Parameters

    Returns void

setConfiguration

  • Parameters

    Returns void

setIdentityProvider

  • Parameters

    Returns void

setLocalDescription

setRemoteDescription

Generated using TypeDoc