io.agora.rtc.ExternalVideoFrame Class Reference

Public Member Functions
	ExternalVideoFrame ()
	ExternalVideoFrame (int type, int format, java.nio.ByteBuffer buffer, int stride, int height, int cropLeft, int cropTop, int cropRight, int cropBottom, int rotation, long timestamp, Object eglContext, int eglType, int textureId, float matrix, byte[] metadataBuffer, int metadataSize)
int	getType ()
void	setType (int type)
int	getFormat ()
void	setFormat (int format)
java.nio.ByteBuffer	getBuffer ()
void	setBuffer (java.nio.ByteBuffer buffer)
int	getStride ()
void	setStride (int stride)
int	getHeight ()
void	setHeight (int height)
int	getCropLeft ()
void	setCropLeft (int cropLeft)
int	getCropTop ()
void	setCropTop (int cropTop)
int	getCropRight ()
void	setCropRight (int cropRight)
int	getCropBottom ()
void	setCropBottom (int cropBottom)
int	getRotation ()
void	setRotation (int rotation)
long	getTimestamp ()
void	setTimestamp (long timestamp)
Object	getEglContext ()
void	setEglContext (Object eglContext)
int	getEglType ()
void	setEglType (int eglType)
int	getTextureId ()
void	setTextureId (int textureId)
float	getMatrix ()
void	setMatrix (float matrix)
byte[]	getMetadataBuffer ()
void	setMetadataBuffer (byte[] metadataBuffer)
int	getMetadataSize ()
void	setMetadataSize (int metadataSize)

Detailed Description

The ExternalVideoFrame class.

Constructor & Destructor Documentation

ExternalVideoFrame() [1/2]

io.agora.rtc.ExternalVideoFrame.ExternalVideoFrame

(

)

ExternalVideoFrame() [2/2]

io.agora.rtc.ExternalVideoFrame.ExternalVideoFrame	(	int	type,
		int	format,
		java.nio.ByteBuffer	buffer,
		int	stride,
		int	height,
		int	cropLeft,
		int	cropTop,
		int	cropRight,
		int	cropBottom,
		int	rotation,
		long	timestamp,
		Object	eglContext,
		int	eglType,
		int	textureId,
		float	matrix,
		byte[]	metadataBuffer,
		int	metadataSize
	)

Constructor.

Parameters

type	The buffer type. 1: Raw data. 2: The same as 1. 3: The video buffer in the format of texture.
format	The pixel format.
buffer	The video buffer.
stride	The line spacing of the incoming video frame (px). For texture, it is the width of the texture.
height	The height of the incoming video frame.
cropLeft	[Raw data related parameter] The number of pixels trimmed from the left. The default value is 0.
cropTop	[Raw data related parameter] The number of pixels trimmed from the top. The default value is 0.
cropRight	[Raw data related parameter] The number of pixels trimmed from the right. The default value is 0.
cropBottom	[Raw data related parameter] The number of pixels trimmed from the bottom. The default value is 0.
rotation	[Raw data related parameter] The clockwise rotation information of the video frame. You can set the rotation angle as 0, 90, 180, or 270. The default value is 0.
timestamp	The timestamp (ms) of the incoming video frame. An incorrect timestamp results in a frame loss or unsynchronized audio and video.

Member Function Documentation

getBuffer()

java.nio.ByteBuffer io.agora.rtc.ExternalVideoFrame.getBuffer

(

)

getCropBottom()

int io.agora.rtc.ExternalVideoFrame.getCropBottom

(

)

getCropLeft()

int io.agora.rtc.ExternalVideoFrame.getCropLeft

(

)

getCropRight()

int io.agora.rtc.ExternalVideoFrame.getCropRight

(

)

getCropTop()

int io.agora.rtc.ExternalVideoFrame.getCropTop

(

)

getEglContext()

Object io.agora.rtc.ExternalVideoFrame.getEglContext

(

)

getEglType()

int io.agora.rtc.ExternalVideoFrame.getEglType

(

)

getFormat()

int io.agora.rtc.ExternalVideoFrame.getFormat

(

)

getHeight()

int io.agora.rtc.ExternalVideoFrame.getHeight

(

)

getMatrix()

float io.agora.rtc.ExternalVideoFrame.getMatrix

(

)

getMetadataBuffer()

byte[] io.agora.rtc.ExternalVideoFrame.getMetadataBuffer

(

)

getMetadataSize()

int io.agora.rtc.ExternalVideoFrame.getMetadataSize

(

)

getRotation()

int io.agora.rtc.ExternalVideoFrame.getRotation

(

)

getStride()

int io.agora.rtc.ExternalVideoFrame.getStride

(

)

getTextureId()

int io.agora.rtc.ExternalVideoFrame.getTextureId

(

)

getTimestamp()

long io.agora.rtc.ExternalVideoFrame.getTimestamp

(

)

getType()

int io.agora.rtc.ExternalVideoFrame.getType

(

)

setBuffer()

void io.agora.rtc.ExternalVideoFrame.setBuffer

(

java.nio.ByteBuffer

buffer

)

setCropBottom()

void io.agora.rtc.ExternalVideoFrame.setCropBottom

(

int

cropBottom

)

setCropLeft()

void io.agora.rtc.ExternalVideoFrame.setCropLeft

(

int

cropLeft

)

setCropRight()

void io.agora.rtc.ExternalVideoFrame.setCropRight

(

int

cropRight

)

setCropTop()

void io.agora.rtc.ExternalVideoFrame.setCropTop

(

int

cropTop

)

setEglContext()

void io.agora.rtc.ExternalVideoFrame.setEglContext

(

Object

eglContext

)

setEglType()

void io.agora.rtc.ExternalVideoFrame.setEglType

(

int

eglType

)

setFormat()

void io.agora.rtc.ExternalVideoFrame.setFormat

(

int

format

)

setHeight()

void io.agora.rtc.ExternalVideoFrame.setHeight

(

int

height

)

setMatrix()

void io.agora.rtc.ExternalVideoFrame.setMatrix

(

float

matrix

)

setMetadataBuffer()

void io.agora.rtc.ExternalVideoFrame.setMetadataBuffer

(

byte[]

metadataBuffer

)

setMetadataSize()

void io.agora.rtc.ExternalVideoFrame.setMetadataSize

(

int

metadataSize

)

setRotation()

void io.agora.rtc.ExternalVideoFrame.setRotation

(

int

rotation

)

setStride()

void io.agora.rtc.ExternalVideoFrame.setStride

(

int

stride

)

setTextureId()

void io.agora.rtc.ExternalVideoFrame.setTextureId

(

int

textureId

)

setTimestamp()

void io.agora.rtc.ExternalVideoFrame.setTimestamp

(

long

timestamp

)

setType()

void io.agora.rtc.ExternalVideoFrame.setType

(

int

type

)

---

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

• ExternalVideoFrame.java