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

Configurations of the watermark image.

## Constructor & Destructor Documentation

## ◆ WatermarkOptions()

WatermarkOptions | ( |  | ) |
| inline

## Field Documentation

## ◆ visibleInPreview

bool 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 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 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 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 mode

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