Agora Java API Reference for Android
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
io.agora.rtc.VideoEncodedFrame Class Reference

Public Member Functions

 VideoEncodedFrame (int codecType, ByteBuffer imageBuffer, int length, int width, int height, int frameType, int rotation, long renderTimeMs)
 
String toString ()
 

Public Attributes

int codecType
 
int width
 
int height
 
int frameType
 
int rotation
 
long renderTimeMs
 
ByteBuffer imageBuffer
 
int length
 

Static Public Attributes

static final int CODEC_TYPE_VP8 = 1
 
static final int CODEC_TYPE_H264 = 2
 
static final int CODEC_TYPE_EVP = 3
 
static final int CODEC_TYPE_E264 = 4
 
static final int FRAME_TYPE_BLANK = 0
 
static final int FRAME_TYPE_KEY = 3
 
static final int FRAME_TYPE_DELTA = 4
 
static final int FRAME_TYPE_B = 5
 

Detailed Description

The VideoEncodedFrame class.

Since
v3.4.5

Member Data Documentation

◆ CODEC_TYPE_VP8

final int io.agora.rtc.VideoEncodedFrame.CODEC_TYPE_VP8 = 1
static

1: VP8

◆ CODEC_TYPE_H264

final int io.agora.rtc.VideoEncodedFrame.CODEC_TYPE_H264 = 2
static

2: (Default) H.264

◆ CODEC_TYPE_EVP

final int io.agora.rtc.VideoEncodedFrame.CODEC_TYPE_EVP = 3
static

3: Enhanced VP8

◆ CODEC_TYPE_E264

final int io.agora.rtc.VideoEncodedFrame.CODEC_TYPE_E264 = 4
static

4: Enhanced H.264

◆ FRAME_TYPE_BLANK

final int io.agora.rtc.VideoEncodedFrame.FRAME_TYPE_BLANK = 0
static

0: (Default) A black frame

◆ FRAME_TYPE_KEY

final int io.agora.rtc.VideoEncodedFrame.FRAME_TYPE_KEY = 3
static

3: The keyframe

◆ FRAME_TYPE_DELTA

final int io.agora.rtc.VideoEncodedFrame.FRAME_TYPE_DELTA = 4
static

4: The delta frame

◆ FRAME_TYPE_B

final int io.agora.rtc.VideoEncodedFrame.FRAME_TYPE_B = 5
static

5: The B-frame

◆ codecType

int io.agora.rtc.VideoEncodedFrame.codecType

The video codec type. The following values are supported:

  • CODEC_TYPE_VP8 (1): VP8
  • CODEC_TYPE_H264 (2): (Default) H.264
  • CODEC_TYPE_EVP (3): Enhanced VP8
  • CODEC_TYPE_E264 (4): Enhanced H.264

◆ width

int io.agora.rtc.VideoEncodedFrame.width

The width (px) of the video.

◆ height

int io.agora.rtc.VideoEncodedFrame.height

The height (px) of the video.

◆ frameType

int io.agora.rtc.VideoEncodedFrame.frameType

The video frame type. The following values are supported:

  • FRAME_TYPE_BLANK (0): (Default) A black frame
  • FRAME_TYPE_KEY (3): The keyframe
  • FRAME_TYPE_DELTA (4): The delta frame
  • FRAME_TYPE_B (5): The B-frame

◆ rotation

int io.agora.rtc.VideoEncodedFrame.rotation

The clockwise rotation angle of the video frame. The supported values are 0, 90, 180, or 270 degrees.

◆ renderTimeMs

long io.agora.rtc.VideoEncodedFrame.renderTimeMs

The Unix timestamp (ms) when the video frame is rendered. This timestamp can be used to guide the rendering of the video frame. This parameter is required.

◆ imageBuffer

ByteBuffer io.agora.rtc.VideoEncodedFrame.imageBuffer

The video buffer, which is in the DirectByteBuffer data type.

◆ length

int io.agora.rtc.VideoEncodedFrame.length

The length (in bytes) of the video buffer.