Agora Recording CPP API Reference
Data Structures | Data Fields
agora::linuxsdk::VideoMixingLayout Struct Reference

#include <IAgoraLinuxSdkCommon.h>

Data Structures

struct  Region
 

Data Fields

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

Detailed Description

The layout setting of the mixed video.

Field Documentation

◆ appData

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

User-defined data.

◆ appDataLength

int agora::linuxsdk::VideoMixingLayout::appDataLength

The length of the user-defined data.

◆ backgroundColor

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

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

◆ canvasHeight

int agora::linuxsdk::VideoMixingLayout::canvasHeight

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

◆ canvasWidth

int agora::linuxsdk::VideoMixingLayout::canvasWidth

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

◆ 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.


The documentation for this struct was generated from the following file: