Agora C++ API Reference for All Platforms

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

`#include <AgoraBase.h>`

## Public Member Functions
| RtcImage ()

## Public Attributes
const char * | url
int | x
int | y
int | width
int | height
int | zOrder
double | alpha

## Detailed Description

This class sets the properties of the watermark and background images in the live video.

## Constructor & Destructor Documentation

## ◆ RtcImage()

agora::rtc::RtcImage::RtcImage | ( |  | ) |
| inline

## Member Data Documentation

## ◆ url

const char* agora::rtc::RtcImage::url

The HTTP/HTTPS URL address of the image in the live video. The maximum length of this parameter is 1024 bytes.

## ◆ x

int agora::rtc::RtcImage::x

The x-coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin).

## ◆ y

int agora::rtc::RtcImage::y

The y-coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin).

## ◆ width

int agora::rtc::RtcImage::width

The width (px) of the image on the video frame.

## ◆ height

int agora::rtc::RtcImage::height

The height (px) of the image on the video frame.

## ◆ zOrder

int agora::rtc::RtcImage::zOrder

The layer index of the watermark or background image. When you use the watermark array to add a watermark or multiple watermarks, you must pass a value to `zOrder` in the range [1,255]; otherwise, the SDK reports an error. In other cases, `zOrder` can optionally be passed in the range [0,255], with 0 being the default value. 0 means the bottom layer and 255 means the top layer.

## ◆ alpha

double agora::rtc::RtcImage::alpha

The transparency of the watermark or background image. The range of the value is [0.0,1.0]:

- 0.0: Completely transparent.
- 1.0: (Default) Opaque.