Class: RTCPeerConnection

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Inherited from#

EventTarget.errorMonitor

Defined in#

node_modules/@types/node/events.d.ts:42

Accessors#

_localDescription#

• Private get _localDescription(): undefined | SessionDescription

Returns#

undefined | SessionDescription

Defined in#

packages/webrtc/src/peerConnection.ts:179

_remoteDescription#

• Private get _remoteDescription(): undefined | SessionDescription

Returns#

undefined | SessionDescription

Defined in#

packages/webrtc/src/peerConnection.ts:183

localDescription#

• get localDescription(): undefined | RTCSessionDescription

Returns#

undefined | RTCSessionDescription

Defined in#

packages/webrtc/src/peerConnection.ts:169

remoteDescription#

• get remoteDescription(): undefined | RTCSessionDescription

Returns#

undefined | RTCSessionDescription

Defined in#

packages/webrtc/src/peerConnection.ts:174

Methods#

addEventListener#

▸ addEventListener(type, listener): void

Parameters#

Name	Type
`type`	`string`
`listener`	(...`args`: `any`[]) => `void`

Returns#

void

Inherited from#

EventTarget.addEventListener

Defined in#

packages/webrtc/src/helper.ts:37

addIceCandidate#

▸ addIceCandidate(candidateMessage): Promise<void>

Parameters#

Name	Type
`candidateMessage`	RTCIceCandidate

Returns#

Promise<void>

Defined in#

packages/webrtc/src/peerConnection.ts:517

addListener#

▸ addListener(event, listener): RTCPeerConnection

Parameters#

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns#

RTCPeerConnection

Inherited from#

EventTarget.addListener

Defined in#

node_modules/@types/node/events.d.ts:62

addTrack#

▸ addTrack(track, ms?): RTCRtpSender

Parameters#

Name	Type
`track`	MediaStreamTrack
`ms?`	MediaStream

Returns#

RTCRtpSender

Defined in#

packages/webrtc/src/peerConnection.ts:867

addTransceiver#

▸ addTransceiver(trackOrKind, options?): RTCRtpTransceiver

Parameters#

Name	Type
`trackOrKind`	Kind \| MediaStreamTrack
`options`	`Partial`<TransceiverOptions>

Returns#

RTCRtpTransceiver

Defined in#

packages/webrtc/src/peerConnection.ts:825

assertNotClosed#

▸ Private assertNotClosed(): void

Returns#

void

Defined in#

packages/webrtc/src/peerConnection.ts:999

close#

▸ close(): Promise<void>

Returns#

Promise<void>

Defined in#

packages/webrtc/src/peerConnection.ts:977

connect#

▸ Private connect(): Promise<void>

Returns#

Promise<void>

Defined in#

packages/webrtc/src/peerConnection.ts:522

createAnswer#

▸ createAnswer(): Promise<RTCSessionDescription>

Returns#

Promise<RTCSessionDescription>

Defined in#

packages/webrtc/src/peerConnection.ts:913

createDataChannel#

▸ createDataChannel(label, options?): RTCDataChannel

Parameters#

Name	Type
`label`	`string`
`options`	`Partial`<`Object`>

Returns#

RTCDataChannel

Defined in#

packages/webrtc/src/peerConnection.ts:281

createOffer#

▸ createOffer(): Promise<RTCSessionDescription>

Returns#

Promise<RTCSessionDescription>

Defined in#

packages/webrtc/src/peerConnection.ts:197

createSctpTransport#

▸ Private createSctpTransport(): RTCSctpTransport

Returns#

RTCSctpTransport

Defined in#

packages/webrtc/src/peerConnection.ts:404

createTransport#

▸ Private createTransport(srtpProfiles?): Object

Parameters#

Name	Type	Default value
`srtpProfiles`	`number`[]	[]

Returns#

Object

Name	Type
`dtlsTransport`	RTCDtlsTransport
`iceTransport`	RTCIceTransport

Defined in#

packages/webrtc/src/peerConnection.ts:359

dispose#

▸ Private dispose(): void

Returns#

void

Defined in#

packages/webrtc/src/peerConnection.ts:1032

emit#

▸ emit(event, ...args): boolean

Parameters#

Name	Type
`event`	`string` \| `symbol`
`...args`	`any`[]

Returns#

boolean

Inherited from#

EventTarget.emit

Defined in#

node_modules/@types/node/events.d.ts:72

eventNames#

▸ eventNames(): (string | symbol)[]

Returns#

(string | symbol)[]

Inherited from#

EventTarget.eventNames

Defined in#

node_modules/@types/node/events.d.ts:77

fireOnTrack#

▸ Private fireOnTrack(track, transceiver, stream): void

