com.regula.sdk

Class DocumentReader

java.lang.Object

com.regula.sdk.DocumentReader

public final class DocumentReader
extends java.lang.Object

Class, which provides API for easy MRZ recognizing and results receiving. Takes care of initializing and configuring all necessary resources.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAMERA_ID
static int	FORMAT_JSON
static int	FORMAT_XML
static int	READER_REQUEST_CODE

Method Summary

Modifier and Type	Method and Description
void	about(android.content.Context context) Use this method to show detailed information screen about the MRZ detector
java.util.List<GraphicField>	getAllGraphicFields() Use this method to receive all the graphic fields from MRZ detection results
java.util.List<TextField>	getAllTextFields() Use this method to get all the text fields from parsed MRZ results
GraphicField	getGraphicFieldByType(int fieldType) Use this method to get selected graphic field from MRZ detection results (currently, only cropped MRZ area is available)
java.lang.String	getLibVersion() Use this method to get Document reader's recognition engine version
java.lang.String	getRawResult() Use this method to get "raw" MRZ detection result in XML format
android.graphics.Bitmap	getSourceImage() Use this method, to get video stream frame MRZ was detected and recognized on
TextField	getTextFieldByType(int fieldType) Use this method to get selected text field from MRZ detection parsed results.
boolean	Init(android.content.Context context, byte[] license) Performs the resource loading and overall initialization of Document Reader instance
static DocumentReader	Instance() This method returns a Singleton instance of Documen Reader class
int	processBitmap(android.graphics.Bitmap bitmap) Use this method to find and recognize MRZ on single images, like ones taken earlier and stored in Gallery
int	processVideoFrame(byte[] frame, int width, int height, int previewFormat) Use this method to find and recognize MRZ on sequential images, like video stream frames

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT_JSON

public static final int FORMAT_JSON

See Also:

Constant Field Values

FORMAT_XML

public static final int FORMAT_XML

See Also:

Constant Field Values

READER_REQUEST_CODE

public static final int READER_REQUEST_CODE

See Also:

Constant Field Values

CAMERA_ID

public static final java.lang.String CAMERA_ID

See Also:

Constant Field Values

Method Detail

Instance

public static DocumentReader Instance()

This method returns a Singleton instance of Documen Reader class

Init

public boolean Init(android.content.Context context,
                    byte[] license)

Performs the resource loading and overall initialization of Document Reader instance

Parameters:

context - Current context

license - Library's license

Returns:

Success flag of initialization process

processBitmap

public int processBitmap(android.graphics.Bitmap bitmap)
                  throws java.lang.IllegalStateException

Use this method to find and recognize MRZ on single images, like ones taken earlier and stored in Gallery

Parameters:

bitmap - Bitmap to find and recognize MRZ on

Returns:

One of MRZDetectorErrorCode values

Throws:

java.lang.IllegalStateException

processVideoFrame

public int processVideoFrame(byte[] frame,
                             int width,
                             int height,
                             int previewFormat)
                      throws java.lang.IllegalStateException

Use this method to find and recognize MRZ on sequential images, like video stream frames

Parameters:

frame - Video frame as byte array

width - Video frame width (Camera.getParameters().getPreviewSize().width)

height - Video frame width (Camera.getParameters().getPreviewSize().height)

previewFormat - Video frame format (Camera.getParameters().getPreviewFormat())

Returns:

One of MRZDetectorErrorCode values

Throws:

java.lang.IllegalStateException

getRawResult

public java.lang.String getRawResult()

Use this method to get "raw" MRZ detection result in XML format

Returns:

MRZ detection result as XML string

getGraphicFieldByType

public GraphicField getGraphicFieldByType(int fieldType)

Use this method to get selected graphic field from MRZ detection results (currently, only cropped MRZ area is available)

Parameters:

fieldType - One of eGraphicFieldType members, representing the selected field (currently, only gt_Other is used)

Returns:

Selected graphic field or null, if there is no selected field in results

getSourceImage

public android.graphics.Bitmap getSourceImage()

Use this method, to get video stream frame MRZ was detected and recognized on

Returns:

Bitmap of source video frame

getAllGraphicFields

public java.util.List<GraphicField> getAllGraphicFields()

Use this method to receive all the graphic fields from MRZ detection results

Returns:

List of gGraphicField objects

getTextFieldByType

public TextField getTextFieldByType(int fieldType)

Use this method to get selected text field from MRZ detection parsed results.

Parameters:

fieldType - one of eVisualFieldType members, representing the selected field

Returns:

Selected text field or null, if there is no selected field in results

getAllTextFields

public java.util.List<TextField> getAllTextFields()

Use this method to get all the text fields from parsed MRZ results

Returns:

List of TextField objects

about

public void about(android.content.Context context)

Use this method to show detailed information screen about the MRZ detector

getLibVersion

public java.lang.String getLibVersion()

Use this method to get Document reader's recognition engine version