io.agora.rtc2.video.AgoraImage Class Reference

Image properties. More...

Public Member Functions
	AgoraImage (String url)

Public Attributes
String	url
int	x
int	y
int	width
int	height
int	zOrder
double	alpha

Detailed Description

Image properties.

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

Member Data Documentation

url

String io.agora.rtc2.video.AgoraImage.url

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

x

int io.agora.rtc2.video.AgoraImage.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 io.agora.rtc2.video.AgoraImage.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 io.agora.rtc2.video.AgoraImage.width

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

height

int io.agora.rtc2.video.AgoraImage.height

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

zOrder

int io.agora.rtc2.video.AgoraImage.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 io.agora.rtc2.video.AgoraImage.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.