VirtualBackgroundSource

The custom background.

export class VirtualBackgroundSource {
  
  background_source_type?: BackgroundSourceType;
  
  color?: number;
  
  source?: string;
  
  blur_degree?: BackgroundBlurDegree;
}

Attributes

background_source_type

The custom background. See BackgroundSourceType.

color

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.

Attention: This parameter is only applicable to custom backgrounds of the following types:

BackgroundColor: The background image is a solid-colored image of the color passed in by the parameter.
BackgroundImg: If the image in source has a transparent background, the transparent background will be filled with the color passed in by the parameter.

source

The local absolute path of the custom background image. Supports PNG, JPG, MP4, AVI, MKV, and FLV formats. If the path is invalid, the SDK will use either the original background image or the solid color image specified by color.

Attention: This parameter takes effect only when the type of the custom background image is BackgroundImg or BackgroundVideo.

blur_degree

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

Attention: This parameter takes effect only when the type of the custom background image is BackgroundBlur.