Agora C++ API Reference for All Platforms

Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
agora::rtc::WatermarkOptions Struct Reference

`#include <AgoraBase.h>`

## Public Member Functions
| WatermarkOptions ()

## Public Attributes
bool | visibleInPreview
Rectangle | positionInLandscapeMode
Rectangle | positionInPortraitMode
WatermarkRatio | watermarkRatio
WATERMARK_FIT_MODE | mode
int | zOrder

## Detailed Description

Configuration options for setting the watermark image to be added.

## Constructor & Destructor Documentation

## ◆ WatermarkOptions()

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

## Member Data Documentation

## ◆ visibleInPreview

bool agora::rtc::WatermarkOptions::visibleInPreview

Whether the watermark is visible in the local preview view:

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

## ◆ 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 `Rectangle`.

## ◆ 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 `Rectangle`.

## ◆ 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`.

## ◆ mode

WATERMARK_FIT_MODE agora::rtc::WatermarkOptions::mode

The adaptation mode of the watermark. See `WATERMARK_FIT_MODE`.

## ◆ zOrder

int agora::rtc::WatermarkOptions::zOrder

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