Agora RTC Objective-C API Reference  Refactor
Data Fields
RtcImage Struct Reference

Data Fields

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

Detailed Description

Image properties.

Constructor & Destructor Documentation

◆ RtcImage()

RtcImage ( )
inline

Field Documentation

◆ url

const char* url

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

◆ x

int x

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

◆ y

int y

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

◆ width

int width

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

◆ height

int height

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

◆ zOrder

int 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 alpha

The transparency level of the image. The value ranges between 0.0 and 1.0:

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