Parameters#

Name	Type
`track`	MediaStreamTrack
`transceiver`	RTCRtpTransceiver
`stream`	MediaStream

Returns#

void

Defined in#

packages/webrtc/src/peerConnection.ts:810

getMaxListeners#

▸ getMaxListeners(): number

Returns#

number

Inherited from#

EventTarget.getMaxListeners

Defined in#

node_modules/@types/node/events.d.ts:69

getReceivers#

▸ getReceivers(): RTCRtpReceiver[]

Returns#

RTCRtpReceiver[]

Defined in#

packages/webrtc/src/peerConnection.ts:862

getSenders#

▸ getSenders(): RTCRtpSender[]

Returns#

RTCRtpSender[]

Defined in#

packages/webrtc/src/peerConnection.ts:858

getTransceiverByMLineIndex#

▸ Private getTransceiverByMLineIndex(index): undefined | RTCRtpTransceiver

Parameters#

Name	Type
`index`	`number`

Returns#

undefined | RTCRtpTransceiver

Defined in#

packages/webrtc/src/peerConnection.ts:191

getTransceiverByMid#

▸ Private getTransceiverByMid(mid): undefined | RTCRtpTransceiver

Parameters#

Name	Type
`mid`	`string`

Returns#

undefined | RTCRtpTransceiver

Defined in#

packages/webrtc/src/peerConnection.ts:187

getTransceivers#

▸ getTransceivers(): RTCRtpTransceiver[]

Returns#

RTCRtpTransceiver[]

Defined in#

packages/webrtc/src/peerConnection.ts:854

listenerCount#

▸ listenerCount(event): number

Parameters#

Name	Type
`event`	`string` \| `symbol`

Returns#

number

Inherited from#

EventTarget.listenerCount

Defined in#

node_modules/@types/node/events.d.ts:73

listeners#

▸ listeners(event): Function[]

Parameters#

Name	Type
`event`	`string` \| `symbol`

Returns#

Function[]

Inherited from#

EventTarget.listeners

Defined in#

node_modules/@types/node/events.d.ts:70

localRtp#

▸ Private localRtp(transceiver): RTCRtpParameters

Parameters#

Name	Type
`transceiver`	RTCRtpTransceiver

Returns#

RTCRtpParameters

Defined in#

packages/webrtc/src/peerConnection.ts:548

needNegotiation#

▸ Private needNegotiation(): Promise<void>

Returns#

Promise<void>

Defined in#

packages/webrtc/src/peerConnection.ts:348

off#

▸ off(event, listener): RTCPeerConnection

Parameters#

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns#

RTCPeerConnection

Inherited from#

EventTarget.off

Defined in#

node_modules/@types/node/events.d.ts:66

on#

▸ on(event, listener): RTCPeerConnection

Parameters#

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns#

RTCPeerConnection

Inherited from#

EventTarget.on

Defined in#

node_modules/@types/node/events.d.ts:63

once#

▸ once(event, listener): RTCPeerConnection

Parameters#

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns#

RTCPeerConnection

Inherited from#

EventTarget.once

Defined in#

node_modules/@types/node/events.d.ts:64

prependListener#

▸ prependListener(event, listener): RTCPeerConnection

Parameters#

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns#

RTCPeerConnection

Inherited from#

EventTarget.prependListener

Defined in#

node_modules/@types/node/events.d.ts:75

prependOnceListener#

▸ prependOnceListener(event, listener): RTCPeerConnection

Parameters#

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns#

RTCPeerConnection

Inherited from#

EventTarget.prependOnceListener

Defined in#

node_modules/@types/node/events.d.ts:76

rawListeners#

▸ rawListeners(event): Function[]

Parameters#

Name	Type
`event`	`string` \| `symbol`

Returns#

Function[]

Inherited from#

EventTarget.rawListeners

Defined in#

node_modules/@types/node/events.d.ts:71

remoteRtp#

▸ Private remoteRtp(remoteDescription, transceiver): RTCRtpReceiveParameters

Parameters#

Name	Type
`remoteDescription`	SessionDescription
`transceiver`	RTCRtpTransceiver

Returns#

RTCRtpReceiveParameters

Defined in#

packages/webrtc/src/peerConnection.ts:560

removeAllListeners#

▸ removeAllListeners(event?): RTCPeerConnection

Parameters#

Name	Type
`event?`	`string` \| `symbol`

Returns#

RTCPeerConnection

Inherited from#

EventTarget.removeAllListeners

Defined in#

node_modules/@types/node/events.d.ts:67

removeEventListener#

▸ removeEventListener(type, listener): void

Parameters#

