Public Member Functions

 ImageWatermarkConfig ()
 

Public Attributes

String imagePath = ""
 
int offsetX = 0
 
int offsetY = 0
 
int wmWidth = 0
 
int wmHeight = 0
 

Detailed Description

The configuration of the image watermark.

Constructor & Destructor Documentation

◆ ImageWatermarkConfig()

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

Member Data Documentation

◆ imagePath

String io.agora.recording.common.Common.ImageWatermarkConfig.imagePath = ""

The path of the image file.

Note
  • Only supports local PNG images.
  • The resolution of the image should not exceed 480p.
  • If the image is smaller than the watermark rectangle, the SDK centers the image and does not stretch the image; if the image is larger than the watermark rectangle, the SDK scales down the image and then centers the image in the watermark rectangle.

◆ offsetX

int io.agora.recording.common.Common.ImageWatermarkConfig.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.ImageWatermarkConfig.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.ImageWatermarkConfig.wmWidth = 0

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

◆ wmHeight

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

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