Agora Objective-C API Reference for iOS/macOS

AgoraRtcVideoCompositingLayout Class Reference

Inherits from NSObject
Declared in AgoraObjects.h

Overview

Rtc video compositing layout.

DEPRECATED

  canvasWidth

Please ignore this property.

@property (assign, nonatomic) NSInteger canvasWidth

Discussion

Width of the entire canvas (display window or screen).

Declared In

AgoraObjects.h

  canvasHeight

Please ignore this property.

@property (assign, nonatomic) NSInteger canvasHeight

Discussion

Height of the entire canvas (display window or screen).

Declared In

AgoraObjects.h

  backgroundColor

The background color in RGB hex value. Value only, do not include a #.

@property (copy, nonatomic) NSString *backgroundColor

Declared In

AgoraObjects.h

  regions

Screen display region information.

@property (copy, nonatomic) NSArray<AgoraRtcVideoCompositingRegion*> *regions

Discussion

Sets the screen display region of a host or a delegated host in a CDN live stream. See AgoraRtcVideoCompositingRegion.

Declared In

AgoraObjects.h

  appData

App defined data. Maximum size of 2048 bytes.

@property (copy, nonatomic) NSString *appData

Declared In

AgoraObjects.h

Is this page helpful?