AgoraRtcVideoCompositingRegion Class Reference

Inherits from NSObject
Declared in AgoraObjects.h

Overview

Defines the region to show the video on the screen for each host in the channel.

DEPRECATED

  uid

ID of the user whose video is displayed on the screen.

@property (assign, nonatomic) NSUInteger uid

Declared In

AgoraObjects.h

  x

Horizontal position of the region on the screen. The value ranges between 0.0 and 1.0.

@property (assign, nonatomic) CGFloat x

Declared In

AgoraObjects.h

  y

Vertical position of the region on the screen. The value ranges between 0.0 and 1.0.

@property (assign, nonatomic) CGFloat y

Declared In

AgoraObjects.h

  width

Actual width of the region. The value ranges between 0.0 and 1.0. For example, if the width of the screen is 360, and the width of the region is 120, set the value as 0.33.

@property (assign, nonatomic) CGFloat width

Declared In

AgoraObjects.h

  height

Actual height of the region. The value ranges between 0.0 and 1.0. For example, if the height of the screen is 240, and the height of the region is 120, set the value as 0.5.

@property (assign, nonatomic) CGFloat height

Declared In

AgoraObjects.h

  zOrder

Layer position of the region. The value ranges between 0 and 100:

@property (assign, nonatomic) NSInteger zOrder

Discussion

  • 0: The region is at the bottom layer.
  • 100: The region is at the top layer.

From v2.3.0, the Agora SDK supports setting zOrder as 0.

Declared In

AgoraObjects.h

  alpha

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

@property (assign, nonatomic) CGFloat alpha

Discussion

  • 0: The region is transparent.
  • 1: (Default) The region is opaque.

Declared In

AgoraObjects.h

  renderMode

Please ignore this property. Setting this property will not take effect.

@property (assign, nonatomic) AgoraVideoRenderMode renderMode

Declared In

AgoraObjects.h