Class RemoteTrackPublication

Hierarchy (view full)

TrackPublication
- RemoteTrackPublication

Index

Constructors

constructor

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

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(): undefined | LocalAudioTrack | RemoteAudioTrack
an [AudioTrack] if this publication holds an audio track

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

isDesired

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

isEnabled

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

isEncrypted

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

isMuted

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

isSubscribed

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

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

permissionStatus

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

subscriptionStatus

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

videoQuality

get videoQuality(): undefined | VideoQuality
Returns undefined | VideoQuality
- Defined in src/room/track/RemoteTrackPublication.ts:178

videoTrack

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

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

Methods

emitTrackUpdate

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

handleMuted

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

handleUnmuted

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

setEnabled

setEnabled(enabled): 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 src/room/track/RemoteTrackPublication.ts:117

setSubscribed

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

setVideoDimensions

setVideoDimensions(dimensions): void
Parameters
- dimensions: Dimensions
Returns void
- Defined in src/room/track/RemoteTrackPublication.ts:143

setVideoFPS

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

setVideoQuality

setVideoQuality(quality): 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 src/room/track/RemoteTrackPublication.ts:133