Interface HMSPIPConfig

Configuration options for Picture-in-Picture (PIP) mode in a React Native application using HMS.

This interface defines the settings available for customizing the PIP window that can appear when the app enters background mode. It includes options for automatically entering PIP mode, adjusting the aspect ratio and scale type of the PIP window, and toggling the visibility of various control buttons specific to Android or iOS platforms.

HMSPIPConfig

Hierarchy

  • HMSPIPConfig

Properties

aspectRatio? audioButton? autoEnterPipMode? endButton? scaleType? useActiveSpeaker? videoButton?

Properties

Optional aspectRatio

aspectRatio?: [number, number]

Sets the aspect ratio of the PIP window. Defaults are platform-specific: [16, 9] for Android and [9, 16] for iOS.

Optional audioButton

audioButton?: boolean

Controls the visibility of the audio mute/unmute button within the PIP window. Default is true. Applies only to Android.

Optional autoEnterPipMode

autoEnterPipMode?: boolean

Determines whether the app should automatically enter PIP mode when it goes into the background.

Optional endButton

endButton?: boolean

Controls the visibility of the end call button within the PIP window. Default is true. Applies only to Android.

Optional scaleType

scaleType?: HMSVideoViewMode

Defines the scaling behavior of the video within the PIP window. Options are ASPECT_FILL (default), ASPECT_FIT, and ASPECT_BALANCED. Applies only to iOS.

Optional useActiveSpeaker

useActiveSpeaker?: boolean

Whether the PIP window should automatically show the active speaker. Default is true. Applies only to iOS.

Optional videoButton

videoButton?: boolean

Controls the visibility of the video mute/unmute button within the PIP window. Default is true. Applies only to Android.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc