Class WatermarkOptions

java.lang.Object
io.agora.rtc2.video.WatermarkOptions

public class WatermarkOptions extends Object
Since:
4.6.0
  • Field Details

    • visibleInPreview

      public boolean visibleInPreview
      Sets whether or not the watermark image is visible in the local video preview: - true: (Default) The watermark image is visible in preview. - false: The watermark image is not visible in preview.
    • positionInLandscapeMode

      public WatermarkOptions.Rectangle positionInLandscapeMode
      The watermark position in the landscape mode. See Rectangle. See details for the landscape mode in the advanced guide *Rotate the Video*.
    • positionInPortraitMode

      public WatermarkOptions.Rectangle positionInPortraitMode
      The watermark position in the portrait mode. See Rectangle. See details for the portrait mode in the advanced guide *Rotate the Video*.
    • zOrder

      public int zOrder
      Since:
      4.6.0
  • Constructor Details

    • WatermarkOptions

      public WatermarkOptions()
  • Method Details

    • getPositionInLandscapeMode

      public int[] getPositionInLandscapeMode()
      Returns:
      An integer array of four elements representing the x, y, width, and height of the watermark rectangle.
      Since:
      4.6.0
    • getPositionInPortraitMode

      public int[] getPositionInPortraitMode()
      Returns:
      An integer array of four elements representing the x, y, width, and height of the watermark rectangle.
      Since:
      4.6.0
    • isVisibleInPreview

      public boolean isVisibleInPreview()
      Returns:
      true: The watermark is visible in preview; false: The watermark is not visible in preview.
      Since:
      4.6.0
    • getzOrder

      public int getzOrder()
      Returns:
      The z-order index of the watermark image.
      Since:
      4.6.0