VirtualBackgroundSource
The custom background.
public class VirtualBackgroundSource { public static final int BACKGROUND_NONE = 0; public static final int BACKGROUND_COLOR = 1; public static final int BACKGROUND_IMG = 2; public static final int BACKGROUND_BLUR = 3; public static final int BACKGROUND_VIDEO = 4; public static final int BLUR_DEGREE_LOW = 1; public static final int BLUR_DEGREE_MEDIUM = 2; public static final int BLUR_DEGREE_HIGH = 3; public int backgroundSourceType; public int color; public String source = null; public int blurDegree; public VirtualBackgroundSource( int backgroundSourceType, int color, String source, int blurDegree) { this.backgroundSourceType = backgroundSourceType; this.color = color; this.source = source; this.blurDegree = blurDegree; } public VirtualBackgroundSource() { this.backgroundSourceType = BACKGROUND_COLOR; this.color = 0xffffff; this.source = ""; this.blurDegree = BLUR_DEGREE_HIGH; } }
Attributes
- backgroundSourceType
- The custom background.
- BACKGROUND_NONE(0): Process the background as alpha information without replacement, only separating the portrait and the background. After setting this value, you can call startLocalVideoTranscoder to implement the picture-in-picture effect.
- 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 is a blurred version of the original background.
- BACKGROUND_VIDEO(4): The background is a local video in MP4, AVI, MKV, FLV, or other supported formats.
- 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.
- blurDegree
- 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): The degree of blurring applied to the custom background image is high. The user can barely see any distinguishing features in the background.
Attention: This parameter takes effect only when the type of the custom background image is BACKGROUND_BLUR.