AgoraImage Class Reference

Inherits from	NSObject
Declared in	AgoraObjects.h

Overview

Image properties.

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

`url`

URL address of the image on the broadcasting video.

@property (strong, nonatomic) NSURL *url

Discussion

The maximum length of this parameter is 1024 bytes.

Declared In

AgoraObjects.h

`rect`

Position and size of the image on the broadcasting video in CGRect.

@property (assign, nonatomic) CGRect rect

Declared In

AgoraObjects.h

`zOrder`

The layer number of the watermark or background image.

@property (assign, nonatomic) NSInteger zOrder

Availability

v3.6.0

Discussion

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.

Declared In

AgoraObjects.h

`alpha`

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

@property (assign, nonatomic) double alpha

Availability

v3.6.0

Discussion

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

Declared In

AgoraObjects.h