node-av / webrtc / MediaStreamTrack

Class: MediaStreamTrack

Defined in: node_modules/werift/lib/webrtc/src/media/track.d.ts:20

Extends

EventTarget

Constructors

Constructor

new MediaStreamTrack(props): MediaStreamTrack

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

Parameters

props

Partial<MediaStreamTrack> & Pick<MediaStreamTrack, "kind"> & object

Returns

MediaStreamTrack

Overrides

EventTarget.constructor

Properties

addEventListener

addEventListener: (type, listener, options?) => void

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

Parameters

type

string

listener

(...args) => void

options?

boolean | { once?: boolean; }

Returns

void

Inherited from

EventTarget.addEventListener

codec?

optional codec?: RTCRtpCodecParameters

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

dispatchEvent

dispatchEvent: (event) => boolean

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

Parameters

event

Event

Returns

boolean

Inherited from

EventTarget.dispatchEvent

enabled

enabled: boolean

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

todo impl

optional header?: RtpHeader

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

id?

optional id?: string

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

kind

kind: Kind

Defined in: node_modules/werift/lib/webrtc/src/media/track.d.ts:26

label

label: string

Defined in: node_modules/werift/lib/webrtc/src/media/track.d.ts:25

muted

muted: boolean

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

onReceiveRtcp

readonly onReceiveRtcp: Event<[RtcpPacket]>

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

onReceiveRtp

readonly onReceiveRtp: Event<[RtpPacket, Extensions?]>

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

onSourceChanged

readonly onSourceChanged: Event<[Pick<RtpHeader, "timestamp" | "sequenceNumber">]>

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

remote

remote: boolean

Defined in: node_modules/werift/lib/webrtc/src/media/track.d.ts:24

removeEventListener

removeEventListener: (type, listener) => void

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

Parameters

type

string

listener

(...args) => void

Returns

void

Inherited from

EventTarget.removeEventListener

rid?

optional rid?: string

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

ssrc?

optional ssrc?: number

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

mediaSsrc

stop

stop: () => void

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

Returns

void

stopped

stopped: boolean

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

streamId?

optional streamId?: string

Defined in: node_modules/werift/lib/webrtc/src/media/track.d.ts:23

MediaStream ID

uuid

readonly uuid: string

Defined in: node_modules/werift/lib/webrtc/src/media/track.d.ts:21

writeRtcp

writeRtcp: (rtcp) => void

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

Parameters

rtcp

RtcpPacket

Returns

void

writeRtp

writeRtp: (rtp) => void

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

Parameters

rtp

Buffer<ArrayBufferLike> | RtpPacket

Returns

void

Accessors

readyState

Get Signature

get readyState(): "live" | "ended"

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

Returns

"live" | "ended"

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').

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]

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

applyIncomingRtp()

applyIncomingRtp(packet, extensions?): void

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

Parameters

packet

RtpPacket

extensions?

Extensions

Returns

void

bindUpstreamStop()

bindUpstreamStop(stop): void

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

Parameters

stop

() => void

Returns

void

clone()

clone(): MediaStreamTrack

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

Returns

MediaStreamTrack

emit()

emit(type, ...args): boolean

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

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.

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

Parameters

type

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.

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

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

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.

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

notifySourceChanged()

notifySourceChanged(header): void

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

Parameters

header

Pick<RtpHeader, "sequenceNumber" | "timestamp">

Returns

void

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.

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.

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.

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.

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.

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.

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()).

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.

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.

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:

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

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

stopMediaSource()

stopMediaSource(): void

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

Returns

void

Interfaces

Class: MediaStreamTrack ​

Extends ​

Constructors ​

Constructor ​

Parameters ​

props ​

Returns ​

Overrides ​

Properties ​

addEventListener ​

Parameters ​

type ​

listener ​

options? ​

Returns ​

Inherited from ​

codec? ​

dispatchEvent ​

Parameters ​

event ​

Returns ​

Inherited from ​

enabled ​

header? ​

id? ​

kind ​

label ​

muted ​

onReceiveRtcp ​

onReceiveRtp ​

onSourceChanged ​

remote ​

removeEventListener ​

Parameters ​

type ​

listener ​

Returns ​

Inherited from ​

rid? ​

ssrc? ​

stop ​

Returns ​

stopped ​

streamId? ​

uuid ​

writeRtcp ​

Parameters ​

rtcp ​

Returns ​

writeRtp ​

Parameters ​

rtp ​

Returns ​

Accessors ​

readyState ​

Get Signature ​

Returns ​

Methods ​

[captureRejectionSymbol]()? ​

Parameters ​

error ​

event ​

args ​

Returns ​

Since ​

Inherited from ​

addListener() ​

Type Parameters ​

E ​

Parameters ​

eventName ​

listener ​

Returns ​

Since ​

Inherited from ​

applyIncomingRtp() ​

Parameters ​

packet ​

extensions? ​

Class: MediaStreamTrack

Extends

Constructors

Constructor

Parameters

props

Returns

Overrides

Properties

addEventListener

Parameters

type

listener

options?

Returns

Inherited from

codec?

dispatchEvent

Parameters

event

Returns

Inherited from

enabled

header?

id?

kind

label

muted

onReceiveRtcp

onReceiveRtp

onSourceChanged

remote

removeEventListener

Parameters

type

listener

Returns

Inherited from

rid?

ssrc?

stop

Returns

stopped

streamId?

uuid

writeRtcp

Parameters

rtcp

Returns

writeRtp

Parameters

rtp

Returns

Accessors

readyState

Get Signature

Returns

Methods

[captureRejectionSymbol]()?

Parameters

error

event

args

Returns

Since

Inherited from

addListener()

Type Parameters

E

Parameters

eventName

listener

Returns

Since

Inherited from

applyIncomingRtp()

Parameters

packet

extensions?

Returns