Public Attributes

const char * wm_litera
 
const char * font_file_path
 
uint32_t font_size
 
uint32_t offset_x
 
uint32_t offset_y
 
uint32_t wm_width
 
uint32_t wm_height
 

Detailed Description

The configuration of the text watermark.

Member Data Documentation

◆ wm_litera

const char* agora::linuxsdk::LiteraWatermarkConfig::wm_litera

The watermark text in the string format.

Note
  • The supported characters depend on the font. The default font is NotoSansMonoCJKsc-Regular. See the font introduction. To change the font, you can also set the font_file_path parameter to specify the path of the font file.
  • Supports word wrap. The text will wrap to next line when it exceeds the watermark rectangle.
  • Supports line breaks.
  • There is no limit on the string length. The display of the text on the watermark rectangle is influenced by the font size and the size of the watermark rectangle. The part that exceeds the rectangle will not be displayed.

◆ font_file_path

const char* agora::linuxsdk::LiteraWatermarkConfig::font_file_path

The path of the font file. If not specified, use the default font NotoSansMonoCJKsc-Regular.

Note
Supports font files in the formats such as ttf and otf.

◆ font_size

uint32_t agora::linuxsdk::LiteraWatermarkConfig::font_size

The font size. The default value is 10, which equals to 10 x 15 points at 144 dpi.

◆ offset_x

uint32_t agora::linuxsdk::LiteraWatermarkConfig::offset_x

The horizontal shift (pixel) of the rectangle containing the watermark from the left border of the canvas. The default value is 0.

◆ offset_y

uint32_t agora::linuxsdk::LiteraWatermarkConfig::offset_y

The vertical shift (pixel) of the rectangle containing the watermark from the top border of the canvas. The default value is 0.

◆ wm_width

uint32_t agora::linuxsdk::LiteraWatermarkConfig::wm_width

The width (pixel) of the rectangle containing the watermark. The default value is 0.

◆ wm_height

uint32_t agora::linuxsdk::LiteraWatermarkConfig::wm_height

The height (pixel) of the rectangle containing the watermark. The default value is 0.