Agora RTC Objective-C API Reference  Refactor
Data Structures | Data Fields
VideoCompositingLayout Struct Reference

Data Structures

struct  Region
 

Data Fields

int canvasWidth
 
int canvasHeight
 
const char * backgroundColor
 
const Regionregions
 
int regionCount
 
const char * appData
 
int appDataLength
 

Constructor & Destructor Documentation

◆ VideoCompositingLayout()

Field Documentation

◆ canvasWidth

int canvasWidth

Ignore this parameter. The width of the canvas is set by agora::rtc::IRtcEngine::configPublisher, and not by agora::rtc::VideoCompositingLayout::canvasWidth.

◆ canvasHeight

int canvasHeight

Ignore this parameter. The height of the canvas is set by agora::rtc::IRtcEngine::configPublisher, and not by agora::rtc::VideoCompositingLayout::canvasHeight.

◆ backgroundColor

const char* backgroundColor

Enter any of the 6-digit symbols defined in RGB.

◆ regions

const Region* regions

Region array. Each host in the channel can have a region to display the video on the screen.

◆ regionCount

int regionCount

Number of users in the channel.

◆ appData

const char* appData

User-defined data.

◆ appDataLength

int appDataLength

Length of the user-defined data.