RemoteTrack

Defined in: client-sdk-js/src/track/RemoteTrack.ts:10

A typed wrapper over Node’s EventEmitter.

Extends EventEmitter with declare overrides so that emit, on, off, etc. are type-safe without introducing circular-reference issues that arise when using typed-emitter directly in extends clauses whose event maps reference the class itself.

Runtime behaviour is 100% EventEmitter; this class adds zero runtime code.

Extends

Track

Extended by

Constructors

Constructor

new RemoteTrack(
   kind,
   source?,
   mediaStreamTrack
): RemoteTrack;

Defined in: client-sdk-js/src/track/RemoteTrack.ts:22

Parameters

kind

TrackKind

source?

TrackSource = TrackSource.Unknown

mediaStreamTrack

MediaStreamTrack

Returns

RemoteTrack

Overrides

Track.constructor

Properties

_currentBitrate

protected _currentBitrate: number = 0;

Defined in: client-sdk-js/src/track/Track.ts:43

Inherited from

Track._currentBitrate

_isMuted

protected _isMuted: boolean = false;

Defined in: client-sdk-js/src/track/Track.ts:37

Inherited from

Track._isMuted

_mediaStreamTrack

protected _mediaStreamTrack: MediaStreamTrack;

Defined in: client-sdk-js/src/track/Track.ts:31

Inherited from

Track._mediaStreamTrack

_prevBytes

protected _prevBytes: number = 0;

Defined in: client-sdk-js/src/track/Track.ts:47

Previous byte count from the last monitor sample.

Inherited from

Track._prevBytes

_prevStatsTime

protected _prevStatsTime: number = 0;

Defined in: client-sdk-js/src/track/Track.ts:48

Inherited from

Track._prevStatsTime

addListener

addListener: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:37

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof TrackEvents ? TrackEvents[E] : (…args) => void

Returns

this

Inherited from

Track.addListener

attachedElements

attachedElements: HTMLMediaElement[] = [];

Defined in: client-sdk-js/src/track/Track.ts:41

Inherited from

Track.attachedElements

emit

emit: <E>(event, ...args) => boolean;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:17

Type Parameters

E

Parameters

event

E

args

…Parameters<TrackEvents[E]>

Returns

boolean

Inherited from

Track.emit

kind

kind: TrackKind;

Defined in: client-sdk-js/src/track/Track.ts:27

Inherited from

Track.kind

listenerCount

listenerCount: (event) => number;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:57

Parameters

event

string | number

Returns

number

Inherited from

Track.listenerCount

listeners

listeners: <E>(event) => E extends keyof TrackEvents ? TrackEvents[E][] : ((...args) => void)[];

Defined in: client-sdk-js/src/utils/typedEmitter.ts:49

Type Parameters

E

E extends string | number

Parameters

event

E

Returns

E extends keyof TrackEvents ? TrackEvents[E][] : ((…args) => void)[]

Inherited from

Track.listeners

monitorInterval?

protected monitorInterval?: number;

Defined in: client-sdk-js/src/track/Track.ts:44

Inherited from

Track.monitorInterval

off

off: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:32

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof TrackEvents ? TrackEvents[E] : (…args) => void

Returns

this

Inherited from

Track.off

on

on: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:22

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof TrackEvents ? TrackEvents[E] : (…args) => void

Returns

this

Inherited from

Track.on

once

once: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:27

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof TrackEvents ? TrackEvents[E] : (…args) => void

Returns

this

Inherited from

Track.once

rawListeners

rawListeners: <E>(event) => E extends keyof TrackEvents ? TrackEvents[E][] : ((...args) => void)[];

Defined in: client-sdk-js/src/utils/typedEmitter.ts:53

Type Parameters

E

E extends string | number

Parameters

event

E

Returns

E extends keyof TrackEvents ? TrackEvents[E][] : ((…args) => void)[]

Inherited from

Track.rawListeners

removeAllListeners

removeAllListeners: (event?) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:47

Parameters

event?

string | number

Returns

this

Inherited from

Track.removeAllListeners

removeListener

removeListener: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:42

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof TrackEvents ? TrackEvents[E] : (…args) => void

Returns

this

Inherited from

Track.removeListener

sid?

sid?: string;

Defined in: client-sdk-js/src/track/Track.ts:29

Inherited from

Track.sid

source

source: TrackSource;

Defined in: client-sdk-js/src/track/Track.ts:28

Inherited from

Track.source

defaultMaxListeners

static defaultMaxListeners: number;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:5

Inherited from

Track.defaultMaxListeners

Accessors

currentBitrate

Get Signature

get currentBitrate(): number;

Defined in: client-sdk-js/src/track/Track.ts:77

Current bitrate in bits per second, updated by the monitor.

Returns

number

Inherited from

Track.currentBitrate

