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. Format is a hexadecimal integer in RGB without the # symbol, e.g., 0xFFB6C1 represents light pink. Default is 0xFFFFFF (white). Valid range is [0x000000, 0xffffff]. If the value is invalid, the SDK replaces the background with white.

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

BackgroundColor: The background is a solid color image of the specified color.
BackgroundImg: If the image in source has a transparent background, the transparent area is filled with the specified color.

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 or the solid color 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. See BackgroundBlurDegree.

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