Agora C++ API Reference for All Platforms

Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
agora::rtc::WatermarkConfig Struct Reference

`#include <AgoraBase.h>`

## Public Member Functions
| WatermarkConfig ()

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

## Detailed Description

Since
  4.6.0

## Constructor & Destructor Documentation

## ◆ WatermarkConfig()

agora::rtc::WatermarkConfig::WatermarkConfig | ( |  | ) |
| inline

## 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.

## ◆ [union]

union { ... } agora::rtc::WatermarkConfig

## ◆ options

WatermarkOptions agora::rtc::WatermarkConfig::options

Options for the watermark. See `WatermarkOptions`.