Agora Recording Java API Reference
Public Attributes | List of all members
io.agora.recording.common.Common.VideoMixingLayout.Region Class Reference

Public Attributes

long uid
 
double x
 
double y
 
double width
 
double height
 
int zOrder
 
double alpha
 
int renderMode
 

Detailed Description

The parameters of region.

Member Data Documentation

◆ uid

long io.agora.recording.common.Common.VideoMixingLayout.Region.uid

User IDs of the users (communication mode) or host (live broadcast mode) displaying the video in the region.

◆ x

double io.agora.recording.common.Common.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 io.agora.recording.common.Common.VideoMixingLayout.Region.y

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

◆ width

double io.agora.recording.common.Common.VideoMixingLayout.Region.width

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

◆ height

double io.agora.recording.common.Common.VideoMixingLayout.Region.height

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

◆ zOrder

int io.agora.recording.common.Common.VideoMixingLayout.Region.zOrder

The index of the layer. The value is between 1 (bottom layer) and 100 (top layer).

Note
This parameter is reserved for future use.

◆ alpha

double io.agora.recording.common.Common.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 io.agora.recording.common.Common.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.