Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

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

trackName

trackName: string

trackSid

trackSid: string

Accessors

audioTrack

isEnabled

  • get isEnabled(): boolean

isMuted

  • get isMuted(): boolean

isSubscribed

  • get isSubscribed(): boolean

subscriptionStatus

videoQuality

videoTrack

Methods

emitTrackUpdate

  • emitTrackUpdate(): void

handleMuted

  • handleMuted(): void

handleUnmuted

  • handleUnmuted(): void

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

setSubscribed

  • setSubscribed(subscribed: boolean): void

setTrack

  • setTrack(track?: Track): void

setVideoDimensions

  • setVideoDimensions(dimensions: Dimensions): void

setVideoQuality

  • 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

    Returns void

Generated using TypeDoc