Name	Type
`type`	`string`
`listener`	(...`args`: `any`[]) => `void`

Returns#

void

Inherited from#

EventTarget.removeEventListener

Defined in#

packages/webrtc/src/helper.ts:41

removeListener#

▸ removeListener(event, listener): RTCPeerConnection

Parameters#

Name	Type
`event`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns#

RTCPeerConnection

Inherited from#

EventTarget.removeListener

Defined in#

node_modules/@types/node/events.d.ts:65

removeTrack#

▸ removeTrack(sender): void

Parameters#

Name	Type
`sender`	`RTCRtpSender`

Returns#

void

Defined in#

packages/webrtc/src/peerConnection.ts:320

setConnectionState#

▸ Private setConnectionState(state): void

Parameters#

Name	Type
`state`	`"closed"` \| `"connecting"` \| `"failed"` \| `"disconnected"` \| `"new"` \| `"connected"`

Returns#

void

Defined in#

packages/webrtc/src/peerConnection.ts:1024

setLocal#

▸ Private setLocal(description): void

Parameters#

Name	Type
`description`	SessionDescription

Returns#

void

Defined in#

packages/webrtc/src/peerConnection.ts:508

setLocalDescription#

▸ setLocalDescription(sessionDescription): Promise<SessionDescription>

Parameters#

Name	Type
`sessionDescription`	`Object`
`sessionDescription.sdp`	`string`
`sessionDescription.type`	`"offer"` \| `"answer"`

Returns#

Promise<SessionDescription>

Defined in#

packages/webrtc/src/peerConnection.ts:419

setMaxListeners#

▸ setMaxListeners(n): RTCPeerConnection

Parameters#

Name	Type
`n`	`number`

Returns#

RTCPeerConnection

Inherited from#

EventTarget.setMaxListeners

Defined in#

node_modules/@types/node/events.d.ts:68

setRemoteDescription#

▸ setRemoteDescription(sessionDescription): Promise<void>

Parameters#

Name	Type
`sessionDescription`	`Object`
`sessionDescription.sdp`	`string`
`sessionDescription.type`	`"offer"` \| `"answer"`

Returns#

Promise<void>

Defined in#

packages/webrtc/src/peerConnection.ts:642

setSignalingState#

▸ Private setSignalingState(state): void

Parameters#

Name	Type
`state`	`"closed"` \| `"stable"` \| `"have-local-offer"` \| `"have-remote-offer"` \| `"have-local-pranswer"` \| `"have-remote-pranswer"`

Returns#

void

Defined in#

packages/webrtc/src/peerConnection.ts:1017

updateIceConnectionState#

▸ Private updateIceConnectionState(state): void

Parameters#

Name	Type
`state`	`"closed"` \| `"failed"` \| `"disconnected"` \| `"new"` \| `"connected"` \| `"checking"` \| `"completed"`

Returns#

void

Defined in#

packages/webrtc/src/peerConnection.ts:1010

updateIceGatheringState#

▸ Private updateIceGatheringState(state): void

Parameters#

Name	Type
`state`	`"new"` \| `"gathering"` \| `"complete"`

Returns#

void

Defined in#

packages/webrtc/src/peerConnection.ts:1003

validateDescription#

▸ Private validateDescription(description, isLocal): void

Parameters#

Name	Type
`description`	SessionDescription
`isLocal`	`boolean`

Returns#

void

Defined in#

packages/webrtc/src/peerConnection.ts:588

listenerCount#

▸ Static listenerCount(emitter, event): number

deprecated since v4.0.0

Parameters#

Name	Type
`emitter`	`EventEmitter`
`event`	`string` \| `symbol`

Returns#

number

Inherited from#

EventTarget.listenerCount

Defined in#

node_modules/@types/node/events.d.ts:31

on#

▸ Static on(emitter, event): AsyncIterableIterator<any>

Parameters#

Name	Type
`emitter`	`EventEmitter`
`event`	`string`

Returns#

AsyncIterableIterator<any>

Inherited from#

EventTarget.on

Defined in#

node_modules/@types/node/events.d.ts:28

once#

▸ Static once(emitter, event): Promise<any[]>

Parameters#

Name	Type
`emitter`	`NodeEventTarget`
`event`	`string` \| `symbol`

Returns#

Promise<any[]>

Inherited from#

EventTarget.once

Defined in#

node_modules/@types/node/events.d.ts:26

▸ Static once(emitter, event): Promise<any[]>

Parameters#

Name	Type
`emitter`	`DOMEventTarget`
`event`	`string`

Returns#

Promise<any[]>

Inherited from#

EventTarget.once

Defined in#

node_modules/@types/node/events.d.ts:27