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

#include <AgoraBase.h>

Public Member Functions

 WatermarkTimestamp ()
 

Public Attributes

int fontSize
 
const char * fontFilePath
 
int strokeWidth
 
const char * format
 

Detailed Description

Since
4.6.0
Note
This is only supported in linux platform.

Constructor & Destructor Documentation

◆ WatermarkTimestamp()

agora::rtc::WatermarkTimestamp::WatermarkTimestamp ( )
inline

Member Data Documentation

◆ fontSize

int agora::rtc::WatermarkTimestamp::fontSize

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

◆ fontFilePath

const char* agora::rtc::WatermarkTimestamp::fontFilePath

The path of the font file for the timestamp. 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 path to memory that will not be released.

◆ strokeWidth

int agora::rtc::WatermarkTimestamp::strokeWidth

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

◆ format

const char* agora::rtc::WatermarkTimestamp::format

The format of the timestamp. The default is 'F X'. The format follows the standard C library function strftime. You can find in the website: https://cplusplus.com/reference/ctime/strftime/?kw=strftime

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