struct  Region

Public Member Functions

 VideoMixingLayout ()

Public Attributes

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

Detailed Description

The layout setting of the videos in composite recording mode.

Constructor & Destructor Documentation

◆ VideoMixingLayout()

agora::linuxsdk::VideoMixingLayout::VideoMixingLayout ( )

Member Data Documentation

◆ canvasWidth

int agora::linuxsdk::VideoMixingLayout::canvasWidth

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

◆ canvasHeight

int agora::linuxsdk::VideoMixingLayout::canvasHeight

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

◆ backgroundColor

const char* agora::linuxsdk::VideoMixingLayout::backgroundColor

The background color of the canvas (the display window or screen) in RGB hex value.

If you set the defaultVideoBg parameter in Recordingconfig when calling the joinChannel method, the backgroundColor parameter does not take effect.

◆ regionCount

uint32_t agora::linuxsdk::VideoMixingLayout::regionCount

The number of the users (communication mode)/hosts (live broadcast mode) in the channel.

◆ regions

const Region* agora::linuxsdk::VideoMixingLayout::regions

The user (communication mode)/host (live broadcast mode) list of VideoMixingLayout. Each user (communication mode)/host (live broadcast mode) in the channel has a region to display the video on the screen with the following parameters to be set. See Region to set parameters.

◆ appData

const char* agora::linuxsdk::VideoMixingLayout::appData

User-defined data.

◆ appDataLength

int agora::linuxsdk::VideoMixingLayout::appDataLength

The length of the user-defined data.