com.microblink.blinkinput.image

Class ImageFrame

java.lang.Object

com.microblink.blinkinput.image.ImageFrame

public class ImageFrame
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Image	mImage

Constructor Summary

Constructors

Constructor and Description
ImageFrame(Image image, long id)

Method Summary

Modifier and Type	Method and Description
void	finalizePoolObject() Finalization method.
CameraDataFormat	getFormat()
long	getFrameID() Returns the unique frame identifier
double	getFrameQuality() Returns the quality of the current frame.
int	getHeight() returns the height of the frame
long	getNativeCameraFrame() Accessed from native code to obtain pointer to implementation of native camera frame
Orientation	getOrientation() Returns the orientation of the current frame.
android.graphics.RectF	getVisiblePart() returns the region that defines the visible part of frame
int	getWidth() returns the width of the frame
boolean	initializeNativePart(long frameAnalyzersPtr)
void	initializePoolObject() Initialization method.
boolean	isDeviceMoving() returns true if device was moving while frame was created
boolean	isFocused() returns true if camera thinks this frame is focused
boolean	isPhoto() Returns true if frame is photograph
void	recycle()
void	setOrientation(Orientation orientation) Sets the orientation of the current frame.
void	setVisiblePart(android.graphics.RectF visiblePart) sets the region that defines the visible part of frame

Methods inherited from class java.lang.Object

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

Field Detail

mImage

@NonNull
protected Image mImage

Constructor Detail

ImageFrame

public ImageFrame(@Nullable
                  Image image,
                  long id)

Method Detail

getWidth

public final int getWidth()

returns the width of the frame

getHeight

public final int getHeight()

returns the height of the frame

setVisiblePart

public final void setVisiblePart(@NonNull
                                 android.graphics.RectF visiblePart)

sets the region that defines the visible part of frame

Parameters:

visiblePart -

getFormat

@NonNull
public CameraDataFormat getFormat()

isFocused

public final boolean isFocused()

returns true if camera thinks this frame is focused

isDeviceMoving

public final boolean isDeviceMoving()

returns true if device was moving while frame was created

getVisiblePart

@NonNull
public final android.graphics.RectF getVisiblePart()

returns the region that defines the visible part of frame

isPhoto

public final boolean isPhoto()

Returns true if frame is photograph

initializeNativePart

public boolean initializeNativePart(long frameAnalyzersPtr)

recycle

public void recycle()

getNativeCameraFrame

public final long getNativeCameraFrame()

Accessed from native code to obtain pointer to implementation of native camera frame

getFrameQuality

public final double getFrameQuality()

Returns the quality of the current frame. Negative quality indicates that quality is not and cannot be calculated.

setOrientation

public final void setOrientation(@NonNull
                                 Orientation orientation)

Sets the orientation of the current frame.

Parameters:

orientation -

getOrientation

@NonNull
public final Orientation getOrientation()

Returns the orientation of the current frame.

getFrameID

public final long getFrameID()

Returns the unique frame identifier

initializePoolObject

public final void initializePoolObject()

Initialization method. Called when an object is retrieved from the object pool or has just been created.

finalizePoolObject

public final void finalizePoolObject()

Finalization method. Called when an object is stored in the object pool to mark it as free.