RemoteTrackPublication

Defined in: client-sdk-js/src/participant/RemoteTrackPublication.ts:11

Extends

• TrackPublication

Properties

dimensions?

dimensions?: object;

Defined in: client-sdk-js/src/participant/Participant.ts:52

Original video dimensions from the publisher.

height

height: number;

width

width: number;

Inherited from

TrackPublication.dimensions

---

info?

info?: TrackInfo;

Defined in: client-sdk-js/src/participant/Participant.ts:43

Inherited from

TrackPublication.info

---

kind

kind: string;

Defined in: client-sdk-js/src/participant/Participant.ts:39

Inherited from

TrackPublication.kind

---

mimeType?

mimeType?: string;

Defined in: client-sdk-js/src/participant/Participant.ts:46

MIME type of the track (e.g. video/VP8, audio/opus).

Inherited from

TrackPublication.mimeType

---

muted

muted: boolean;

Defined in: client-sdk-js/src/participant/Participant.ts:42

Inherited from

TrackPublication.muted

---

simulcasted?

simulcasted?: boolean;

Defined in: client-sdk-js/src/participant/Participant.ts:49

Whether the track was published with simulcast.

Inherited from

TrackPublication.simulcasted

---

source

source: TrackSource;

Defined in: client-sdk-js/src/participant/Participant.ts:40

Inherited from

TrackPublication.source

---

streamState

streamState: StreamState = StreamState.Active;

Defined in: client-sdk-js/src/participant/RemoteTrackPublication.ts:12

---

track?

track?: Track;

Defined in: client-sdk-js/src/participant/Participant.ts:41

Inherited from

TrackPublication.track

---

trackName

trackName: string;

Defined in: client-sdk-js/src/participant/Participant.ts:38

Inherited from

TrackPublication.trackName

---

trackSid

trackSid: string;

Defined in: client-sdk-js/src/participant/Participant.ts:37

Inherited from

TrackPublication.trackSid

Accessors

audioTrack

Get Signature

get audioTrack():
  | LocalAudioTrack
  | RemoteAudioTrack
  | undefined;

Defined in: client-sdk-js/src/participant/Participant.ts:94

Type-safe audio track getter. Returns undefined if the track is video.

Returns

| LocalAudioTrack | RemoteAudioTrack | undefined

Inherited from

TrackPublication.audioTrack

---

isDesired

Get Signature

get isDesired(): boolean;

Defined in: client-sdk-js/src/participant/RemoteTrackPublication.ts:59

Returns true if the client wants to subscribe to this track.

Returns

boolean

---

isEnabled

Get Signature

get isEnabled(): boolean;

Defined in: client-sdk-js/src/participant/RemoteTrackPublication.ts:76

Whether the server is enabled to send data for this track.

Returns

boolean

Overrides

TrackPublication.isEnabled

---

isLocal

Get Signature

get isLocal(): boolean;

Defined in: client-sdk-js/src/participant/Participant.ts:110

Whether this publication belongs to the local participant.

Returns

boolean

Inherited from

TrackPublication.isLocal

---

isMuted

Get Signature

get isMuted(): boolean;

Defined in: client-sdk-js/src/participant/Participant.ts:89

Whether the track is muted.

Returns

boolean

Inherited from

TrackPublication.isMuted

---

isSubscribed

Get Signature

get isSubscribed(): boolean;

Defined in: client-sdk-js/src/participant/RemoteTrackPublication.ts:53

Whether this track is currently subscribed.

Returns

boolean

Overrides

TrackPublication.isSubscribed

---

subscriptionStatus

Get Signature

get subscriptionStatus(): SubscriptionStatus;

Defined in: client-sdk-js/src/participant/RemoteTrackPublication.ts:64

Current subscription status.

Returns

SubscriptionStatus

---

videoQuality

Get Signature

get videoQuality(): VideoQuality | undefined;

Defined in: client-sdk-js/src/participant/RemoteTrackPublication.ts:71

The currently requested video quality.

Returns

VideoQuality | undefined

---

videoTrack

Get Signature

get videoTrack():
  | LocalVideoTrack
  | RemoteVideoTrack
  | undefined;

Defined in: client-sdk-js/src/participant/Participant.ts:102

Type-safe video track getter. Returns undefined if the track is audio.

Returns

| LocalVideoTrack | RemoteVideoTrack | undefined

Inherited from

TrackPublication.videoTrack

Methods

setEnabled()

setEnabled(enabled): void;

Defined in: client-sdk-js/src/participant/RemoteTrackPublication.ts:84

Enable or disable the server from sending data for this track. Useful when a track is off-screen.

Parameters

enabled

boolean

Returns

void

---

setSubscribed()

setSubscribed(subscribed): void;

Defined in: client-sdk-js/src/participant/RemoteTrackPublication.ts:110

Control whether the subscription for this track is desired. When set to false, the server will stop sending media for this track.

Parameters

subscribed

boolean

Returns

void

---

setVideoDimensions()

setVideoDimensions(dimensions): void;

Defined in: client-sdk-js/src/participant/RemoteTrackPublication.ts:150

Explicitly set the desired video dimensions for this track. Maps to spatialLayer using TrackInfo width/height as the high layer and typical simulcast factors (1/2, 1/4) when layer metadata is not on the wire.

Parameters

dimensions

height

number

width

number

Returns

void

---

setVideoFPS()

setVideoFPS(fps): void;

Defined in: client-sdk-js/src/participant/RemoteTrackPublication.ts:167

Set the desired video FPS for this subscription. In simulcast and SVC scenarios, fps controls the temporal layer.

Parameters

fps

number

Returns

void

---

setVideoQuality()

setVideoQuality(quality): void;

Defined in: client-sdk-js/src/participant/RemoteTrackPublication.ts:138

Set the preferred video quality for this subscription. Only applicable to video tracks.

Parameters

quality

VideoQuality

Returns

void