Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VirtualBackgroundSource

The custom background image.

since

v3.4.5

Hierarchy

  • VirtualBackgroundSource

Index

Properties

Properties

background_source_type

background_source_type: BACKGROUND_SOURCE_TYPE

The type of the custom background image:

  • 1: (Default) The background image is a solid color.
  • 2: The background image is a file in PNG or JPG format.
  • 3: The background image is blurred.
since

v3.4.5

blur_degree

blur_degree: BACKGROUND_BLUR_DEGREE

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

note

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

since

v3.6.1.4

color

color: number

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 BACKGROUND_COLOR.

source

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.

note

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