VirtualBackgroundSource
The custom background.
struct VirtualBackgroundSource { enum BACKGROUND_SOURCE_TYPE { BACKGROUND_NONE = 0, BACKGROUND_COLOR = 1, BACKGROUND_IMG = 2, BACKGROUND_BLUR = 3, BACKGROUND_VIDEO = 4, }; enum BACKGROUND_BLUR_DEGREE { BLUR_DEGREE_LOW = 1, BLUR_DEGREE_MEDIUM = 2, BLUR_DEGREE_HIGH = 3, }; BACKGROUND_SOURCE_TYPE background_source_type; unsigned int color; const char* source; BACKGROUND_BLUR_DEGREE blur_degree; VirtualBackgroundSource() : background_source_type(BACKGROUND_COLOR), color(0xffffff), source(NULL), blur_degree(BLUR_DEGREE_HIGH) {} };
- background_source_type
- The custom background. See BACKGROUND_SOURCE_TYPE.
- 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 takes effect only when the type of the custom background image is BACKGROUND_COLOR.
- source
- 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.Attention: This parameter takes effect only when the type of the custom background image is BACKGROUND_IMG.
- blur_degree
- The degree of blurring applied to the custom background image. See BACKGROUND_BLUR_DEGREE.
Attention: This parameter takes effect only when the type of the custom background image is BACKGROUND_BLUR.