Developer Center
Interactive Live Streaming Premium
API Reference
Agora Java API Reference for Android
Agora Java API Reference for Android
- Deprecated:
- The display region of the host in the entire screen.
◆ renderMode()
Region io.agora.rtc.video.VideoCompositingLayout.Region.renderMode |
( |
int |
mode | ) |
|
This parameter does not work, please neglect it.
◆ uid
int io.agora.rtc.video.VideoCompositingLayout.Region.uid |
ID of the user whose video will be displayed on the screen.
double io.agora.rtc.video.VideoCompositingLayout.Region.x |
Horizontal position of the region on the screen. The value ranges between 0.0 and 1.0.
double io.agora.rtc.video.VideoCompositingLayout.Region.y |
Vertical position of the region on the screen. The value ranges between 0.0 and 1.0.
◆ width
double io.agora.rtc.video.VideoCompositingLayout.Region.width |
Actual width of the region. The value ranges between 0.0 and 1.0. For example, if the width of the screen is 360, and the width of the region is 120, set the width value as 0.33.
◆ height
double io.agora.rtc.video.VideoCompositingLayout.Region.height |
Actual height of the region. The value ranges between 0.0 and 1.0. For example, if the height of the screen is 240, and the height of the region is 120, set the height value as 0.5.
◆ zOrder
int io.agora.rtc.video.VideoCompositingLayout.Region.zOrder |
Layer position of the region. The value ranges between 0 and 100:
-
0: The region is at the bottom layer.
-
100: The region is at the top layer.
◆ alpha
double io.agora.rtc.video.VideoCompositingLayout.Region.alpha |
Transparency of the region. The value ranges between 0.0 and 1.0:
-
0.0: The region is transparent.
-
1.0: (Default) The region is opaque.
◆ renderMode
int io.agora.rtc.video.VideoCompositingLayout.Region.renderMode |
Video display mode:
-
RENDER_MODE_HIDDEN(1): Uniformly scale the video until it fills the visible boundaries. One dimension of the video may have clipped contents.
-
RENDER_MODE_FIT(2): Uniformly scale the video until one of its dimension fits the boundary. Areas that are not filled due to the disparity in the aspect ratio will be filled with black.
-
RENDER_MODE_ADAPTIVE(3): This mode is deprecated and Agora does not recommend using it.