Class RemoteTrackPublication

Hierarchy (View Summary)

TrackPublication
- RemoteTrackPublication

Index

Constructors

Properties

dimensions? kind mimeType? simulcasted? source track? trackName trackSid

Accessors

audioTrack isDesired isEnabled isEncrypted isLocal isMuted isSubscribed permissionStatus subscriptionStatus videoQuality videoTrack

Methods

emitTrackUpdate handleMuted handleUnmuted setEnabled setSubscribed setVideoDimensions setVideoFPS setVideoQuality

Constructors

constructor

new RemoteTrackPublication(
    kind: Kind,
    ti: TrackInfo,
    autoSubscribe: boolean | undefined,
    loggerOptions?: LoggerOptions,
): RemoteTrackPublication
Parameters
- kind: Kind
- ti: TrackInfo
- autoSubscribe: boolean | undefined
- OptionalloggerOptions: LoggerOptions
Returns RemoteTrackPublication
Overrides TrackPublication.constructor
- Defined in room/track/RemoteTrackPublication.ts:39

Properties

`Optional`dimensions

dimensions?: Dimensions

dimension of the original published stream, video-only

kind

kind: Kind

`Optional`mimeType

mimeType?: string

MimeType of the published track

`Optional`simulcasted

simulcasted?: boolean

true if track was simulcasted to server, video-only

source

source: Source

`Optional`track

track?: RemoteTrack<Kind> = undefined

trackName

trackName: string

trackSid

trackSid: string

Accessors

audioTrack

get audioTrack(): LocalAudioTrack | RemoteAudioTrack | undefined
an [AudioTrack] if this publication holds an audio track

Returns LocalAudioTrack | RemoteAudioTrack | undefined
Inherited from TrackPublication.audioTrack
- Defined in room/track/TrackPublication.ts:108

isDesired

get isDesired(): boolean
Returns boolean
- Defined in room/track/RemoteTrackPublication.ts:108

isEnabled

get isEnabled(): boolean
Returns boolean
Overrides TrackPublication.isEnabled
- Defined in room/track/RemoteTrackPublication.ts:112

isEncrypted

get isEncrypted(): boolean
Returns boolean
Inherited from TrackPublication.isEncrypted
- Defined in room/track/TrackPublication.ts:99

isLocal

get isLocal(): boolean
Returns boolean
Overrides TrackPublication.isLocal
- Defined in room/track/RemoteTrackPublication.ts:120

isMuted

get isMuted(): boolean
Returns boolean
Inherited from TrackPublication.isMuted
- Defined in room/track/TrackPublication.ts:87

isSubscribed

get isSubscribed(): boolean
Returns true if track is subscribed, and ready for playback

Returns boolean
Overrides TrackPublication.isSubscribed
- Defined in room/track/RemoteTrackPublication.ts:100

permissionStatus

get permissionStatus(): PermissionStatus
Returns PermissionStatus
- Defined in room/track/RemoteTrackPublication.ts:91

subscriptionStatus

get subscriptionStatus(): SubscriptionStatus
Returns SubscriptionStatus
- Defined in room/track/RemoteTrackPublication.ts:81

videoQuality

get videoQuality(): VideoQuality | undefined
The maximum video quality that was requested with setVideoQuality(). When no quality was requested, it is VideoQuality.HIGH. setVideoDimensions() clears the requested quality, so it is VideoQuality.HIGH after that call too.

This value does not show the layer that the server sends. Adaptive stream and network bandwidth can make the server send a lower layer, and this value does not change.

Returns VideoQuality | undefined

See
RemoteVideoTrack.getReceiverStats() (frameWidth and frameHeight) for the size of the video that the client receives.
- Defined in room/track/RemoteTrackPublication.ts:211

videoTrack

get videoTrack(): LocalVideoTrack | RemoteVideoTrack | undefined
an [VideoTrack] if this publication holds a video track

Returns LocalVideoTrack | RemoteVideoTrack | undefined
Inherited from TrackPublication.videoTrack
- Defined in room/track/TrackPublication.ts:117

Methods

emitTrackUpdate

emitTrackUpdate(): void
Returns void
- Defined in room/track/RemoteTrackPublication.ts:327

handleMuted

handleMuted(): void
Returns void
Inherited from TrackPublication.handleMuted
- Defined in room/track/TrackPublication.ts:123

handleUnmuted

handleUnmuted(): void
Returns void
Inherited from TrackPublication.handleUnmuted
- Defined in room/track/TrackPublication.ts:127

setEnabled

setEnabled(enabled: boolean): void
disable server from sending down data for this track. this is useful when the participant is off screen, you may disable streaming down their video to reduce bandwidth requirements
Parameters
- enabled: boolean
Returns void
- Defined in room/track/RemoteTrackPublication.ts:130

setSubscribed

setSubscribed(subscribed: boolean): void
Subscribe or unsubscribe to this remote track
Parameters
- subscribed: boolean
  true to subscribe to a track, false to unsubscribe
Returns void
- Defined in room/track/RemoteTrackPublication.ts:54

setVideoDimensions

setVideoDimensions(dimensions: Dimensions): void
Explicitly set the video dimensions for this track.

With adaptive stream, the SDK requests the smaller of these and the adaptive stream dimensions (by pixel count). It clears a quality that was requested with setVideoQuality().
Parameters
- dimensions: Dimensions
  The video dimensions to set.
Returns void
- Defined in room/track/RemoteTrackPublication.ts:165

setVideoFPS

setVideoFPS(fps: number): void
Parameters
- fps: number
Returns void
- Defined in room/track/RemoteTrackPublication.ts:183

setVideoQuality

setVideoQuality(quality: VideoQuality): void
for tracks that support simulcasting, adjust subscribed quality

This indicates the highest quality the client can accept. if network bandwidth does not allow, server will automatically reduce quality to optimize for uninterrupted video
Parameters
- quality: VideoQuality
Returns void
- Defined in room/track/RemoteTrackPublication.ts:146