Public Member Functions

 LiteraWatermarkConfig ()
 

Public Attributes

String wmLitera = ""
 
String fontFilePath = ""
 
int fontSize = 10
 
int offsetX = 0
 
int offsetY = 0
 
int wmWidth = 0
 
int wmHeight = 0
 

Detailed Description

The configuration of the text watermark.

Constructor & Destructor Documentation

◆ LiteraWatermarkConfig()

io.agora.recording.common.Common.LiteraWatermarkConfig.LiteraWatermarkConfig ( )

Member Data Documentation

◆ wmLitera

String io.agora.recording.common.Common.LiteraWatermarkConfig.wmLitera = ""

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.

◆ fontFilePath

String io.agora.recording.common.Common.LiteraWatermarkConfig.fontFilePath = ""

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.

◆ fontSize

int io.agora.recording.common.Common.LiteraWatermarkConfig.fontSize = 10

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

◆ offsetX

int io.agora.recording.common.Common.LiteraWatermarkConfig.offsetX = 0

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

◆ offsetY

int io.agora.recording.common.Common.LiteraWatermarkConfig.offsetY = 0

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

◆ wmWidth

int io.agora.recording.common.Common.LiteraWatermarkConfig.wmWidth = 0

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

◆ wmHeight

int io.agora.recording.common.Common.LiteraWatermarkConfig.wmHeight = 0

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