Documentation
Video Call
Agora.io Community
English
search-icon
Agora C++ API Reference for All Platforms
Index IRtcEngine RtcEngineParameters IRtcEngineEventHandler Warning Codes Error Codes

#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
 

Detailed Description

Deprecated:
RTC video compositing layout.

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 configPublisher, not by canvasWidth.

◆ canvasHeight

int agora::rtc::VideoCompositingLayout::canvasHeight

Ignore this parameter. The height of the canvas is set by configPublisher, not by canvasWidth.

◆ backgroundColor

const char* agora::rtc::VideoCompositingLayout::backgroundColor

RGB hex color value.

Note
Value only, do not include a #. For example, C0C0C0.

◆ regions

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

Screen display region information.

Sets the screen display region of a host or a delegated host in CDN live streaming. See Region for more information.

◆ regionCount

int agora::rtc::VideoCompositingLayout::regionCount

Number of the screen display regions.

◆ appData

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

Application-defined data. Supports a maximum of 2048 bytes.

◆ appDataLength

int agora::rtc::VideoCompositingLayout::appDataLength

Length of the user-defined application data.