NodeAV

Appearance

node-av / webrtc / RTCPeerConnection

Class: RTCPeerConnection ​

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:13

Extends ​

  • EventTarget

Constructors ​

Constructor ​

new RTCPeerConnection(config?): RTCPeerConnection

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:46

Parameters ​

config? ​

Partial<PeerConfig>

Returns ​

RTCPeerConnection

Overrides ​

EventTarget.constructor

Properties ​

addEventListener ​

addEventListener: (type, listener) => void

Defined in: node_modules/werift/lib/webrtc/src/helper.d.ts:14

Parameters ​

type ​

string

listener ​

(...args) => void

Returns ​

void

Inherited from ​

EventTarget.addEventListener

cname ​

readonly cname: string

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:14

config ​

config: Required<PeerConfig>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:15

connectionStateChange ​

readonly connectionStateChange: Event<["new" | "closed" | "disconnected" | "connected" | "failed" | "connecting"]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:30

iceConnectionStateChange ​

readonly iceConnectionStateChange: Event<["new" | "closed" | "disconnected" | "completed" | "connected" | "failed" | "checking"]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:28

iceGatheringStateChange ​

readonly iceGatheringStateChange: Event<["new" | "complete" | "gathering"]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:27

needRestart ​

needRestart: boolean

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:18

negotiationneeded ​

negotiationneeded: boolean

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:17

onconnectionstatechange? ​

optional onconnectionstatechange?: Callback

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:44

ondatachannel? ​

optional ondatachannel?: CallbackWithValue<RTCDataChannelEvent>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:37

onDataChannel ​

readonly onDataChannel: Event<[RTCDataChannel]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:31

onicecandidate? ​

optional onicecandidate?: CallbackWithValue<RTCPeerConnectionIceEvent>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:38

onIceCandidate ​

readonly onIceCandidate: Event<[RTCIceCandidate | undefined]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:34

onicecandidateerror? ​

optional onicecandidateerror?: CallbackWithValue<any>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:39

oniceconnectionstatechange? ​

optional oniceconnectionstatechange?: Callback

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:45

onicegatheringstatechange? ​

optional onicegatheringstatechange?: CallbackWithValue<any>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:40

onnegotiationneeded? ​

optional onnegotiationneeded?: CallbackWithValue<any>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:41

onNegotiationneeded ​

readonly onNegotiationneeded: Event<[]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:35

onRemoteTransceiverAdded ​

readonly onRemoteTransceiverAdded: Event<[RTCRtpTransceiver]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:32

onsignalingstatechange? ​

optional onsignalingstatechange?: CallbackWithValue<any>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:42

ontrack? ​

optional ontrack?: CallbackWithValue<RTCTrackEvent>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:43

onTrack ​

readonly onTrack: Event<[MediaStreamTrack]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:36

onTransceiverAdded ​

readonly onTransceiverAdded: Event<[RTCRtpTransceiver]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:33

removeEventListener ​

removeEventListener: (type, listener) => void

Defined in: node_modules/werift/lib/webrtc/src/helper.d.ts:15

Parameters ​

type ​

string

listener ​

(...args) => void

Returns ​

void

Inherited from ​

EventTarget.removeEventListener

signalingState ​

signalingState: "closed" | "stable" | "have-local-offer" | "have-remote-offer" | "have-local-pranswer" | "have-remote-pranswer"

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:16

signalingStateChange ​

readonly signalingStateChange: Event<["closed" | "stable" | "have-local-offer" | "have-remote-offer" | "have-local-pranswer" | "have-remote-pranswer"]>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:29

Accessors ​

connectionState ​

Get Signature ​

get connectionState(): "new" | "closed" | "disconnected" | "connected" | "failed" | "connecting"

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:47

Returns ​

"new" | "closed" | "disconnected" | "connected" | "failed" | "connecting"

dtlsTransports ​

Get Signature ​

get dtlsTransports(): RTCDtlsTransport[]

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:51

Returns ​

RTCDtlsTransport[]

extIdUriMap ​

Get Signature ​

get extIdUriMap(): object

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:55

Returns ​

object

iceConnectionState ​

Get Signature ​

get iceConnectionState(): "new" | "closed" | "disconnected" | "completed" | "connected" | "failed" | "checking"

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:48

Returns ​

"new" | "closed" | "disconnected" | "completed" | "connected" | "failed" | "checking"

iceGathererState ​

Get Signature ​

get iceGathererState(): "new" | "complete" | "gathering"

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:49

Returns ​

"new" | "complete" | "gathering"

iceGatheringState ​

