VirtualBackgroundSource

Custom background.

public class VirtualBackgroundSource
    {
        public VirtualBackgroundSource()
        {
            background_source_type = BACKGROUND_SOURCE_TYPE.BACKGROUND_COLOR;
            color = 0xffffff;
            source = "";
            blur_degree = BACKGROUND_BLUR_DEGREE.BLUR_DEGREE_HIGH;
        }
        public BACKGROUND_SOURCE_TYPE background_source_type;
        public uint color;
        public string source;
        public BACKGROUND_BLUR_DEGREE blur_degree;
    };

Properties

background_source_type

Custom background. See BACKGROUND_SOURCE_TYPE.

color

Color of the custom background image. Format is a hexadecimal integer under RGB definition, without the # symbol, e.g., 0xFFB6C1 represents light pink. Default value is 0xFFFFFF, which represents white. Value range is [0x000000, 0xffffff]. If the value is invalid, the SDK replaces the original background with a white background.

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

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

source

Absolute local path to 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 only takes effect when the custom background type is BACKGROUND_IMG or BACKGROUND_VIDEO.

blur_degree

Blur level of the custom background. See BACKGROUND_BLUR_DEGREE.

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