com.otaliastudios.cameraview

Class Frame

java.lang.Object

com.otaliastudios.cameraview.Frame

public class Frame
extends java.lang.Object

A preview frame to be processed by FrameProcessors.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Frame	freeze() Clones the frame, returning a frozen content that will not be overwritten.
byte[]	getData() Returns the frame data.
int	getFormat() Returns the data format, in one of the ImageFormat constants.
int	getRotation() Returns the clock-wise rotation that should be applied on the data array, such that the resulting frame matches what the user is seeing on screen.
Size	getSize() Returns the frame size.
long	getTime() Returns the milliseconds epoch for this frame, in the System.currentTimeMillis() reference.
void	release() Disposes the contents of this frame.

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

freeze

public Frame freeze()

Clones the frame, returning a frozen content that will not be overwritten. This can be kept or safely passed to other threads. Using freeze without clearing with release() can result in memory leaks.

Returns:

a frozen Frame

release

public void release()

Disposes the contents of this frame. Can be useful for frozen frames that are not useful anymore.

getData

public byte[] getData()

Returns the frame data.

Returns:

the frame data

getTime

public long getTime()

Returns the milliseconds epoch for this frame, in the System.currentTimeMillis() reference.

Returns:

time data

getRotation

public int getRotation()

Returns the clock-wise rotation that should be applied on the data array, such that the resulting frame matches what the user is seeing on screen.

Returns:

clock-wise rotation

getSize

public Size getSize()

Returns the frame size.

Returns:

frame size

getFormat

public int getFormat()

Returns the data format, in one of the ImageFormat constants. This will always be ImageFormat.NV21 for now.

Returns:

the data format

See Also:

ImageFormat