isLocal

Get Signature

get isLocal(): boolean;

Defined in: client-sdk-js/src/track/RemoteTrack.ts:30

Returns

boolean

Overrides

Track.isLocal

isMuted

Get Signature

get isMuted(): boolean;

Defined in: client-sdk-js/src/track/Track.ts:88

Whether the track is currently muted. This reflects the publisher’s intent and is independent of consumer pause state or streamState.

Returns

boolean

Inherited from

Track.isMuted

mediaStreamTrack

Get Signature

get mediaStreamTrack(): MediaStreamTrack;

Defined in: client-sdk-js/src/track/Track.ts:33

Returns

MediaStreamTrack

Inherited from

Track.mediaStreamTrack

streamState

Get Signature

get streamState(): StreamState;

Defined in: client-sdk-js/src/track/Track.ts:98

The current stream state of the track. StreamState.Active means the server is actively forwarding media; StreamState.Paused means the server has temporarily stopped forwarding (e.g. bandwidth limits). This is separate from isMuted, which reflects the publisher’s intent.

Returns

StreamState

Inherited from

Track.streamState

Methods

attach()

attach(element?): HTMLMediaElement;

Defined in: client-sdk-js/src/track/Track.ts:156

Parameters

element?

HTMLMediaElement

Returns

HTMLMediaElement

Inherited from

Track.attach

detach()

detach(element?): HTMLMediaElement[];

Defined in: client-sdk-js/src/track/Track.ts:199

Parameters

element?

HTMLMediaElement

Returns

HTMLMediaElement[]

Inherited from

Track.detach

detachEndedListener()

protected detachEndedListener(track): void;

Defined in: client-sdk-js/src/track/Track.ts:72

Detach the base-class ‘ended’ listener from the given track.

Parameters

track

MediaStreamTrack

Returns

void

Inherited from

Track.detachEndedListener

eventNames()

eventNames(): (string | number)[];

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:7

Returns

(string | number)[]

Inherited from

Track.eventNames

getMaxListeners()

getMaxListeners(): number;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:9

Returns

number

Inherited from

Track.getMaxListeners

getPlayoutDelay()

getPlayoutDelay(): number;

Defined in: client-sdk-js/src/track/RemoteTrack.ts:94

Returns the current playout delay (in seconds).

Returns

number

getRTCStatsReport()

getRTCStatsReport(): Promise<RTCStatsReport | undefined>;

Defined in: client-sdk-js/src/track/RemoteTrack.ts:75

Gets the RTCStatsReport for the underlying RTP receiver.

Returns

Promise<RTCStatsReport | undefined>

monitorStats()

protected monitorStats(
   getStats,
   reportType,
   bytesField
): Promise<void>;

Defined in: client-sdk-js/src/track/Track.ts:130

Samples RTP bytes from a stats report and updates currentBitrate. Shared by local (producer/outbound) and remote (consumer/inbound) tracks: they only differ in which report type and byte field to read.

Parameters

getStats

() => Promise<RTCStatsReport> | undefined

returns the underlying transport/producer/consumer stats, or undefined when the source is already closed.

reportType

string

the RTC stats report type to aggregate (e.g. outbound-rtp).

bytesField

string

the byte field name on that report (e.g. bytesSent).

Returns

Promise<void>

Inherited from

Track.monitorStats

onEnded()

protected onEnded(): void;

Defined in: client-sdk-js/src/track/Track.ts:67

Hook fired when the underlying MediaStreamTrack ends.

Returns

void

Inherited from

Track.onEnded

onEndedListener()

protected onEndedListener(): void;

Defined in: client-sdk-js/src/track/Track.ts:62

Returns

void

Inherited from

Track.onEndedListener

prependListener()

prependListener(type, listener): this;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:14

Parameters

type

string | number

listener

Listener

Returns

this

Inherited from

Track.prependListener

prependOnceListener()

prependOnceListener(type, listener): this;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:15

Parameters

type

string | number

listener

Listener

Returns

this

Inherited from

Track.prependOnceListener

setMaxListeners()

setMaxListeners(n): this;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:8

Parameters

n

number

Returns

this

Inherited from

Track.setMaxListeners

setPlayoutDelay()

setPlayoutDelay(delayInSeconds): void;

Defined in: client-sdk-js/src/track/RemoteTrack.ts:84

Set a playout delay (in seconds) for this track. Higher values allow more buffering in the browser and add latency.

Parameters

delayInSeconds

number

Returns

void

stop()

stop(): void;

Defined in: client-sdk-js/src/track/RemoteTrack.ts:53

Stop the remote track.

Returns

void

Overrides

Track.stop

listenerCount()

static listenerCount(emitter, type): number;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:4

Parameters

emitter

EventEmitter

type

string | number

Returns

number

Inherited from

Track.listenerCount