Get Signature ​

get iceGatheringState(): "new" | "complete" | "gathering"

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:50

Returns ​

"new" | "complete" | "gathering"

iceGeneration ​

Get Signature ​

get iceGeneration(): number

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:58

Returns ​

number

iceTransports ​

Get Signature ​

get iceTransports(): RTCIceTransport[]

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:54

Returns ​

RTCIceTransport[]

localDescription ​

Get Signature ​

get localDescription(): RTCSessionDescription | undefined

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:59

Returns ​

RTCSessionDescription | undefined

remoteDescription ​

Get Signature ​

get remoteDescription(): RTCSessionDescription | undefined

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:60

Returns ​

RTCSessionDescription | undefined

remoteIsBundled ​

Get Signature ​

get remoteIsBundled(): GroupDescription | undefined

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:61

Returns ​

GroupDescription | undefined

sctpRemotePort ​

Get Signature ​

get sctpRemotePort(): number | undefined

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:53

Returns ​

number | undefined

sctpTransport ​

Get Signature ​

get sctpTransport(): RTCSctpTransport | undefined

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:52

Returns ​

RTCSctpTransport | undefined

Methods ​

[captureRejectionSymbol]()? ​

optional [captureRejectionSymbol](error, event, ...args): void

Defined in: node_modules/@types/node/events.d.ts:87

The Symbol.for('nodejs.rejection') method is called in case a promise rejection happens when emitting an event and captureRejections is enabled on the emitter. It is possible to use events.captureRejectionSymbol in place of Symbol.for('nodejs.rejection').

js
import { EventEmitter, captureRejectionSymbol } from 'node:events';

class MyClass extends EventEmitter {
  constructor() {
    super({ captureRejections: true });
  }

  [captureRejectionSymbol](err, event, ...args) {
    console.log('rejection happened for', event, 'with', err, ...args);
    this.destroy(err);
  }

  destroy(err) {
    // Tear the resource down here.
  }
}

Parameters ​

error ​

Error

event ​

string | symbol

args ​

...any[]

Returns ​

void

Since ​

v13.4.0, v12.16.0

Inherited from ​

EventTarget.[captureRejectionSymbol]

addIceCandidate() ​

addIceCandidate(candidateMessage): Promise<void>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:91

Parameters ​

candidateMessage ​

RTCIceCandidate | RTCIceCandidateInit

Returns ​

Promise<void>

addListener() ​

addListener<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:92

Alias for emitter.on(eventName, listener).

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

listener ​

(...args) => void

Returns ​

this

Since ​

v0.1.26

Inherited from ​

EventTarget.addListener

addTrack() ​

addTrack(track, ms?): RTCRtpSender

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:96

Parameters ​

track ​

MediaStreamTrack

ms? ​

MediaStream

todo impl

Returns ​

RTCRtpSender

addTransceiver() ​

addTransceiver(trackOrKind, options?): RTCRtpTransceiver

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:95

Parameters ​

trackOrKind ​

MediaStreamTrack | Kind

options? ​

Partial<TransceiverOptions>

Returns ​

RTCRtpTransceiver

close() ​

close(): Promise<void>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:104

Returns ​

Promise<void>

createAnswer() ​

createAnswer(): Promise<RTCSessionDescription>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:99

Returns ​

Promise<RTCSessionDescription>

createDataChannel() ​

createDataChannel(label, options?): RTCDataChannel

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:75

Parameters ​

label ​

string

options? ​

Partial<{ id?: number; maxPacketLifeTime?: number; maxRetransmits?: number; negotiated: boolean; ordered: boolean; protocol: string; }>

Returns ​

RTCDataChannel

createOffer() ​

createOffer(__namedParameters?): Promise<RTCSessionDescription>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:71

Parameters ​

__namedParameters? ​
iceRestart? ​

boolean

Returns ​

Promise<RTCSessionDescription>

emit() ​

emit<E>(eventName, ...args): boolean

Defined in: node_modules/@types/node/events.d.ts:134

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

js
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

args ​

...any[]

Returns ​

boolean

Since ​

v0.1.26

Inherited from ​

EventTarget.emit

eventNames() ​

eventNames(): (string | symbol)[]

Defined in: node_modules/@types/node/events.d.ts:154

Returns an array listing the events for which the emitter has registered listeners.

js
import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns ​

(string | symbol)[]

Since ​

v6.0.0

Inherited from ​

EventTarget.eventNames

getConfiguration() ​

getConfiguration(): Required<PeerConfig>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:70

Returns ​

Required<PeerConfig>

