Class WatermarkConfig

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

public class WatermarkConfig extends Object
Since:
4.6.0
  • Field Details

    • WATERMARK_TYPE_IMAGE

      public static final int WATERMARK_TYPE_IMAGE
      Specifies that the watermark is an image.
      See Also:
    • WATERMARK_TYPE_BUFFER

      public static final int WATERMARK_TYPE_BUFFER
      Specifies that the watermark is provided as a buffer.
      See Also:
    • id

      public String id
      The unique identifier of the watermark. Usually generated using a UUID.
    • type

      public int type
      The type of the watermark. Can be either WATERMARK_TYPE_IMAGE or WATERMARK_TYPE_BUFFER.
    • buffer

      public WatermarkBuffer buffer
      The buffer that contains the watermark image data.
    • imageUrl

      public String imageUrl
      The URL from which to load the watermark image.
    • options

      public WatermarkOptions options
      The options that define the position and size of the watermark.
  • Constructor Details

    • WatermarkConfig

      public WatermarkConfig()
  • Method Details

    • getId

      public String getId()
      Returns:
      The unique ID of the watermark.
      Since:
      4.6.0
    • getType

      public int getType()
      Returns:
      The type of the watermark. See WATERMARK_TYPE_IMAGE and WATERMARK_TYPE_BUFFER.
      Since:
      4.6.0
    • getBuffer

      public WatermarkBuffer getBuffer()
      Returns:
      The buffer containing the watermark image data.
      Since:
      4.6.0
    • getImageUrl

      public String getImageUrl()
      Returns:
      The URL of the watermark image.
      Since:
      4.6.0
    • getOptions

      public WatermarkOptions getOptions()
      Returns:
      The options for positioning and sizing the watermark.
      Since:
      4.6.0