Agora C++ API Reference for All Platforms
Public Member Functions | Public Attributes | List of all members
agora::rtc::WatermarkOptions Struct Reference

Public Member Functions

 WatermarkOptions ()
 

Public Attributes

bool visibleInPreview
 
Rectangle positionInLandscapeMode
 
Rectangle positionInPortraitMode
 
WatermarkRatio watermarkRatio
 
WATERMARK_FIT_MODE mode
 

Detailed Description

Configurations of the watermark image.

Constructor & Destructor Documentation

◆ WatermarkOptions()

agora::rtc::WatermarkOptions::WatermarkOptions ( )
inline

Member Data Documentation

◆ visibleInPreview

bool agora::rtc::WatermarkOptions::visibleInPreview

Whether or not the watermark image is visible in the local video preview:

  • true: (Default) The watermark image is visible in preview.
  • false: The watermark image is not visible in preview.

◆ positionInLandscapeMode

Rectangle agora::rtc::WatermarkOptions::positionInLandscapeMode

When the adaptation mode of the watermark is FIT_MODE_COVER_POSITION, it is used to set the area of the watermark image in landscape mode. See FIT_MODE_COVER_POSITION for details.

◆ positionInPortraitMode

Rectangle agora::rtc::WatermarkOptions::positionInPortraitMode

When the adaptation mode of the watermark is FIT_MODE_COVER_POSITION, it is used to set the area of the watermark image in portrait mode. See FIT_MODE_COVER_POSITION for details.

◆ watermarkRatio

WatermarkRatio agora::rtc::WatermarkOptions::watermarkRatio

When the watermark adaptation mode is FIT_MODE_USE_IMAGE_RATIO, this parameter is used to set the watermark coordinates. See WatermarkRatio for details.

◆ mode

WATERMARK_FIT_MODE agora::rtc::WatermarkOptions::mode

The adaptation mode of the watermark. See WATERMARK_FIT_MODE for details.