Class HMSLocalVideoTrack

Represents a video track within the HMS (100ms) system.

This class extends HMSTrack to provide functionalities specific to video tracks. It includes additional property isDegraded to indicate whether the video quality has been intentionally reduced, typically for performance reasons. The constructor allows for the initialization of the video track with various parameters such as track ID, source, description, mute state, degradation state, ID, and type. These parameters provide detailed information about the video track and its characteristics.

See

https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/render-video/overview

Hierarchy

Constructors

constructor

Properties

id isDegraded? mute? settings? source? trackDescription? trackId type?

Methods

isMute setMute switchCamera

Constructors

constructor

Properties

id

id: string

A secondary identifier for the track.

Optional isDegraded

isDegraded?: boolean

Indicates whether the video quality of the track is degraded.

Optional mute

mute?: boolean

Indicates whether the track is currently muted.

Optional settings

settings?: HMSVideoTrackSettings

Optional source

source?: HMSTrackSource

The source of the track, indicating whether it's from a plugin, regular input, or screen sharing.

Optional trackDescription

trackDescription?: string

A brief description of the track.

trackId

trackId: string

The unique identifier for the track.

Optional type

type?: HMSTrackType

The type of the track, distinguishing between audio and video.

Methods

isMute

setMute

  • Switches local video feed on/off depending upon the value of isMute

    Parameters

    • isMute: boolean

    Returns void

    Memberof

    HMSLocalVideoTrack

switchCamera

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc