agora::rtc::WatermarkConfig Struct Reference

Used to configure watermark-related information. More...

#include <AgoraBase.h>

Public Attributes
const char *	id
WATERMARK_SOURCE_TYPE	type
union {
WatermarkBuffer   buffer
WatermarkTimestamp   timestamp
WatermarkLiteral   literal
const char *   imageUrl
};
WatermarkOptions	options

Detailed Description

Used to configure watermark-related information.

Since

4.6.0

Member Data Documentation

id

const char* agora::rtc::WatermarkConfig::id

Unique identifier for the watermark. It is recommended to use a UUID.

type

WATERMARK_SOURCE_TYPE agora::rtc::WatermarkConfig::type

Type of the watermark. See WATERMARK_SOURCE_TYPE.

buffer

WatermarkBuffer agora::rtc::WatermarkConfig::buffer

Buffer of the watermark. See WatermarkBuffer.

timestamp

WatermarkTimestamp agora::rtc::WatermarkConfig::timestamp

The watermark timestamp. See WatermarkTimestamp.

Note

This is only supported in linux platform.

literal

WatermarkLiteral agora::rtc::WatermarkConfig::literal

The watermark literal. See WatermarkLiteral.

Note

This is only supported in linux platform.

imageUrl

const char* agora::rtc::WatermarkConfig::imageUrl

URL of the watermark image file. Default value is NULL.

options

WatermarkOptions agora::rtc::WatermarkConfig::options

Options for the watermark. See WatermarkOptions.