Package com.microblink.entities.recognizers.blinkid.mrtd

Class MrtdCombinedRecognizer.Result

java.lang.Object

com.microblink.entities.Entity.Result

com.microblink.entities.recognizers.Recognizer.Result

com.microblink.entities.recognizers.blinkid.mrtd.MrtdCombinedRecognizer.Result

All Implemented Interfaces:

android.os.Parcelable, CombinedDataMatchResult, CombinedResult, CombinedFullDocumentImageResult, EncodedCombinedFullDocumentImageResult, EncodedFaceImageResult, FaceImageResult

Enclosing class:

MrtdCombinedRecognizer

public static final class MrtdCombinedRecognizer.Result
extends Recognizer.Result
implements CombinedResult, CombinedDataMatchResult, FaceImageResult, EncodedFaceImageResult, CombinedFullDocumentImageResult, EncodedCombinedFullDocumentImageResult

Nested Class Summary

Nested classes/interfaces inherited from class com.microblink.entities.recognizers.Recognizer.Result

Recognizer.Result.State

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
static android.os.Parcelable.Creator<MrtdCombinedRecognizer.Result>	CREATOR

Fields inherited from class com.microblink.entities.Entity.Result

mOwner

Fields inherited from interface com.microblink.entities.recognizers.blinkid.CombinedDataMatchResult

CLASS_NAME

Fields inherited from interface com.microblink.entities.recognizers.blinkid.imageresult.CombinedFullDocumentImageResult

CLASS_NAME

Fields inherited from interface com.microblink.entities.recognizers.blinkid.CombinedResult

CLASS_NAME

Fields inherited from interface com.microblink.entities.recognizers.blinkid.imageresult.EncodedCombinedFullDocumentImageResult

CLASS_NAME

Fields inherited from interface com.microblink.entities.recognizers.blinkid.imageresult.EncodedFaceImageResult

CLASS_NAME

Fields inherited from interface com.microblink.entities.recognizers.blinkid.imageresult.FaceImageResult

CLASS_NAME

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Result(long nativeResult)

Method Summary

Modifier and Type	Method	Description
MrtdCombinedRecognizer.Result	clone()	Create a copy of the result.
protected void	deserializeFromByteArray(byte[] arr)
DataMatchResult	getDocumentDataMatch()	Returns result of the data matching algorithm for scanned parts/sides of the document.
byte[]	getEncodedBackFullDocumentImage()
byte[]	getEncodedFaceImage()
byte[]	getEncodedFrontFullDocumentImage()
Image	getFaceImage()
Image	getFullDocumentBackImage()
Image	getFullDocumentFrontImage()
MrzResult	getMrzResult()	The data extracted from the machine readable zone.
boolean	isScanningFirstSideDone()
protected byte[]	serializeToByteArray()
protected void	terminateNative(long nativeContext)
java.lang.String	toString()

Methods inherited from class com.microblink.entities.recognizers.Recognizer.Result

getResultState, isEmpty

Methods inherited from class com.microblink.entities.Entity.Result

describeContents, finalize, getNativeContext, readFromParcel, writeToParcel

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<MrtdCombinedRecognizer.Result> CREATOR

Constructor Detail

Result

protected Result(long nativeResult)

Method Detail

getDocumentDataMatch

@NonNull
public DataMatchResult getDocumentDataMatch()

Description copied from interface: CombinedDataMatchResult

Returns result of the data matching algorithm for scanned parts/sides of the document. For example if date of expiry is scanned from the front and back side of the document and values do not match, this method will return DataMatchResult.Failed. Result will be DataMatchResult.Success only if scanned values for all fields that are compared are the same. If data matching has not been performed, result will be DataMatchResult.NotPerformed.

Specified by:

getDocumentDataMatch in interface CombinedDataMatchResult

Returns:

result of the data matching algorithm for scanned parts/sides of the document.

getEncodedFrontFullDocumentImage

@NonNull
public byte[] getEncodedFrontFullDocumentImage()

Specified by:

getEncodedFrontFullDocumentImage in interface EncodedCombinedFullDocumentImageResult

Returns:

encoded full document image from the front side in JPEG format if enabled with EncodeFullDocumentImagesOptions.setEncodeFullDocumentImage(boolean) , else null

getFullDocumentFrontImage

@Nullable
public Image getFullDocumentFrontImage()

Specified by:

getFullDocumentFrontImage in interface CombinedFullDocumentImageResult

Returns:

front side image of the document if enabled with FullDocumentImageOptions.setReturnFullDocumentImage(boolean), else null

isScanningFirstSideDone

public boolean isScanningFirstSideDone()

Specified by:

isScanningFirstSideDone in interface CombinedResult

Returns:

true if recognizer has finished scanning first side and is now scanning back side, false if it's still scanning first side.

getEncodedBackFullDocumentImage

@NonNull
public byte[] getEncodedBackFullDocumentImage()

Specified by:

getEncodedBackFullDocumentImage in interface EncodedCombinedFullDocumentImageResult

Returns:

encoded full document image from the back side in JPEG format if enabled with EncodeFullDocumentImagesOptions.setEncodeFullDocumentImage(boolean) , else null

getMrzResult

@NonNull
public MrzResult getMrzResult()

The data extracted from the machine readable zone.

getEncodedFaceImage

@NonNull
public byte[] getEncodedFaceImage()

Specified by:

getEncodedFaceImage in interface EncodedFaceImageResult

Returns:

encoded face image in JPEG from the document if enabled with EncodeFaceImageOptions.setEncodeFaceImage(boolean) , else null

getFaceImage

@Nullable
public Image getFaceImage()

Specified by:

getFaceImage in interface FaceImageResult

Returns:

face image from the document if enabled with FaceImageOptions.setReturnFaceImage(boolean), else null

getFullDocumentBackImage

@Nullable
public Image getFullDocumentBackImage()

Specified by:

getFullDocumentBackImage in interface CombinedFullDocumentImageResult

Returns:

back side image of the document if enabled with FullDocumentImageOptions.setReturnFullDocumentImage(boolean), else null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

string version of this result

serializeToByteArray

@Nullable
protected byte[] serializeToByteArray()

Specified by:

serializeToByteArray in class Entity.Result

deserializeFromByteArray

protected void deserializeFromByteArray(@NonNull
                                        byte[] arr)

Specified by:

deserializeFromByteArray in class Entity.Result

clone

public MrtdCombinedRecognizer.Result clone()

Description copied from class: Entity.Result

Create a copy of the result. This is required in order to retain the result even after owning entity has mutated it.

Specified by:

clone in class Recognizer.Result

Returns:

a copy of the result

terminateNative

protected void terminateNative(long nativeContext)

Specified by:

terminateNative in class Entity.Result