Public Member Functions | |
VideoCanvas (View view) | |
VideoCanvas (View view, int renderMode, int uid) | |
VideoCanvas (View view, int renderMode, String channelId, int uid) | |
VideoCanvas (View view, int renderMode, int uid, int mirrorMode) | |
VideoCanvas (View view, int renderMode, String channelId, int uid, int mirrorMode) | |
Public Attributes | |
View | view |
int | renderMode |
String | channelId |
int | mirrorMode |
int | uid |
Static Public Attributes | |
static final int | RENDER_MODE_HIDDEN = 1 |
static final int | RENDER_MODE_FIT = 2 |
static final int | RENDER_MODE_ADAPTIVE = 3 |
static final int | RENDER_MODE_FILL = 4 |
Properties of the video display window.
|
static |
1: Uniformly scale the video until it fills the visible boundaries. One dimension of the video may have clipped contents.
|
static |
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 are filled with black.
|
static |
|
static |
4: The fill mode. In this mode, the SDK stretches or zooms the video to fill the display window.
View io.agora.rtc.video.VideoCanvas.view |
The view used to display the video. The following objects are supported:
SurfaceView
created by the CreateRendererView
method.TextureView
created by the CreateTextureView
method.TextureView
. int io.agora.rtc.video.VideoCanvas.renderMode |
The rendering mode of the video view:
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 are filled with black.RENDER_MODE_ADAPTIVE(3)
: This mode is deprecated and Agora does not recommend using it.RENDER_MODE_FILL(4)
: The fill mode. In this mode, the SDK stretches or zooms the video to fill the display window. String io.agora.rtc.video.VideoCanvas.channelId |
The unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:
joinChannel
method in the RtcEngine class. The VideoCanvas struct defines the video canvas of the user in the channel.joinChannel
method in the RtcChannel class, set this parameter as the channelId of the RtcChannel object. The VideoCanvas struct defines the video canvas of the user in the channel with the specified channel ID. int io.agora.rtc.video.VideoCanvas.mirrorMode |
The video mirror mode:
int io.agora.rtc.video.VideoCanvas.uid |
User ID.