Agora RTC Objective-C API Reference Refactor

Properties
WatermarkOptions Class Reference

Inherits <NSObject>.

## Properties
BOOL | visibleInPreview
CGRect | positionInLandscapeMode
CGRect | positionInPortraitMode
int | zOrder

## Detailed Description

Configuration options for setting the watermark image to be added.

## Property Documentation

## ◆ visibleInPreview

- (BOOL) visibleInPreview
| read write nonatomic assign

Whether the watermark is visible in the local preview view:

- `YES`: (Default) The watermark is visible in the local preview view.
- `NO`: The watermark is not visible in the local preview view.

## ◆ positionInLandscapeMode

- (CGRect) positionInLandscapeMode
| read write nonatomic assign

The area to display the watermark image in landscape mode. This parameter contains the following members:

- x: The horizontal position of the watermark relative to the upper left corner.
- y: The vertical position of the watermark relative to the upper left corner.
- width: The width of the watermark area (px).
- height: The height of the watermark area (px).

## ◆ positionInPortraitMode

- (CGRect) positionInPortraitMode
| read write nonatomic assign

The area to display the watermark image in portrait mode. This parameter contains the following members:

- x: The horizontal position of the watermark relative to the upper left corner.
- y: The vertical position of the watermark relative to the upper left corner.
- width: The width of the watermark area (px).
- height: The height of the watermark area (px).

## ◆ zOrder

- (int) zOrder
| read write nonatomic assign

Layer order of the watermark image. The default value is 0.