Documentation
On-premise Recording
Agora.io Community
English
search-icon
Agora Recording C++ API Reference
Index IRecordingEngine IRecordingEngineEventHandler Warning Codes Error Codes

Public Member Functions

 Region ()
 

Public Attributes

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

Detailed Description

The setting of the region.

Constructor & Destructor Documentation

◆ Region()

agora::linuxsdk::VideoMixingLayout::Region::Region ( )
inline

Member Data Documentation

◆ uid

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

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

◆ x

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

The 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

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

◆ width

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

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

◆ height

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

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

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

◆ renderMode

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

Render mode.

  • RENDER_MODE_HIDDEN(0): (Default) 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(1): 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.
score