Agora Java API Reference for Android
Public Attributes | List of all members
agora::rtc::WatermarkConfig Struct Reference

Defines the configuration for a watermark. 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

Defines the configuration for a watermark.

Since
4.6.0

Member Data Documentation

◆ id

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

The unique identifier of the watermark. It is recommended to use a UUID.

◆ type

WATERMARK_SOURCE_TYPE agora::rtc::WatermarkConfig::type

The watermark source type. See #WATERMARK_SOURCE_TYPE for details.

◆ buffer

WatermarkBuffer agora::rtc::WatermarkConfig::buffer

The watermark buffer. 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

The URL of the image file for the watermark. The default value is NULL.

Note
If used asynchronously, copy the URL to memory that will not be released.

◆ options

WatermarkOptions agora::rtc::WatermarkConfig::options

The options of the watermark. See WatermarkOptions.