Agora Java API Reference for Android
Public Attributes | Static Public Attributes | List of all members
io.agora.rtc.video.AgoraVideoFrame Class Reference

Public Attributes

int format
 
long timeStamp
 
int stride
 
int height
 
int textureID
 
boolean syncMode
 
float[] transform
 
javax.microedition.khronos.egl.EGLContext eglContext11
 
android.opengl.EGLContext eglContext14
 
byte[] buf
 
int cropLeft
 
int cropTop
 
int cropRight
 
int cropBottom
 
int rotation
 

Static Public Attributes

static final int FORMAT_NONE = -1
 
static final int FORMAT_TEXTURE_2D = 10
 
static final int FORMAT_TEXTURE_OES = 11
 
static final int FORMAT_I420 = 1
 
static final int FORMAT_BGRA = 2
 
static final int FORMAT_NV21 = 3
 
static final int FORMAT_RGBA = 4
 
static final int FORMAT_IMC2 = 5
 
static final int FORMAT_ARGB = 7
 
static final int FORMAT_NV12 = 8
 
static final int FORMAT_I422 = 16
 
static final int BUFFER_TYPE_NONE = -1
 
static final int BUFFER_TYPE_BUFFER = 1
 
static final int BUFFER_TYPE_ARRAY = 2
 
static final int BUFFER_TYPE_TEXTURE = 3
 

Detailed Description

Video frame containing the Agora SDK's encoded video data.

Member Data Documentation

◆ FORMAT_NONE

final int io.agora.rtc.video.AgoraVideoFrame.FORMAT_NONE = -1
static

No video format.

◆ FORMAT_TEXTURE_2D

final int io.agora.rtc.video.AgoraVideoFrame.FORMAT_TEXTURE_2D = 10
static

Video frame in the format of GL_TEXTURE_2D.

◆ FORMAT_TEXTURE_OES

final int io.agora.rtc.video.AgoraVideoFrame.FORMAT_TEXTURE_OES = 11
static

Video frame in the format of GL_TEXTURE_OES.

◆ FORMAT_I420

final int io.agora.rtc.video.AgoraVideoFrame.FORMAT_I420 = 1
static

Video frame in the format of I420.

◆ FORMAT_BGRA

final int io.agora.rtc.video.AgoraVideoFrame.FORMAT_BGRA = 2
static

Video frame in the format of BGRA.

◆ FORMAT_NV21

final int io.agora.rtc.video.AgoraVideoFrame.FORMAT_NV21 = 3
static

Video frame in the format of NV21.

◆ FORMAT_RGBA

final int io.agora.rtc.video.AgoraVideoFrame.FORMAT_RGBA = 4
static

Video frame in the format of RGBA.

◆ FORMAT_IMC2

final int io.agora.rtc.video.AgoraVideoFrame.FORMAT_IMC2 = 5
static

Video frame in the format of IMC2.

◆ FORMAT_ARGB

final int io.agora.rtc.video.AgoraVideoFrame.FORMAT_ARGB = 7
static

Video frame in the format of ARGB.

◆ FORMAT_NV12

final int io.agora.rtc.video.AgoraVideoFrame.FORMAT_NV12 = 8
static

Video frame in the format of NV12.

◆ FORMAT_I422

final int io.agora.rtc.video.AgoraVideoFrame.FORMAT_I422 = 16
static

Video frame in the format of I422.

◆ BUFFER_TYPE_NONE

final int io.agora.rtc.video.AgoraVideoFrame.BUFFER_TYPE_NONE = -1
static

No video format.

◆ BUFFER_TYPE_BUFFER

final int io.agora.rtc.video.AgoraVideoFrame.BUFFER_TYPE_BUFFER = 1
static

Video buffer in the type of BUFFER.

◆ BUFFER_TYPE_ARRAY

final int io.agora.rtc.video.AgoraVideoFrame.BUFFER_TYPE_ARRAY = 2
static

Video buffer in the type of ARRAY.

◆ BUFFER_TYPE_TEXTURE

final int io.agora.rtc.video.AgoraVideoFrame.BUFFER_TYPE_TEXTURE = 3
static

Video buffer in the type of TEXTURE.

◆ format

int io.agora.rtc.video.AgoraVideoFrame.format

Format of the incoming video frame, which must be specified as one of the following:

Note
The SDK does not support the alpha channel, and discards any alpha value passed to the SDK.

◆ timeStamp

long io.agora.rtc.video.AgoraVideoFrame.timeStamp

Timestamp of the incoming video frame (ms). An incorrect timestamp results in frame loss or unsynchronized audio and video.

◆ stride

int io.agora.rtc.video.AgoraVideoFrame.stride

Line spacing of the incoming video frame, which must be in pixels instead of bytes. For textures, it is the width of the texture.

◆ height

int io.agora.rtc.video.AgoraVideoFrame.height

Height of the incoming video frame.

◆ textureID

int io.agora.rtc.video.AgoraVideoFrame.textureID

Texture-related parameter: Texture ID used by the video frame.

◆ syncMode

boolean io.agora.rtc.video.AgoraVideoFrame.syncMode

Texture-related parameter: (Optional) Sets whether to wait for encoding the previous video frame to complete:

  • true: (Default) Wait.
  • false: Do not wait.

◆ transform

float [] io.agora.rtc.video.AgoraVideoFrame.transform

Texture-related parameter: Incoming 4 × 4 transformational matrix. The typical value is a unit matrix.

◆ eglContext11

javax.microedition.khronos.egl.EGLContext io.agora.rtc.video.AgoraVideoFrame.eglContext11

Texture-related parameter: When using the OpenGL interface (javax.microedition.khronos.egl.*) defined by Khronos, set EGLContext to this field.

◆ eglContext14

android.opengl.EGLContext io.agora.rtc.video.AgoraVideoFrame.eglContext14

Texture-related parameter: When using the OpenGL interface (android.opengl.*) defined by Android, set EGLContext to this field.

◆ buf

byte [] io.agora.rtc.video.AgoraVideoFrame.buf

Raw-data-related parameter: The content buffer to be passed to the video frame.

◆ cropLeft

int io.agora.rtc.video.AgoraVideoFrame.cropLeft

Raw-data-related parameter: The number of pixels trimmed from the left. The default value is 0.

◆ cropTop

int io.agora.rtc.video.AgoraVideoFrame.cropTop

Raw-data-related parameter: The number of pixels trimmed from the top. The default value is 0.

◆ cropRight

int io.agora.rtc.video.AgoraVideoFrame.cropRight

Raw-data-related parameter: The number of pixels trimmed from the right. The default value is 0.

◆ cropBottom

int io.agora.rtc.video.AgoraVideoFrame.cropBottom

Raw-data-related parameter: The number of pixels trimmed from the bottom. The default value is 0.

◆ rotation

int io.agora.rtc.video.AgoraVideoFrame.rotation

Raw-data-related parameter: The clockwise rotation of the video frame. You can set the rotating angle as 0, 90, 180, or 270. The default value is 0.