Public Member Functions | |
VirtualBackgroundSource (int backgroundSourceType, int color, String source, int blur_degree) | |
Public Attributes | |
int | backgroundSourceType |
int | color |
String | source = null |
int | blur_degree |
Static Public Attributes | |
static final int | BACKGROUND_COLOR = 1 |
static final int | BACKGROUND_IMG = 2 |
static final int | BACKGROUND_BLUR = 3 |
static final int | BLUR_DEGREE_LOW = 1 |
static final int | BLUR_DEGREE_MEDIUM = 2 |
static final int | BLUR_DEGREE_HIGH = 3 |
The custom background image.
|
static |
1: (Default) The background image is a solid color.
|
static |
2: The background image is a file in PNG or JPG format.
|
static |
3: The background image is blurred.
|
static |
1: The degree of blurring applied to the custom background image is low. The user can almost see the background clearly.
|
static |
2: The degree of blurring applied to the custom background image is medium. It is difficult for the user to recognize details in the background.
|
static |
3: (Default) The degree of blurring applied to the custom background image is high. The user can barely see any distinguishing features in the background.
int io.agora.rtc.video.VirtualBackgroundSource.backgroundSourceType |
The type of the custom background image:
BACKGROUND_COLOR(1)
: (Default) The background image is a solid color.BACKGROUND_IMG(2)
: The background image is a file in PNG or JPG format.BACKGROUND_BLUR(3)
: The background image is blurred. int io.agora.rtc.video.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
. String io.agora.rtc.video.VirtualBackgroundSource.source = null |
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
. int io.agora.rtc.video.VirtualBackgroundSource.blur_degree |
The degree of blurring applied to the custom background image:
BLUR_DEGREE_LOW(1)
: The degree of blurring applied to the custom background image is low. The user can almost see the background clearly.BLUR_DEGREE_MEDIUM(2)
: The degree of blurring applied to the custom background image is medium. It is difficult for the user to recognize details in the background.BLUR_DEGREE_HIGH(3)
: (Default) The degree of blurring applied to the custom background image is high. The user can barely see any distinguishing features in the background.BACKGROUND_BLUR
.