Documentation
All
Console Agora.io Community Submit ticket
English
search-icon

Agora Java API Reference for Android

Overview RtcEngine IRtcEngineEventHandler Warning Codes Error Codes

Public Member Functions

 VideoCanvas (SurfaceView view)
 
 VideoCanvas (SurfaceView view, int renderMode, int uid)
 

Public Attributes

SurfaceView view
 
int renderMode
 
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
 

Detailed Description

Properties of the video display window.

Member Data Documentation

◆ RENDER_MODE_HIDDEN

final int io.agora.rtc.video.VideoCanvas.RENDER_MODE_HIDDEN = 1
static

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

◆ RENDER_MODE_FIT

final int io.agora.rtc.video.VideoCanvas.RENDER_MODE_FIT = 2
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 will be filled with black.

◆ RENDER_MODE_ADAPTIVE

final int io.agora.rtc.video.VideoCanvas.RENDER_MODE_ADAPTIVE = 3
static
Deprecated:
3: This mode is deprecated and Agora does not recommend using it.

◆ view

SurfaceView io.agora.rtc.video.VideoCanvas.view

Video display window.

◆ renderMode

int io.agora.rtc.video.VideoCanvas.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.

◆ uid

int io.agora.rtc.video.VideoCanvas.uid

User ID.