Agora C++ API Reference for All Platforms
agora::rtc::WatermarkOptions Struct Reference

#include <IAgoraRtcEngine.h>

Public Member Functions

 WatermarkOptions ()
 

Public Attributes

bool visibleInPreview
 
Rectangle positionInLandscapeMode
 
Rectangle positionInPortraitMode
 

Detailed Description

The options of the watermark image to be added.

Constructor & Destructor Documentation

◆ WatermarkOptions()

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

Member Data Documentation

◆ visibleInPreview

bool agora::rtc::WatermarkOptions::visibleInPreview

Sets 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

The watermark position in the landscape mode. See Rectangle. For detailed information on the landscape mode, see the advanced guide Video Rotation.

◆ positionInPortraitMode

Rectangle agora::rtc::WatermarkOptions::positionInPortraitMode

The watermark position in the portrait mode. See Rectangle. For detailed information on the portrait mode, see the advanced guide Video Rotation.