Public Attributes
BACKGROUND_SOURCE_TYPE	background_source_type

uint	color

string	source

BACKGROUND_BLUR_DEGREE	blur_degree

Detailed Description

The custom background image.

Since: 3.4.5

Member Data Documentation

◆ background_source_type

BACKGROUND_SOURCE_TYPE agora_gaming_rtc.VirtualBackgroundSource.background_source_type

The type of the custom background image. See BACKGROUND_SOURCE_TYPE.

◆ color

uint agora_gaming_rtc.VirtualBackgroundSource.color

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.

Note: This parameter takes effect only when the type of the custom background image is BACKGROUND_COLOR.

◆ source

string agora_gaming_rtc.VirtualBackgroundSource.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.

Note: This parameter takes effect only when the type of the custom background image is BACKGROUND_IMG.

◆ blur_degree

BACKGROUND_BLUR_DEGREE agora_gaming_rtc.VirtualBackgroundSource.blur_degree

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

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

The documentation for this struct was generated from the following file: