Interface HMSViewProps

Defines the properties for the HmsViewComponent.

This interface outlines the props that can be passed to the HmsViewComponent to configure its behavior and appearance.

HmsComponentProps

See

Hierarchy

  • HMSViewProps

Properties

autoSimulcast? id mirror? scaleType? setZOrderMediaOverlay? style? trackId

Properties

Optional autoSimulcast

autoSimulcast?: boolean

Optional. Enables automatic simulcast layer switching based on network conditions, if supported.

id

id: string

The identifier for the HmsViewComponent instance.

Optional mirror

mirror?: boolean

Optional. If true, the video will be mirrored. This is commonly used for local video tracks.

Optional scaleType

scaleType?: HMSVideoViewMode

Optional. Determines how the video fits within the bounds of the view (e.g., aspect fill, aspect fit).

Optional setZOrderMediaOverlay

setZOrderMediaOverlay?: boolean

Optional. When true, the video view will be rendered above the regular view hierarchy.

Optional style

style?: ViewStyle

Optional. Custom styles to apply to the view.

trackId

trackId: string

The unique identifier for the track to be displayed.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc