Package io.agora.rtc2.video

Class WatermarkConfig

java.lang.Object

io.agora.rtc2.video.WatermarkConfig

public class WatermarkConfig
extends Object

Since:

4.6.0

Field Summary

Fields

Modifier and Type	Field	Description
WatermarkBuffer	buffer	Buffer containing watermark image data.
String	id	Unique identifier for the watermark, usually generated using UUID.
String	imageUrl	URL address used to load the watermark image.
WatermarkOptions	options	Options defining the position and size of the watermark.
int	type	Type of the watermark: - `WATERMARK_TYPE_IMAGE`: image type.
static final int	WATERMARK_TYPE_BUFFER	Specifies the watermark type as buffer.
static final int	WATERMARK_TYPE_IMAGE	Specifies the watermark type as image.

Constructor Summary

Constructors

Constructor	Description
WatermarkConfig()

Method Summary

Modifier and Type	Method	Description
WatermarkBuffer	getBuffer()
String	getId()
String	getImageUrl()
WatermarkOptions	getOptions()
int	getType()

Methods inherited from class java.lang.Object

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

Field Details

WATERMARK_TYPE_IMAGE

public static final int WATERMARK_TYPE_IMAGE

Specifies the watermark type as image.

See Also:

• Constant Field Values

WATERMARK_TYPE_BUFFER

public static final int WATERMARK_TYPE_BUFFER

Specifies the watermark type as buffer.

See Also:

• Constant Field Values

id

public String id

Unique identifier for the watermark, usually generated using UUID.

type

public int type

Type of the watermark: - `WATERMARK_TYPE_IMAGE`: image type. - `WATERMARK_TYPE_BUFFER`: Buffer type.

buffer

public WatermarkBuffer buffer

Buffer containing watermark image data. See `WatermarkBuffer`.

imageUrl

public String imageUrl

URL address used to load the watermark image.

options

public WatermarkOptions options

Options defining the position and size of the watermark. See `WatermarkOptions`.

Constructor Details

WatermarkConfig

public WatermarkConfig()

Method Details

getId

public String getId()

Returns:

When the method call succeeds, it returns the unique ID of the watermark. When it fails, it returns an empty string.

Since:

4.6.0

getType

public int getType()

Returns:

If the method call succeeds, returns the watermark type. - `WATERMARK_TYPE_IMAGE`: Image watermark. - `WATERMARK_TYPE_BUFFER`: Buffer watermark.

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:

When the method call succeeds, it returns the URL of the watermark image. When it fails, it returns an empty string.

Since:

4.6.0

getOptions

public WatermarkOptions getOptions()

Returns:

The `WatermarkOptions` object, if the method call succeeds.

Since:

4.6.0