com.microblink.directApi.frame

Class BitmapCameraFrame

java.lang.Object

com.microblink.directApi.frame.BitmapCameraFrame

public class BitmapCameraFrame
extends java.lang.Object

Created by dodo on 29/07/15.

Constructor Summary

Constructors

Constructor and Description
BitmapCameraFrame(android.graphics.Bitmap bitmap, long id)

Method Summary

Modifier and Type	Method and Description
void	finalizePoolObject() Finalization method.
CameraDataFormat	getFormat() returns the format of the frame
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.
Rectangle	getVisiblePart() returns the region that defines the visible part of frame
int	getWidth() returns the width of the frame
boolean	initializeNativePart(long frameAnalyzersPtr) Initializes native part of camera frame implementation.
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() Used for recycling frame buffer back into camera so its buffer can be reused for new camera frame.
void	setFrameID(long id)
void	setOrientation(Orientation orientation) Sets the orientation of the current frame.
void	setVisiblePart(Rectangle 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

Constructor Detail

BitmapCameraFrame

public BitmapCameraFrame(android.graphics.Bitmap bitmap,
                         long id)

Method Detail

getWidth

public int getWidth()

returns the width of the frame

getHeight

public int getHeight()

returns the height of the frame

setVisiblePart

public void setVisiblePart(Rectangle visiblePart)

sets the region that defines the visible part of frame

Parameters:

visiblePart -

getFormat

public CameraDataFormat getFormat()

returns the format of the frame

isFocused

public boolean isFocused()

returns true if camera thinks this frame is focused

isDeviceMoving

public boolean isDeviceMoving()

returns true if device was moving while frame was created

getVisiblePart

public Rectangle getVisiblePart()

returns the region that defines the visible part of frame

recycle

public void recycle()

Used for recycling frame buffer back into camera so its buffer can be reused for new camera frame. Also, releases all native part if required.

isPhoto

public boolean isPhoto()

Returns true if frame is photograph

initializeNativePart

public boolean initializeNativePart(long frameAnalyzersPtr)

Initializes native part of camera frame implementation. This makes getNativeCameraFrame available.

Parameters:

frameAnalyzersPtr - Native pointer to class containing all native elements frame needs (frame quality estimator, white balance analyzer etc.)

getNativeCameraFrame

public long getNativeCameraFrame()

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

getFrameQuality

public double getFrameQuality()

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

setOrientation

public void setOrientation(Orientation orientation)

Sets the orientation of the current frame.

Parameters:

orientation -

getOrientation

public Orientation getOrientation()

Returns the orientation of the current frame.

getFrameID

public long getFrameID()

Returns the unique frame identifier

setFrameID

public void setFrameID(long id)

initializePoolObject

public void initializePoolObject()

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

finalizePoolObject

public void finalizePoolObject()

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