Public Attributes
String	url

int	x

int	y

int	width

int	height

int	zOrder

double	alpha

Detailed Description

Agora image properties.

A class for setting the properties of the watermark and background images.

Member Data Documentation

◆ url

String io.agora.rtc.video.AgoraImage.url

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

◆ x

int io.agora.rtc.video.AgoraImage.x

Position of the image on the upper left of the video on the horizontal axis.

◆ y

int io.agora.rtc.video.AgoraImage.y

Position of the image on the upper left of the video on the vertical axis.

◆ width

int io.agora.rtc.video.AgoraImage.width

Width of the image on the video.

◆ height

int io.agora.rtc.video.AgoraImage.height

Height of the image on the video.

◆ zOrder

int io.agora.rtc.video.AgoraImage.zOrder

The layer number of the watermark or background image.

When you use addWatermark 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 io.agora.rtc.video.AgoraImage.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

Public Attributes