Package io.agora.rtc2.video

Class AgoraImage

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    double
    alpha
    The transparency of the watermark or background image.
    int
    height
    The height (px) of the image on the video frame.
    String
    url
    The HTTP/HTTPS URL address of the image in the live video.
    int
    width
    The width (px) of the image on the video frame.
    int
    x
    The x-coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin).
    int
    y
    The y-coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin).
    int
    zOrder
    The layer index of the watermark or background image.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AgoraImage()
     
    AgoraImage(String url)
     

  • Method Summary

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • url

      public String url
      The HTTP/HTTPS URL address of the image in the live video. The maximum length of this parameter is 1024 bytes.

    • x

      public int x
      The x-coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin).

    • y

      public int y
      The y-coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin).

    • width

      public int width
      The width (px) of the image on the video frame.

    • height

      public int height
      The height (px) of the image on the video frame.

    • zOrder

      public int zOrder
      The layer index of the watermark or background image. When you use the watermark array to add a watermark or multiple watermarks, you must pass a value to `zOrder` in the range [1,255]; otherwise, the SDK reports an error. In other cases, `zOrder` can optionally be passed in the range [0,255], with 0 being the default value. 0 means the bottom layer and 255 means the top layer.

    • alpha

      public double alpha
      The transparency of the watermark or background image. The range of the value is [0.0,1.0]: - 0.0: Completely transparent. - 1.0: (Default) Opaque.

  • Constructor Details

    • AgoraImage

      public AgoraImage()

    • AgoraImage

      public AgoraImage(String url)