Public Attributes

const char * image_path
 
uint32_t offset_x
 
uint32_t offset_y
 
uint32_t wm_width
 
uint32_t wm_height
 

Detailed Description

The configuration of the image watermark.

Member Data Documentation

◆ image_path

const char* agora::linuxsdk::ImageWatermarkConfig::image_path

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.

◆ offset_x

uint32_t agora::linuxsdk::ImageWatermarkConfig::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::ImageWatermarkConfig::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::ImageWatermarkConfig::wm_width

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

◆ wm_height

uint32_t agora::linuxsdk::ImageWatermarkConfig::wm_height

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