Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VirtualBackgroundSource

The custom background image.

since

v3.5.0.3

Hierarchy

  • VirtualBackgroundSource

Index

Constructors

Properties

Constructors

constructor

Properties

Optional backgroundSourceType

backgroundSourceType: VirtualBackgroundSourceType

The type of the custom background image. See VirtualBackgroundSourceType.

Optional blur_degree

blur_degree: VirtualBackgroundBlurDegree

The degree of blurring applied to the custom background image. See VirtualBackgroundBlurDegree.

Since v3.5.2

Optional color

color: Color

The color of the custom background image. The format is a hexadecimal integer defined by RGB, without the # sign, such as 0xFFB6C1 for light pink. The default value is 0xFFFFFF, which signifies white. The value range is [0x000000,0xffffff]. If the value is invalid, the SDK replaces the original background image with a white background image.

Note This parameter takes effect only when the type of the custom background image is Color.

Optional source

source: undefined | string

The local absolute path of the custom background image. PNG and JPG formats are supported. If the path is invalid, the SDK replaces the original background image with a white background image.

Note This parameter takes effect only when the type of the custom background image is Img.

Generated using TypeDoc