On-premise Recording SDK v3.0.6 API Reference for Linux (C++)
Classes | Public Member Functions | Public Attributes | List of all members
agora::linuxsdk::VideoMixingLayout Struct Reference


struct   Region

Public Member Functions

  VideoMixingLayout ()

Public Attributes

int  canvasWidth
int  canvasHeight
const char *  backgroundColor
uint32_t  regionCount
const Region regions
const char *  appData
int  appDataLength
bool  keepLastFrame
uint32_t  wm_num
WatermarkConfig wm_configs

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

The width of the canvas (the display window or screen).

◆ canvasHeight

int agora::linuxsdk::VideoMixingLayout::canvasHeight

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

◆ keepLastFrame

bool agora::linuxsdk::VideoMixingLayout::keepLastFrame

Sets whether or not to show the last frame of a user in the region after the user leaves the channel:

  • true: The user's last frame shows in the region.
  • false: (Default) The user's last frame does not show in the region.

◆ wm_num

uint32_t agora::linuxsdk::VideoMixingLayout::wm_num

Sets the number of watermarks that you want to add to the video.

You can add up to 15 watermarks, including one timestamp watermark, four image watermarks, and ten text watermarks.

◆ wm_configs

WatermarkConfig* agora::linuxsdk::VideoMixingLayout::wm_configs

The configuration of the watermarks. Pointer to an array of WatermarkConfig.