RTCPeerConnection | Plan Engine

Hierarchy

EventTarget
- RTCPeerConnection
  - webkitRTCPeerConnection

Index

Properties

EventTarget

EventTarget: object

Type declaration

constructor: function
- new __type(): EventTarget
- - Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5082
  Returns EventTarget
prototype: EventTarget

canTrickleIceCandidates

canTrickleIceCandidates: boolean | null

connectionState

connectionState: RTCPeerConnectionState

currentLocalDescription

currentLocalDescription: RTCSessionDescription | null

currentRemoteDescription

currentRemoteDescription: RTCSessionDescription | null

iceConnectionState

iceConnectionState: RTCIceConnectionState

iceGatheringState

iceGatheringState: RTCIceGatheringState

idpErrorInfo

idpErrorInfo: string | null

idpLoginUrl

idpLoginUrl: string | null

localDescription

localDescription: RTCSessionDescription | null

onconnectionstatechange

onconnectionstatechange: function | null

ondatachannel

ondatachannel: function | null

onicecandidate

onicecandidate: function | null

onicecandidateerror

onicecandidateerror: function | null

oniceconnectionstatechange

oniceconnectionstatechange: function | null

onicegatheringstatechange

onicegatheringstatechange: function | null

onnegotiationneeded

onnegotiationneeded: function | null

onsignalingstatechange

onsignalingstatechange: function | null

onstatsended

onstatsended: function | null

ontrack

ontrack: function | null

peerIdentity

peerIdentity: Promise<RTCIdentityAssertion>

pendingLocalDescription

pendingLocalDescription: RTCSessionDescription | null

pendingRemoteDescription

pendingRemoteDescription: RTCSessionDescription | null

remoteDescription

remoteDescription: RTCSessionDescription | null

sctp

sctp: RTCSctpTransport | null

signalingState

signalingState: RTCSignalingState

Methods

addEventListener

addEventListener<K>(type: K, listener: function, options?: boolean | AddEventListenerOptions): void
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

Overrides EventTarget.addEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11633
Type parameters
- K: keyof RTCPeerConnectionEventMap
Parameters
- type: K
- listener: function
  - - (this: RTCPeerConnection, ev: RTCPeerConnectionEventMap[K]): any
    - Parameters
      - this: RTCPeerConnection
      - ev: RTCPeerConnectionEventMap[K]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11634
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

addIceCandidate

addIceCandidate(candidate: RTCIceCandidateInit | RTCIceCandidate): Promise<void>

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11615
Parameters
- candidate: RTCIceCandidateInit | RTCIceCandidate
Returns Promise<void>

addTrack

addTrack(track: MediaStreamTrack, ...streams: MediaStream[]): RTCRtpSender

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11616
Parameters
- track: MediaStreamTrack
- Rest ...streams: MediaStream[]
Returns RTCRtpSender

addTransceiver

addTransceiver(trackOrKind: MediaStreamTrack | string, init?: RTCRtpTransceiverInit): RTCRtpTransceiver

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11617
Parameters
- trackOrKind: MediaStreamTrack | string
- Optional init: RTCRtpTransceiverInit
Returns RTCRtpTransceiver

close

close(): void

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11618
Returns void

createAnswer

createAnswer(options?: RTCOfferOptions): Promise<RTCSessionDescriptionInit>

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11619
Parameters
- Optional options: RTCOfferOptions
Returns Promise<RTCSessionDescriptionInit>

createDataChannel

createDataChannel(label: string, dataChannelDict?: RTCDataChannelInit): RTCDataChannel

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11620
Parameters
- label: string
- Optional dataChannelDict: RTCDataChannelInit
Returns RTCDataChannel

createOffer

createOffer(options?: RTCOfferOptions): Promise<RTCSessionDescriptionInit>

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11621
Parameters
- Optional options: RTCOfferOptions
Returns Promise<RTCSessionDescriptionInit>

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5074
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
- event: Event
Returns boolean

getConfiguration

getConfiguration(): RTCConfiguration

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11622
Returns RTCConfiguration

getIdentityAssertion

getIdentityAssertion(): Promise<string>

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11623
Returns Promise<string>

getReceivers

getReceivers(): RTCRtpReceiver[]

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11624
Returns RTCRtpReceiver[]

getSenders

getSenders(): RTCRtpSender[]

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11625
Returns RTCRtpSender[]

getStats

getStats(selector?: MediaStreamTrack | null): Promise<RTCStatsReport>

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11626
Parameters
- Optional selector: MediaStreamTrack | null
Returns Promise<RTCStatsReport>

getTransceivers

getTransceivers(): RTCRtpTransceiver[]

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11627
Returns RTCRtpTransceiver[]

removeEventListener

removeEventListener<K>(type: K, listener: function, options?: boolean | EventListenerOptions): void
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

Overrides EventTarget.removeEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11635
Type parameters
- K: keyof RTCPeerConnectionEventMap
Parameters
- type: K
- listener: function
  - - (this: RTCPeerConnection, ev: RTCPeerConnectionEventMap[K]): any
    - Parameters
      - this: RTCPeerConnection
      - ev: RTCPeerConnectionEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11636
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

removeTrack

removeTrack(sender: RTCRtpSender): void

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11628
Parameters
- sender: RTCRtpSender
Returns void

setConfiguration

setConfiguration(configuration: RTCConfiguration): void

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11629
Parameters
- configuration: RTCConfiguration
Returns void

setIdentityProvider

setIdentityProvider(provider: string, options?: RTCIdentityProviderOptions): void

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11630
Parameters
- provider: string
- Optional options: RTCIdentityProviderOptions
Returns void

setLocalDescription

setLocalDescription(description: RTCSessionDescriptionInit): Promise<void>

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11631
Parameters
- description: RTCSessionDescriptionInit
Returns Promise<void>

setRemoteDescription

setRemoteDescription(description: RTCSessionDescriptionInit): Promise<void>

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:11632
Parameters
- description: RTCSessionDescriptionInit
Returns Promise<void>

Hierarchy

Index

Properties

Methods

Properties

EventTarget

Type declaration

constructor: function

Returns EventTarget

prototype: EventTarget

canTrickleIceCandidates

connectionState

currentLocalDescription

currentRemoteDescription

iceConnectionState

iceGatheringState

idpErrorInfo

idpLoginUrl

localDescription

onconnectionstatechange

ondatachannel

onicecandidate

onicecandidateerror

oniceconnectionstatechange

onicegatheringstatechange

onnegotiationneeded

onsignalingstatechange

onstatsended

ontrack

peerIdentity

pendingLocalDescription

pendingRemoteDescription

remoteDescription

sctp

signalingState

Methods

addEventListener

Type parameters

K: keyof RTCPeerConnectionEventMap

Parameters

type: K

listener: function

Parameters

this: RTCPeerConnection

ev: RTCPeerConnectionEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

addIceCandidate

Parameters

candidate: RTCIceCandidateInit | RTCIceCandidate

Returns Promise<void>

addTrack

Parameters

track: MediaStreamTrack

Rest ...streams: MediaStream[]

Returns RTCRtpSender

addTransceiver

Parameters

trackOrKind: MediaStreamTrack | string

Optional init: RTCRtpTransceiverInit

Returns RTCRtpTransceiver

close

Returns void

createAnswer

Parameters

Optional options: RTCOfferOptions

Returns Promise<RTCSessionDescriptionInit>

createDataChannel

Parameters

label: string

Optional dataChannelDict: RTCDataChannelInit

Returns RTCDataChannel

createOffer

Parameters