VirtualBackgroundSource

Custom background.

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

Properties

background_source_type

Custom background. See BackgroundSourceType.

color

Color of the custom background image. The format is a hexadecimal integer defined in RGB, without the # symbol. For example, 0xFFB6C1 represents light pink. The default value is 0xFFFFFF, which represents white. The valid range is [0x000000, 0xffffff]. If the value is invalid, the SDK replaces the original background image with a white background.

Note: This parameter takes effect only when the custom background is of the following types:

BackgroundColor: The background image is a solid color image of the color specified by this parameter.
BackgroundImg: If the image in source has a transparent background, the color specified by this parameter is used to fill the transparent area.

source

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

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

blur_degree

Blur level of the custom background image. See BackgroundBlurDegree.

Note: This parameter takes effect only when the custom background type is BackgroundBlur.