Agora RTC Objective-C API Reference  Refactor
Data Fields
WatermarkOptions Struct Reference

Data Fields

bool visibleInPreview
 
Rectangle positionInLandscapeMode
 
Rectangle positionInPortraitMode
 
WatermarkRatio watermarkRatio
 
WATERMARK_FIT_MODE mode
 

Detailed Description

The options of the watermark image to be added.

Constructor & Destructor Documentation

◆ WatermarkOptions()

WatermarkOptions ( )
inline

Field Documentation

◆ visibleInPreview

bool visibleInPreview

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

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

◆ positionInLandscapeMode

Rectangle 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 positionInPortraitMode

The watermark position in the portrait mode. See #WATERMARK_FIT_MODE::FIT_MODE_USE_IMAGE_RATIO.

◆ watermarkRatio

WatermarkRatio watermarkRatio

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

◆ mode

The fit mode of watermark.