Track

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

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

• TypedEmitter<TrackEvents>

Extended by

• LocalTrack
• RemoteTrack

Constructors

Constructor

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

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

Parameters

kind

TrackKind

source?

TrackSource = TrackSource.Unknown

mediaStreamTrack

MediaStreamTrack

Returns

Track

Overrides

TypedEmitter.constructor

Properties

_currentBitrate

protected _currentBitrate: number = 0;

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

---

_isMuted

protected _isMuted: boolean = false;

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

---

_mediaStreamTrack

protected _mediaStreamTrack: MediaStreamTrack;

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

---

_prevBytes

protected _prevBytes: number = 0;

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

Previous byte count from the last monitor sample.

---

_prevStatsTime

protected _prevStatsTime: number = 0;

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

---

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

TypedEmitter.addListener

---

attachedElements

attachedElements: HTMLMediaElement[] = [];

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

---

emit

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

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

Type Parameters

E

E extends | Muted | Unmuted | Ended | ElementAttached | ElementDetached | AudioPlaybackStarted | AudioPlaybackFailed | VideoPlaybackStarted | VideoPlaybackFailed | VisibilityChanged | VideoDimensionsChanged | UpstreamPaused | UpstreamResumed | AudioSilenceDetected | StreamStateChanged | TimeSyncUpdate

Parameters

event

E

args

…Parameters<TrackEvents[E]>

Returns

boolean

Inherited from

TypedEmitter.emit

---

kind

kind: TrackKind;

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

---

listenerCount

listenerCount: (event) => number;

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

Parameters

event

string | number

Returns

number

Inherited from

TypedEmitter.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

TypedEmitter.listeners

---

monitorInterval?

protected monitorInterval?: number;

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

---

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

TypedEmitter.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

TypedEmitter.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

TypedEmitter.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

TypedEmitter.rawListeners

---

removeAllListeners

removeAllListeners: (event?) => this;

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

Parameters

event?

string | number

Returns

this

Inherited from

TypedEmitter.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

TypedEmitter.removeListener

---

sid?

sid?: string;

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

---

source

source: TrackSource;

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

---

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

TypedEmitter.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

---

isLocal

Get Signature

get abstract isLocal(): boolean;

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

Returns

boolean

---

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

---

mediaStreamTrack

Get Signature

get mediaStreamTrack(): MediaStreamTrack;

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

Returns

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

Methods

attach()

attach(element?): HTMLMediaElement;

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

Parameters

element?

HTMLMediaElement

Returns

HTMLMediaElement

---

detach()

detach(element?): HTMLMediaElement[];

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

Parameters

element?

HTMLMediaElement

Returns

HTMLMediaElement[]

---

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

---

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

TypedEmitter.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

TypedEmitter.getMaxListeners

---

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>

---

onEnded()

protected onEnded(): void;

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

Hook fired when the underlying MediaStreamTrack ends.

Returns

void

---

onEndedListener()

protected onEndedListener(): void;

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

Returns

void

---

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

TypedEmitter.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

TypedEmitter.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

TypedEmitter.setMaxListeners

---

stop()

stop(): void;

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

Returns

void

---

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

TypedEmitter.listenerCount