Package io.agora.rtc2.video

Class VirtualBackgroundSource

java.lang.Object
io.agora.rtc2.video.VirtualBackgroundSource
public class VirtualBackgroundSource extends Object

  • Field Details

    • BACKGROUND_NONE

      public static final int BACKGROUND_NONE
      0: Enable segementation with the captured video frame without replacing the background.
      See Also:

    • BACKGROUND_COLOR

      public static final int BACKGROUND_COLOR
      1: The background is a solid color(eg: Oxffffff).
      See Also:

    • BACKGROUND_IMG

      public static final int BACKGROUND_IMG
      2: Image source in PNG or JPG format.
      See Also:

    • BACKGROUND_BLUR

      public static final int BACKGROUND_BLUR
      3: Background blur. blur your background, not including your body.
      See Also:

    • BACKGROUND_VIDEO

      public static final int BACKGROUND_VIDEO
      4: Video source in MP4, AVI, MKV, FLV format.
      See Also:

    • BLUR_DEGREE_LOW

      public static final int BLUR_DEGREE_LOW
      blur degree low, have few blur effect
      See Also:

    • BLUR_DEGREE_MEDIUM

      public static final int BLUR_DEGREE_MEDIUM
      blur degree medium, blur more than level 1
      See Also:

    • BLUR_DEGREE_HIGH

      public static final int BLUR_DEGREE_HIGH
      blur degree high, blur default, hard to find background
      See Also:

    • backgroundSourceType

      public int backgroundSourceType
      The custom background. - BACKGROUND_NONE (0): Process the background as alpha data 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

      public int 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.

    • source

      public String source
      The local absolute path of the custom background image. Supports PNG, JPG, MP4, AVI, MKV, and FLV formats. If the path is invalid, the SDK will use either the original background image or the solid color image specified by `color`.

    • blurDegree

      public int 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.

  • Constructor Details

    • VirtualBackgroundSource

      public VirtualBackgroundSource(int backgroundSourceType, int color, String source, int blurDegree)

    • VirtualBackgroundSource

      public VirtualBackgroundSource()