getMaxListeners() ​

getMaxListeners(): number

Defined in: node_modules/@types/node/events.d.ts:161

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to events.defaultMaxListeners.

Returns ​

number

Since ​

v1.0.0

Inherited from ​

EventTarget.getMaxListeners

getReceivers() ​

getReceivers(): RTCRtpReceiver[]

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:68

Returns ​

RTCRtpReceiver[]

getSenders() ​

getSenders(): RTCRtpSender[]

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:67

Returns ​

RTCRtpSender[]

getStats() ​

getStats(selector?): Promise<RTCStatsReport>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:103

Parameters ​

selector? ​

MediaStreamTrack | null

Returns ​

Promise<RTCStatsReport>

getTransceivers() ​

getTransceivers(): RTCRtpTransceiver[]

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:66

Returns ​

RTCRtpTransceiver[]

listenerCount() ​

listenerCount<E>(eventName, listener?): number

Defined in: node_modules/@types/node/events.d.ts:170

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

The name of the event being listened for

listener? ​

(...args) => void

The event handler function

Returns ​

number

Since ​

v3.2.0

Inherited from ​

EventTarget.listenerCount

listeners() ​

listeners<E>(eventName): (...args) => void[]

Defined in: node_modules/@types/node/events.d.ts:186

Returns a copy of the array of listeners for the event named eventName.

js
server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

Returns ​

(...args) => void[]

Since ​

v0.1.26

Inherited from ​

EventTarget.listeners

off() ​

off<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:191

Alias for emitter.removeListener().

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

listener ​

(...args) => void

Returns ​

this

Since ​

v10.0.0

Inherited from ​

EventTarget.off

on() ​

on<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:225

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

js
server.on('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

js
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

The name of the event.

listener ​

(...args) => void

The callback function

Returns ​

this

Since ​

v0.1.101

Inherited from ​

EventTarget.on

once() ​

once<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:256

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

js
server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

js
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

The name of the event.

listener ​

(...args) => void

The callback function

Returns ​

this

Since ​

v0.3.0

Inherited from ​

EventTarget.once

prependListener() ​

prependListener<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:275

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

js
server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

The name of the event.

listener ​

(...args) => void

The callback function

Returns ​

this

Since ​

v6.0.0

Inherited from ​

EventTarget.prependListener

prependOnceListener() ​

prependOnceListener<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:292

Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

js
server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

The name of the event.

listener ​

(...args) => void

The callback function

Returns ​

this

Since ​

v6.0.0

Inherited from ​

EventTarget.prependOnceListener

rawListeners() ​

rawListeners<E>(eventName): (...args) => void[]

Defined in: node_modules/@types/node/events.d.ts:326

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

js
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

Returns ​

(...args) => void[]

Since ​

v9.4.0

Inherited from ​

EventTarget.rawListeners

removeAllListeners() ​

removeAllListeners<E>(eventName?): this

Defined in: node_modules/@types/node/events.d.ts:338

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName? ​

string | symbol

Returns ​

this

Since ​

v0.1.26

Inherited from ​

EventTarget.removeAllListeners

removeListener() ​

removeListener<E>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:425

Removes the specified listener from the listener array for the event named eventName.

js
const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events behave as expected.

js
import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indexes of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

js
import { EventEmitter } from 'node:events';
const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters ​

E ​

E extends string | symbol

Parameters ​

eventName ​

string | symbol

listener ​

(...args) => void

Returns ​

this

Since ​

v0.1.26

Inherited from ​

EventTarget.removeListener

removeTrack() ​

removeTrack(sender): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:83

Parameters ​

sender ​

RTCRtpSender

Returns ​

void

restartIce() ​

restartIce(): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:93

Returns ​

void

setConfiguration() ​

setConfiguration(config): void

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:69

Parameters ​

config ​

Partial<PeerConfig>

Returns ​

void

setLocalDescription() ​

setLocalDescription(sessionDescription?): Promise<SessionDescription>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:86

Parameters ​

sessionDescription? ​
sdp ​

string

type ​

"offer" | "answer"

Returns ​

Promise<SessionDescription>

setMaxListeners() ​

setMaxListeners(n): this

Defined in: node_modules/@types/node/events.d.ts:436

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters ​

n ​

number

Returns ​

this

Since ​

v0.3.5

Inherited from ​

EventTarget.setMaxListeners

setRemoteDescription() ​

setRemoteDescription(sessionDescription): Promise<void>

Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:94

Parameters ​

sessionDescription ​

RTCSessionDescriptionInit

Returns ​

Promise<void>