Agora C++ API Reference for All Platforms

Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
agora::rtc::VideoCompositingLayout Struct Reference

`#include <IAgoraRtcEngine.h>`

## Classes
struct | Region

## Public Member Functions
| VideoCompositingLayout ()

## Public Attributes
int | canvasWidth
int | canvasHeight
const char * | backgroundColor
const Region * | regions
int | regionCount
const char * | appData
int | appDataLength

## Constructor & Destructor Documentation

## ◆ VideoCompositingLayout()

agora::rtc::VideoCompositingLayout::VideoCompositingLayout | ( |  | ) |
| inline

## Member Data Documentation

## ◆ canvasWidth

int agora::rtc::VideoCompositingLayout::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 agora::rtc::VideoCompositingLayout::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* agora::rtc::VideoCompositingLayout::backgroundColor

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

## ◆ regions

const Region* agora::rtc::VideoCompositingLayout::regions

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

## ◆ regionCount

int agora::rtc::VideoCompositingLayout::regionCount

Number of users in the channel.

## ◆ appData

const char* agora::rtc::VideoCompositingLayout::appData

User-defined data.

## ◆ appDataLength

int agora::rtc::VideoCompositingLayout::appDataLength

Length of the user-defined data.