LocalTrack

Defined in: client-sdk-js/src/track/LocalTrack.ts:19

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

• LocalAudioTrack
• LocalVideoTrack

Constructors

Constructor

new LocalTrack(
   kind,
   mediaStreamTrack,
   source?,
   constraints?,
   userProvided?
): LocalTrack;

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

Parameters

kind

TrackKind

mediaStreamTrack

MediaStreamTrack

source?

TrackSource

constraints?

MediaTrackConstraints

userProvided?

boolean = false

Returns

LocalTrack

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

---

_processor?

protected _processor?: TrackProcessor<TrackKind>;

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

---

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

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

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

---

pauseUpstreamLock

protected pauseUpstreamLock: Mutex;

Defined in: client-sdk-js/src/track/LocalTrack.ts:35

---

processorElement?

protected processorElement?: HTMLMediaElement;

Defined in: client-sdk-js/src/track/LocalTrack.ts:23

---

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

---

trackChangeLock

protected trackChangeLock: Mutex;

Defined in: client-sdk-js/src/track/LocalTrack.ts:34

---

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

constraints

Get Signature

get constraints(): MediaTrackConstraints | undefined;

Defined in: client-sdk-js/src/track/LocalTrack.ts:69

Current capture constraints.

Returns

MediaTrackConstraints | undefined

---

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

---

dimensions

Get Signature

get dimensions(): TrackDimensions | undefined;

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

Video dimensions from the current track settings. Returns undefined for audio tracks.

Returns

TrackDimensions | undefined

---

id

Get Signature

get id(): string;

Defined in: client-sdk-js/src/track/LocalTrack.ts:64

The MediaStreamTrack id.

Returns

string

---

isLocal

Get Signature

get isLocal(): boolean;

Defined in: client-sdk-js/src/track/LocalTrack.ts:59

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

---

isUpstreamPaused

Get Signature

get isUpstreamPaused(): boolean;

Defined in: client-sdk-js/src/track/LocalTrack.ts:85

Whether upstream publishing has been paused via pauseUpstream.

Returns

boolean

---

isUserProvided

Get Signature

get isUserProvided(): boolean;

Defined in: client-sdk-js/src/track/LocalTrack.ts:90

Whether the track was provided by the user (not managed by the SDK).

Returns

boolean

---

mediaStreamTrack

Get Signature

get mediaStreamTrack(): MediaStreamTrack;

Defined in: client-sdk-js/src/track/LocalTrack.ts:55

Returns the processed track if a processor is active, otherwise the raw source track. Consumers should use this for playback and publishing.

Returns

MediaStreamTrack

Overrides

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

addVisibilityListener()

addVisibilityListener(): void;

Defined in: client-sdk-js/src/track/LocalTrack.ts:471

Start listening for visibility changes (should be called after publishing).

Returns

void

---

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

---

getDeviceId()

getDeviceId(): Promise<string | undefined>;

Defined in: client-sdk-js/src/track/LocalTrack.ts:267

Get the device ID currently used by this track.

Returns

Promise<string | undefined>

---

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

---

getProcessor()

getProcessor():
  | TrackProcessor<TrackKind>
  | undefined;

Defined in: client-sdk-js/src/track/LocalTrack.ts:105

Returns the currently active processor, or undefined.

Returns

| TrackProcessor<TrackKind> | undefined

---

getRTCStatsReport()

getRTCStatsReport(): Promise<RTCStatsReport | undefined>;

Defined in: client-sdk-js/src/track/LocalTrack.ts:259

Gets the RTCStatsReport for the underlying RTP sender.

Returns

Promise<RTCStatsReport | undefined>

---

getSourceTrackSettings()

getSourceTrackSettings(): MediaTrackSettings;

Defined in: client-sdk-js/src/track/LocalTrack.ts:114

Returns the settings of the original source track, ignoring any active processor. Useful when you need the real capture resolution or device info regardless of post-processing.

Returns

MediaTrackSettings

---

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

---

mute()

mute(): void;

Defined in: client-sdk-js/src/track/LocalTrack.ts:209

Mute the track (disables the MediaStreamTrack).

Returns

void

---

onEnded()

protected onEnded(): void;

Defined in: client-sdk-js/src/track/LocalTrack.ts:129

Hook fired when the underlying MediaStreamTrack ends.

Returns

void

Overrides

Track.onEnded

---

onEndedListener()

protected onEndedListener(): void;

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

Returns

void

Inherited from

Track.onEndedListener

---

pauseUpstream()

pauseUpstream(): Promise<void>;

Defined in: client-sdk-js/src/track/LocalTrack.ts:223

Pause publishing to the server without disabling the local MediaStreamTrack. Useful for showing a local preview while not sending to remote participants.

Returns

Promise<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

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

---

replaceTrack()

replaceTrack(newTrack): Promise<void>;

Defined in: client-sdk-js/src/track/LocalTrack.ts:350

Parameters

newTrack

MediaStreamTrack

Returns

Promise<void>

---

restart()

restart(constraints?): Promise<void>;

Defined in: client-sdk-js/src/track/LocalTrack.ts:307

Parameters

constraints?

MediaTrackConstraints

Returns

Promise<void>

---

resumeUpstream()

resumeUpstream(): Promise<void>;

Defined in: client-sdk-js/src/track/LocalTrack.ts:240

Resume publishing after a call to pauseUpstream.

Returns

Promise<void>

---

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

---

setProcessor()

setProcessor(processor, showProcessedStreamLocally?): Promise<void>;

Defined in: client-sdk-js/src/track/LocalTrack.ts:142

Set a TrackProcessor on this track. Pass undefined to remove the current processor.

Parameters

processor

| TrackProcessor<TrackKind> | undefined

showProcessedStreamLocally?

boolean = true

Returns

Promise<void>

---

setTrackMuted()

protected setTrackMuted(muted): void;

Defined in: client-sdk-js/src/track/LocalTrack.ts:419

Parameters

muted

boolean

Returns

void

---

stop()

stop(): void;

Defined in: client-sdk-js/src/track/LocalTrack.ts:400

Returns

void

Overrides

Track.stop

---

stopMediaTrackQuietly()

protected stopMediaTrackQuietly(track): void;

Defined in: client-sdk-js/src/track/LocalTrack.ts:123

Suppresses the TrackEvent.Ended emission for tracks the SDK stops on purpose (device switch, stopOnMute, Safari restart, stop()) so that consumers can treat Ended as an actual device/source failure.

Parameters

track

MediaStreamTrack | undefined

Returns

void

---

stopProcessor()

stopProcessor(): Promise<void>;

Defined in: client-sdk-js/src/track/LocalTrack.ts:189

Stop and remove the current processor.

Returns

Promise<void>

---

unmute()

unmute(): void;

Defined in: client-sdk-js/src/track/LocalTrack.ts:214

Unmute the track (enables the MediaStreamTrack).

Returns

void

---

waitForDimensions()

waitForDimensions(timeout?): Promise<TrackDimensions>;

Defined in: client-sdk-js/src/track/LocalTrack.ts:277

Wait until the video track reports valid dimensions.

Parameters

timeout?

number = DEFAULT_DIMENSIONS_TIMEOUT

Returns

Promise<TrackDimensions>

Throws

Error if the track is audio or dimensions don’t become available within the timeout.

---

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