Server Gateway SDK v3.7.200.21 for Linux Java
Public Member Functions | List of all members
io.agora.rtc.VideoFrame Class Reference

Public Member Functions

 VideoFrame ()
 
 VideoFrame (int type, int width, int height, int yStride, int uStride, int vStride, java.nio.ByteBuffer yBuffer, java.nio.ByteBuffer uBuffer, java.nio.ByteBuffer vBuffer, int rotation, long renderTimeMs, int avsyncType, byte[] metadataBuffer, int metadataSize, Object sharedContext, int textureId, float matrix, byte[] alphaBuffer)
 
int getType ()
 
void setType (int type)
 
int getWidth ()
 
void setWidth (int width)
 
int getHeight ()
 
void setHeight (int height)
 
int getYStride ()
 
void setYStride (int yStride)
 
int getUStride ()
 
void setUStride (int uStride)
 
int getVStride ()
 
void setVStride (int vStride)
 
java.nio.ByteBuffer getYBuffer ()
 
void setYBuffer (java.nio.ByteBuffer yBuffer)
 
java.nio.ByteBuffer getUBuffer ()
 
void setUBuffer (java.nio.ByteBuffer uBuffer)
 
java.nio.ByteBuffer getVBuffer ()
 
void setVBuffer (java.nio.ByteBuffer vBuffer)
 
int getRotation ()
 
void setRotation (int rotation)
 
long getRenderTimeMs ()
 
void setRenderTimeMs (long renderTimeMs)
 
int getAvsyncType ()
 
void setAvsyncType (int avsyncType)
 
byte[] getMetadataBuffer ()
 
void setMetadataBuffer (byte[] metadataBuffer)
 
int getMetadataSize ()
 
void setMetadataSize (int metadataSize)
 
Object getSharedContext ()
 
void setSharedContext (Object sharedContext)
 
int getTextureId ()
 
void setTextureId (int textureId)
 
float getMatrix ()
 
void setMatrix (float matrix)
 
byte[] getAlphaBuffer ()
 
void setAlphaBuffer (byte[] alphaBuffer)
 

Detailed Description

The VideoFrame class.

Constructor & Destructor Documentation

◆ VideoFrame() [1/2]

io.agora.rtc.VideoFrame.VideoFrame ( )

◆ VideoFrame() [2/2]

io.agora.rtc.VideoFrame.VideoFrame ( int  type,
int  width,
int  height,
int  yStride,
int  uStride,
int  vStride,
java.nio.ByteBuffer  yBuffer,
java.nio.ByteBuffer  uBuffer,
java.nio.ByteBuffer  vBuffer,
int  rotation,
long  renderTimeMs,
int  avsyncType,
byte[]  metadataBuffer,
int  metadataSize,
Object  sharedContext,
int  textureId,
float  matrix,
byte[]  alphaBuffer 
)

Constructor.

Parameters
typeThe video pixel format.
  • 0: Unknown format.
  • 1: I420.
  • 2: BGRA.
  • 3: NV21.
  • 4: RGBA.
  • 8: NV12.
  • 10: GL_TEXTURE_2D.
  • 11: GL_TEXTURE_OES.
  • 16: I422.
widthThe width (px) of the video frame.
heightThe height (px) of the video frame.
yStrideThe line span of Y buffer in the YUV data.
uStrideThe line span of U buffer in the YUV data.
vStrideThe line span of V buffer in the YUV data.
yBufferThe Y buffer in the YUV data.
uBufferThe U buffer in the YUV data.
vBufferThe V buffer in the YUV data.
rotationThe clockwise rotation information of this frame. You can set it as 0, 90, 180 or 270.
renderTimeMsThe timestamp to render the video stream. Use this parameter for audio-video synchronization when endering the video.
avsyncTypeThe type of audio-video synchronization.

Member Function Documentation

◆ getAlphaBuffer()

byte[] io.agora.rtc.VideoFrame.getAlphaBuffer ( )

◆ getAvsyncType()

int io.agora.rtc.VideoFrame.getAvsyncType ( )

◆ getHeight()

int io.agora.rtc.VideoFrame.getHeight ( )

◆ getMatrix()

float io.agora.rtc.VideoFrame.getMatrix ( )

◆ getMetadataBuffer()

byte[] io.agora.rtc.VideoFrame.getMetadataBuffer ( )

◆ getMetadataSize()

int io.agora.rtc.VideoFrame.getMetadataSize ( )

◆ getRenderTimeMs()

long io.agora.rtc.VideoFrame.getRenderTimeMs ( )

◆ getRotation()

int io.agora.rtc.VideoFrame.getRotation ( )

◆ getSharedContext()

Object io.agora.rtc.VideoFrame.getSharedContext ( )

◆ getTextureId()

int io.agora.rtc.VideoFrame.getTextureId ( )

◆ getType()

int io.agora.rtc.VideoFrame.getType ( )

◆ getUBuffer()

java.nio.ByteBuffer io.agora.rtc.VideoFrame.getUBuffer ( )

◆ getUStride()

int io.agora.rtc.VideoFrame.getUStride ( )

◆ getVBuffer()

java.nio.ByteBuffer io.agora.rtc.VideoFrame.getVBuffer ( )

◆ getVStride()

int io.agora.rtc.VideoFrame.getVStride ( )

◆ getWidth()

int io.agora.rtc.VideoFrame.getWidth ( )

◆ getYBuffer()

java.nio.ByteBuffer io.agora.rtc.VideoFrame.getYBuffer ( )

◆ getYStride()

int io.agora.rtc.VideoFrame.getYStride ( )

◆ setAlphaBuffer()

void io.agora.rtc.VideoFrame.setAlphaBuffer ( byte[]  alphaBuffer)

◆ setAvsyncType()

void io.agora.rtc.VideoFrame.setAvsyncType ( int  avsyncType)

◆ setHeight()

void io.agora.rtc.VideoFrame.setHeight ( int  height)

◆ setMatrix()

void io.agora.rtc.VideoFrame.setMatrix ( float  matrix)

◆ setMetadataBuffer()

void io.agora.rtc.VideoFrame.setMetadataBuffer ( byte[]  metadataBuffer)

◆ setMetadataSize()

void io.agora.rtc.VideoFrame.setMetadataSize ( int  metadataSize)

◆ setRenderTimeMs()

void io.agora.rtc.VideoFrame.setRenderTimeMs ( long  renderTimeMs)

◆ setRotation()

void io.agora.rtc.VideoFrame.setRotation ( int  rotation)

◆ setSharedContext()

void io.agora.rtc.VideoFrame.setSharedContext ( Object  sharedContext)

◆ setTextureId()

void io.agora.rtc.VideoFrame.setTextureId ( int  textureId)

◆ setType()

void io.agora.rtc.VideoFrame.setType ( int  type)

◆ setUBuffer()

void io.agora.rtc.VideoFrame.setUBuffer ( java.nio.ByteBuffer  uBuffer)

◆ setUStride()

void io.agora.rtc.VideoFrame.setUStride ( int  uStride)

◆ setVBuffer()

void io.agora.rtc.VideoFrame.setVBuffer ( java.nio.ByteBuffer  vBuffer)

◆ setVStride()

void io.agora.rtc.VideoFrame.setVStride ( int  vStride)

◆ setWidth()

void io.agora.rtc.VideoFrame.setWidth ( int  width)

◆ setYBuffer()

void io.agora.rtc.VideoFrame.setYBuffer ( java.nio.ByteBuffer  yBuffer)

◆ setYStride()

void io.agora.rtc.VideoFrame.setYStride ( int  yStride)

The documentation for this class was generated from the following file: