#include <IAgoraRtcEngine.h>
Public Types | |
enum | BACKGROUND_SOURCE_TYPE { BACKGROUND_COLOR = 1 , BACKGROUND_IMG , BACKGROUND_BLUR } |
enum | BACKGROUND_BLUR_DEGREE { BLUR_DEGREE_LOW = 1 , BLUR_DEGREE_MEDIUM , BLUR_DEGREE_HIGH } |
Public Member Functions | |
VirtualBackgroundSource () | |
Public Attributes | |
BACKGROUND_SOURCE_TYPE | background_source_type |
unsigned int | color |
const char * | source |
BACKGROUND_BLUR_DEGREE | blur_degree |
The custom background image.
The degree of blurring applied to the custom background image.
|
inline |
BACKGROUND_SOURCE_TYPE agora::rtc::VirtualBackgroundSource::background_source_type |
The type of the custom background image. See BACKGROUND_SOURCE_TYPE.
unsigned int agora::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.
BACKGROUND_COLOR
. const char* agora::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.
BACKGROUND_IMG
. BACKGROUND_BLUR_DEGREE agora::rtc::VirtualBackgroundSource::blur_degree |
The degree of blurring applied to the custom background image. See BACKGROUND_BLUR_DEGREE.
BACKGROUND_BLUR
.