Class HMSVideoTrackSettings

Represents the settings for a video track in a HMS (100ms) application.

This class encapsulates the configurations for video tracks that can be used in a HMS session.

See

https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/track/track-settings

Hierarchy

HMSVideoTrackSettings

Index

Constructors

constructor

Properties

cameraFacing? disableAutoResize? forceSoftwareDecoder? initialState? simulcastSettings? videoPlugin?

Constructors

constructor

new HMSVideoTrackSettings(params): HMSVideoTrackSettings
Parameters
- params: {
      cameraFacing?: HMSCameraFacing;
      disableAutoResize?: boolean;
      forceSoftwareDecoder?: boolean;
      initialState?: HMSTrackSettingsInitState;
      simulcastSettings?: HMSSimulcastLayerSettings[];
      videoPlugin?: HMSVirtualBackgroundPlugin;
  }
  - Optional cameraFacing?: HMSCameraFacing
  - Optional disableAutoResize?: boolean
  - Optional forceSoftwareDecoder?: boolean
  - Optional initialState?: HMSTrackSettingsInitState
  - Optional simulcastSettings?: HMSSimulcastLayerSettings[]
  - Optional videoPlugin?: HMSVirtualBackgroundPlugin
Returns HMSVideoTrackSettings
- Defined in src/classes/HMSVideoTrackSettings.ts:40

Properties

`Optional` cameraFacing

cameraFacing?: HMSCameraFacing

Optional camera facing for the track.

`Optional` disableAutoResize

disableAutoResize?: boolean

Optional flag to disable auto resize.

`Optional` forceSoftwareDecoder

forceSoftwareDecoder?: boolean

Optional flag to force software decoder.

`Optional` initialState

initialState?: HMSTrackSettingsInitState

Optional initial state for the track.

`Optional` `Readonly` simulcastSettings

simulcastSettings?: HMSSimulcastLayerSettings[]

Optional simulcast settings.

`Optional` videoPlugin

videoPlugin?: HMSVirtualBackgroundPlugin

Optional video plugin settings.

Class HMSVideoTrackSettings

See

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

params: {
    cameraFacing?: HMSCameraFacing;
    disableAutoResize?: boolean;
    forceSoftwareDecoder?: boolean;
    initialState?: HMSTrackSettingsInitState;
    simulcastSettings?: HMSSimulcastLayerSettings[];
    videoPlugin?: HMSVirtualBackgroundPlugin;
}

`Optional` cameraFacing?: HMSCameraFacing

`Optional` disableAutoResize?: boolean

`Optional` forceSoftwareDecoder?: boolean

`Optional` initialState?: HMSTrackSettingsInitState

`Optional` simulcastSettings?: HMSSimulcastLayerSettings[]

`Optional` videoPlugin?: HMSVirtualBackgroundPlugin

Returns HMSVideoTrackSettings

Properties

`Optional` cameraFacing

`Optional` disableAutoResize

`Optional` forceSoftwareDecoder

`Optional` initialState

`Optional` `Readonly` simulcastSettings

`Optional` videoPlugin

Settings

Member Visibility

Theme

On This Page

Class HMSVideoTrackSettings

See

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

params: { cameraFacing?: HMSCameraFacing; disableAutoResize?: boolean; forceSoftwareDecoder?: boolean; initialState?: HMSTrackSettingsInitState; simulcastSettings?: HMSSimulcastLayerSettings[]; videoPlugin?: HMSVirtualBackgroundPlugin; }

Optional cameraFacing?: HMSCameraFacing

Optional disableAutoResize?: boolean

Optional forceSoftwareDecoder?: boolean

Optional initialState?: HMSTrackSettingsInitState

Optional simulcastSettings?: HMSSimulcastLayerSettings[]

Optional videoPlugin?: HMSVirtualBackgroundPlugin

Returns HMSVideoTrackSettings

Properties

Optional cameraFacing

Optional disableAutoResize

Optional forceSoftwareDecoder

Optional initialState

Optional Readonly simulcastSettings

Optional videoPlugin

Settings

Member Visibility

Theme

On This Page

params: {
cameraFacing?: HMSCameraFacing;
disableAutoResize?: boolean;
forceSoftwareDecoder?: boolean;
initialState?: HMSTrackSettingsInitState;
simulcastSettings?: HMSSimulcastLayerSettings[];
videoPlugin?: HMSVirtualBackgroundPlugin;
}

`Optional` cameraFacing?: HMSCameraFacing

`Optional` disableAutoResize?: boolean

`Optional` forceSoftwareDecoder?: boolean

`Optional` initialState?: HMSTrackSettingsInitState

`Optional` simulcastSettings?: HMSSimulcastLayerSettings[]

`Optional` videoPlugin?: HMSVirtualBackgroundPlugin

`Optional` cameraFacing

`Optional` disableAutoResize

`Optional` forceSoftwareDecoder

`Optional` initialState

`Optional` `Readonly` simulcastSettings

`Optional` videoPlugin