Dev Center
On-premise Recording
Agora On-Premise Recording SDK Java API Reference
Public Member Functions | |
| Region () | |
Public Attributes | |
| long | uid = 0 |
| double | x = 0 |
| double | y = 0 |
| double | width = 0 |
| double | height = 0 |
| double | alpha = 1.0 |
| int | renderMode = 0 |
Detailed Description
Defines the parameters of the region.
Constructor & Destructor Documentation
◆ Region()
| io.agora.recording.common.Common.VideoMixingLayout.Region.Region | ( | ) |
Member Data Documentation
◆ uid
| long io.agora.recording.common.Common.VideoMixingLayout.Region.uid = 0 |
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 = 0 |
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 = 0 |
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 = 0 |
Relative width of the region. The value is between 0.0 and 1.0.
◆ height
| double io.agora.recording.common.Common.VideoMixingLayout.Region.height = 0 |
Relative height of the region. The value is between 0.0 and 1.0.
◆ alpha
| double io.agora.recording.common.Common.VideoMixingLayout.Region.alpha = 1.0 |
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 = 0 |
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.
