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

#include <IAgoraLinuxSdkCommon.h>

Data Fields

uid_t uid
 
double x
 
double y
 
double width
 
double height
 
double alpha
 
int renderMode
 

Detailed Description

The setting of the region.

Field Documentation

◆ alpha

double agora::linuxsdk::VideoMixingLayout::Region::alpha

The transparency of the image. The value is between 0.0 (transparent) and 1.0 (opaque).

Note
This parameter is reserved for future use.

◆ height

double agora::linuxsdk::VideoMixingLayout::Region::height

Relative height of the region. The value is between 0.0 and 1.0.

◆ renderMode

int agora::linuxsdk::VideoMixingLayout::Region::renderMode

Render mode.

  • RENDER_MODE_HIDDEN(1): Cropped mode. Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
  • RENDER_MODE_FIT(2): Fit mode. Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio will be filled with black.

◆ uid

uid_t agora::linuxsdk::VideoMixingLayout::Region::uid

UID of the user (communication mode)/host (live broadcast mode) displaying the video in the region.

◆ width

double agora::linuxsdk::VideoMixingLayout::Region::width

Relative width of the region. The value is between 0.0 and 1.0.

◆ x

double agora::linuxsdk::VideoMixingLayout::Region::x

Relative horizontal position of the top-left corner of the region. The value is between 0.0 and 1.0.

◆ y

double agora::linuxsdk::VideoMixingLayout::Region::y

Relative vertical position of the top-left corner of the region. The value is between 0.0 and 1.0.


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