Class: Track

Constructors

Constructor

new Track(opts): Track;

Parameters

Parameter	Type
opts	TrackOptions

Returns

Track

Properties

Property	Modifier	Type
isLocal	readonly	boolean
kind	readonly	TrackKind
participantIdentity	readonly	string
source	readonly	TrackSource

Accessors

display

Get Signature

get display(): TrackDisplay;

What the host last said about how this track is shown.

Returns

TrackDisplay

---

enabled

Get Signature

get enabled(): boolean;

True when the track is producing. A muted local track is still attached and still on the wire — it simply carries silence or black.

Returns

boolean

---

id

Get Signature

get id(): string;

Returns

string

---

mediaStreamTrack

Get Signature

get mediaStreamTrack(): MediaStreamTrack;

Returns

MediaStreamTrack

---

sid

Get Signature

get sid(): string;

The platform's TR_ sid. A local track in an sfu room gets one once PublishTrack has reserved it, which is after the capture it wraps exists; empty until then, and always empty in a p2p room.

Returns

string

Methods

attach()

attach(element?): HTMLMediaElement;

Parameters

Parameter	Type
element?	HTMLMediaElement

Returns

HTMLMediaElement

---

detach()

detach(element?): void;

Parameters

Parameter	Type
element?	HTMLMediaElement

Returns

void

---

ref()

readonly ref(element): void;

A ref callback, so the common case in React is <video ref={track.ref} /> and there is no effect to write, no dependency array to get wrong and no cleanup to forget. Bound once and stable, because a new function identity every render makes React detach and reattach on every render.

Parameters

Parameter	Type
element	HTMLMediaElement | null

Returns

void

---

resume()

resume(): Promise<void>;

Retries every attached element after a user gesture.

Returns

Promise<void>

---

setDisplay()

setDisplay(display): void;

Tell the SDK how this remote track is shown, so an sfu room sends only what is seen: an off-screen tile is paused, and a thumbnail is sent a thumbnail's worth. Resuming is immediate and renegotiates nothing. @talkline/react's useVisibleTile calls this from the element's own visibility and size, which is the common case.

Parameters

Parameter	Type
display	TrackDisplay

Returns

void

---

setSinkId()

setSinkId(deviceId): Promise<void>;

Output-device selection, which is setSinkId and is not everywhere: Firefox has it behind a preference and Safari does not have it at all. Refusing loudly beats a silent no-op that leaves a user wondering why the speaker they chose is not the one making noise.

Parameters

Parameter	Type
deviceId	string

Returns

Promise<void>

---

stop()

stop(): void;

Stops the underlying track. Local only — stopping a remote track just blinds this end without telling anybody.

Returns

void

---

swap()

swap(next): void;

A device change swaps the underlying track and every element already showing it follows, because they hold the same MediaStream object and it is the stream's contents that changed.

Parameters

Parameter	Type
next	MediaStreamTrack

Returns

void