io.agora.rtc2.video

Class VideoCanvas

java.lang.Object

io.agora.rtc2.video.VideoCanvas

public class VideoCanvas
extends java.lang.Object

The VideoCanvas class.

Field Summary

Fields

Modifier and Type	Field and Description
int	backgroundColor A RGBA value indicates background color of the render view.
int	mediaPlayerId The media player id of AgoraMediaPlayer.
int	mirrorMode The video mirror mode: - `VIDEO_MIRROR_MODE_AUTO(0)`: (Default) The mirror mode determined by the SDK.
Rect	rect If you want to display a certain part of a video frame, you can set this value to crop the video frame to show.
static int	RENDER_MODE_ADAPTIVE 3: This mode is deprecated and Agora does not recommend using it.
static int	RENDER_MODE_FIT 2: Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit).
static int	RENDER_MODE_HIDDEN 1: Uniformly scale the video until it fills the visible boundaries (cropped).
int	renderMode The video render mode: - `RENDER_MODE_HIDDEN(1)`: (Default)Uniformly scale the video until it fills the visible boundaries (cropped).
int	rotation The clockwise rotation information.
int	setupMode The mode of setting up video view.
int	sourceType The video source type.
SurfaceTexture	surfaceTexture Set surfaceTexture makes Agora SDK as a video content provider, like Camera.
int	uid The user id of local video.
View	view Video display window.
static int	VIEW_SETUP_MODE_ADD
static int	VIEW_SETUP_MODE_REMOVE
static int	VIEW_SETUP_MODE_REPLACE

Constructor Summary

Constructors

Constructor and Description
VideoCanvas(View view)
VideoCanvas(View view, int renderMode)
VideoCanvas(View view, int renderMode, int uid)
VideoCanvas(View view, int renderMode, int mirrorMode, int uid)

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RENDER_MODE_HIDDEN

public static final int RENDER_MODE_HIDDEN

1: Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.

See Also:

Constant Field Values

RENDER_MODE_FIT

public static final int RENDER_MODE_FIT

2: 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 are filled with black.

See Also:

Constant Field Values

RENDER_MODE_ADAPTIVE

public static final int RENDER_MODE_ADAPTIVE

3: This mode is deprecated and Agora does not recommend using it.

See Also:

Constant Field Values

VIEW_SETUP_MODE_REPLACE

public static final int VIEW_SETUP_MODE_REPLACE

See Also:

Constant Field Values

VIEW_SETUP_MODE_ADD

public static final int VIEW_SETUP_MODE_ADD

See Also:

Constant Field Values

VIEW_SETUP_MODE_REMOVE

public static final int VIEW_SETUP_MODE_REMOVE

See Also:

Constant Field Values

view

public View view

Video display window. Must be SurfaceView or TextureView.

surfaceTexture

public SurfaceTexture surfaceTexture

Set surfaceTexture makes Agora SDK as a video content provider, like Camera. While set view Agora SDK consumes video content using view. You need draw texture on OpenGL context youself. You may set view or surfaceTexture, BUT DO NOT BOTH in one VideoCanvas, otherwise result is UNDEFINED.

uid

public int uid

The user id of local video.

renderMode

public int renderMode

The video render mode: - `RENDER_MODE_HIDDEN(1)`: (Default)Uniformly scale the video until it fills the visible boundaries (cropped). 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 (zoomed to fit). 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.

rotation

public int rotation

The clockwise rotation information. You can set it as 0, 90, 180 or 270.

mirrorMode

public int mirrorMode

The video mirror mode: - `VIDEO_MIRROR_MODE_AUTO(0)`: (Default) The mirror mode determined by the SDK. If you use the front camera, the SDK enables the mirror mode; if you use the rear camera, the SDK disables the mirror mode. - `VIDEO_MIRROR_MODE_ENABLED(1)`: Enable the mirror mode. - `VIDEO_MIRROR_MODE_DISABLED(2)`: Disable the mirror mode.

setupMode

public int setupMode

The mode of setting up video view. The default value is VIEW_SETUP_MODE_REPLAC.

sourceType

public int sourceType

The video source type. The default value is VIDEO_SOURCE_CAMERA_PRIMARY.

mediaPlayerId

public int mediaPlayerId

The media player id of AgoraMediaPlayer. It should set this parameter when the sourceType is VIDEO_SOURCE_MEDIA_PLAYER to show the video that AgoraMediaPlayer is playing. You can get this value by calling the method \ref getMediaPlayerId().

rect

public Rect rect

If you want to display a certain part of a video frame, you can set this value to crop the video frame to show. The default value is empty(that is, if it has zero width or height), which means no cropping.

backgroundColor

public int backgroundColor

A RGBA value indicates background color of the render view. Defaults to 0x00000000.

Constructor Detail

VideoCanvas

public VideoCanvas(View view)

VideoCanvas

public VideoCanvas(View view,
                   int renderMode)

VideoCanvas

public VideoCanvas(View view,
                   int renderMode,
                   int uid)

VideoCanvas

public VideoCanvas(View view,
                   int renderMode,
                   int mirrorMode,
                   int uid)