Agora C++ API Reference for All Platforms
Loading...
Searching...
No Matches
agora::rtc::WatermarkLiteral Struct Reference

#include <AgoraBase.h>

Public Member Functions

 WatermarkLiteral ()
 

Public Attributes

int fontSize
 
int strokeWidth
 
const char * wmLiteral
 
const char * fontFilePath
 

Detailed Description

Since
4.6.0
Note
This is only supported in linux platform..

Constructor & Destructor Documentation

◆ WatermarkLiteral()

agora::rtc::WatermarkLiteral::WatermarkLiteral ( )
inline

Member Data Documentation

◆ fontSize

int agora::rtc::WatermarkLiteral::fontSize

The font size of the literal. The default value is 10.

◆ strokeWidth

int agora::rtc::WatermarkLiteral::strokeWidth

The stroke width of the literal. The default value is 1.

◆ wmLiteral

const char* agora::rtc::WatermarkLiteral::wmLiteral

The literal content of the watermark. The default value is NULL.

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

◆ fontFilePath

const char* agora::rtc::WatermarkLiteral::fontFilePath

The path of the font file for the literal. The default value is NULL. The font file should be a .ttf file. If not set, the SDK uses the system default font if available.

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