Class VirtualBackgroundSource

The custom background.

Hierarchy

  • VirtualBackgroundSource

Constructors

Properties

background_source_type?: BackgroundSourceType

The custom background. See BackgroundSourceType .

blur_degree?: BackgroundBlurDegree

The degree of blurring applied to the custom background image. See BackgroundBlurDegree .This parameter takes effect only when the type of the custom background image is BackgroundBlur.

color?: number

The type of the custom background image. 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.This parameter takes effect only when the type of the custom background image is BackgroundColor.

source?: 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.This parameter takes effect only when the type of the custom background image is BackgroundImg.

Generated using TypeDoc