Package io.agora.rtc2.video

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
      Whether the watermark is visible in the local preview view: - `true`: (Default) The watermark is visible in the local preview view. - `false`: The watermark is not visible in the local preview view.

    • positionInLandscapeMode

      public WatermarkOptions.Rectangle positionInLandscapeMode
      The area to display the watermark image in landscape mode. See `Rectangle`.

    • positionInPortraitMode

      public WatermarkOptions.Rectangle positionInPortraitMode
      The area to display the watermark image in portrait mode. See `Rectangle`.

    • zOrder

      public int zOrder
      Layer order of the watermark image. The default value is 0.
      Since:
      4.6.0

  • Constructor Details

    • WatermarkOptions

      public WatermarkOptions()

  • Method Details

    • getPositionInLandscapeMode

      public int[] getPositionInLandscapeMode()
      Returns:
      When the method call succeeds, it returns an integer array with four elements representing the x, y, width, and height of the watermark rectangle.
      Since:
      4.6.0

    • getPositionInPortraitMode

      public int[] getPositionInPortraitMode()
      Returns:
      When the method call succeeds, it 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 the local video preview. - `false`: The watermark is not visible in the local video preview.
      Since:
      4.6.0

    • getzOrder

      public int getzOrder()
      Returns:
      If the method call succeeds, returns the Z-order index of the watermark image.
      Since:
      4.6.0