com.opentok.android

Class BaseVideoRenderer.Frame

java.lang.Object

com.opentok.android.BaseVideoRenderer.Frame

Enclosing class:

BaseVideoRenderer

public final class BaseVideoRenderer.Frame
extends java.lang.Object

Defines a frame of a video stream. Call the getBuffer() method to get the frame data. The data is in I420 format.

See Also:

BaseVideoRenderer.onFrame(Frame)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.ByteBuffer	buffer
protected int	format
protected int	height
protected long	internalBuffer
protected byte[]	metadata
protected boolean	mirrored
protected int	uvStride
protected int	width
protected int	yStride

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Frame()

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
java.nio.ByteBuffer	getBuffer() Returns the byte buffer containing the video frame data, which is in I420 format.
int	getHeight() Returns the height of the video frame, in pixels.
byte[]	getMetadata() Returns the metadata associated with the frame if any, as a byte array.
int	getUvStride()
int	getWidth() Returns the width of the video frame, in pixels.
int	getYstride()
boolean	isMirroredX() Whether the video frame is mirrored about the x-axis (true) or not (false).
void	recycle() Frees the internal allocated buffer for the frame and marks the object as reusable for storing a new frame.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

internalBuffer

protected long internalBuffer

buffer

protected java.nio.ByteBuffer buffer

format

protected int format

width

protected int width

height

protected int height

mirrored

protected boolean mirrored

yStride

protected int yStride

uvStride

protected int uvStride

metadata

protected byte[] metadata

Constructor Detail

Frame

protected Frame()

Method Detail

recycle

public void recycle()

Frees the internal allocated buffer for the frame and marks the object as reusable for storing a new frame. You do not need to call this method, but doing so improves memory usage. When you recycle a Frame object that isn't needed, its memory is released without waiting for the garbage collector. Also, the Frame object is added to an internal queue so that the render can reuse it for a new frame (which is more efficient than creating new objects for each frame). After calling this method, do not use this Frame object again.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getBuffer

public java.nio.ByteBuffer getBuffer()

Returns the byte buffer containing the video frame data, which is in I420 format.

getWidth

public int getWidth()

Returns the width of the video frame, in pixels.

getHeight

public int getHeight()

Returns the height of the video frame, in pixels.

isMirroredX

public boolean isMirroredX()

Whether the video frame is mirrored about the x-axis (true) or not (false).

getYstride

public int getYstride()

getUvStride

public int getUvStride()

getMetadata

public byte[] getMetadata()

Returns the metadata associated with the frame if any, as a byte array.