agora::rtc::RtcImage Struct Reference

#include <IAgoraRtcEngine.h>

Public Member Functions
	RtcImage ()

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

Detailed Description

Image properties.

The properties of the watermark and background images.

Constructor & Destructor Documentation

RtcImage()

agora::rtc::RtcImage::RtcImage ( )

inline

Member Data Documentation

url

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

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

x

int agora::rtc::RtcImage::x

Horizontal position of the image from the upper left of the live video.

y

int agora::rtc::RtcImage::y

Vertical position of the image from the upper left of the live video.

width

int agora::rtc::RtcImage::width

Width of the image on the live video.

height

int agora::rtc::RtcImage::height

Height of the image on the live video.

zOrder

int agora::rtc::RtcImage::zOrder

The layer number 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.

Since

v3.6.0

alpha

double agora::rtc::RtcImage::alpha

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

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

Since

v3.6.0