Agora Java API Reference for Android
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
io.agora.rtc2.video.WatermarkConfig Class Reference

Configuration options for adding a watermark to the video stream. More...

Public Member Functions

String getId ()
 Gets the watermark ID. More...
 
int getType ()
 Gets the watermark type. More...
 
WatermarkBuffer getBuffer ()
 Gets the watermark buffer. More...
 
String getImageUrl ()
 Gets the watermark image URL. More...
 
WatermarkOptions getOptions ()
 Gets the watermark display options. More...
 

Public Attributes

String id
 
int type
 
WatermarkBuffer buffer = new WatermarkBuffer()
 
String imageUrl
 
WatermarkOptions options = new WatermarkOptions()
 

Static Public Attributes

static final int WATERMARK_TYPE_IMAGE = 0
 
static final int WATERMARK_TYPE_BUFFER = 1
 

Detailed Description

Configuration options for adding a watermark to the video stream.

Since
4.6.0

This class allows you to configure watermark properties such as type, image source, position, and size.

Member Function Documentation

◆ getId()

String io.agora.rtc2.video.WatermarkConfig.getId ( )

Gets the watermark ID.

Since
4.6.0
Returns
The unique ID of the watermark.

◆ getType()

int io.agora.rtc2.video.WatermarkConfig.getType ( )

Gets the watermark type.

Since
4.6.0
Returns
The type of the watermark. See WATERMARK_TYPE_IMAGE and {}.

◆ getBuffer()

WatermarkBuffer io.agora.rtc2.video.WatermarkConfig.getBuffer ( )

Gets the watermark buffer.

Since
4.6.0
Returns
The buffer containing the watermark image data.

◆ getImageUrl()

String io.agora.rtc2.video.WatermarkConfig.getImageUrl ( )

Gets the watermark image URL.

Since
4.6.0
Returns
The URL of the watermark image.

◆ getOptions()

WatermarkOptions io.agora.rtc2.video.WatermarkConfig.getOptions ( )

Gets the watermark display options.

Since
4.6.0
Returns
The options for positioning and sizing the watermark.

Member Data Documentation

◆ WATERMARK_TYPE_IMAGE

final int io.agora.rtc2.video.WatermarkConfig.WATERMARK_TYPE_IMAGE = 0
static

Specifies that the watermark is an image.

◆ WATERMARK_TYPE_BUFFER

final int io.agora.rtc2.video.WatermarkConfig.WATERMARK_TYPE_BUFFER = 1
static

Specifies that the watermark is provided as a buffer.

◆ id

String io.agora.rtc2.video.WatermarkConfig.id

The unique identifier of the watermark. Usually generated using a UUID.

◆ type

int io.agora.rtc2.video.WatermarkConfig.type

The type of the watermark. Can be either WATERMARK_TYPE_IMAGE or WATERMARK_TYPE_BUFFER.

◆ buffer

WatermarkBuffer io.agora.rtc2.video.WatermarkConfig.buffer = new WatermarkBuffer()

The buffer that contains the watermark image data.

◆ imageUrl

String io.agora.rtc2.video.WatermarkConfig.imageUrl

The URL from which to load the watermark image.

◆ options

WatermarkOptions io.agora.rtc2.video.WatermarkConfig.options = new WatermarkOptions()

The options that define the position and size of the watermark.