Class BlinkIdSingleSideRecognizer.Result
java.lang.Object
com.microblink.blinkid.entities.Entity.Result
com.microblink.blinkid.entities.recognizers.Recognizer.Result
com.microblink.blinkid.entities.recognizers.blinkid.generic.BlinkIdSingleSideRecognizer.Result
- All Implemented Interfaces:
android.os.Parcelable
,ClassInfoResult
,EncodedFaceImageResult
,EncodedFullDocumentImageResult
,EncodedSignatureImageResult
,FaceImageResult
,FullDocumentImageResult
,SignatureImageResult
,ProcessingStatusResult
- Enclosing class:
- BlinkIdSingleSideRecognizer
public static final class BlinkIdSingleSideRecognizer.Result
extends Recognizer.Result
implements FaceImageResult, EncodedFaceImageResult, FullDocumentImageResult, EncodedFullDocumentImageResult, SignatureImageResult, EncodedSignatureImageResult, ProcessingStatusResult, ClassInfoResult
-
Nested Class Summary
Nested classes/interfaces inherited from class com.microblink.blinkid.entities.recognizers.Recognizer.Result
Recognizer.Result.State
-
Field Summary
Modifier and TypeFieldDescriptionstatic final android.os.Parcelable.Creator<BlinkIdSingleSideRecognizer.Result>
Fields inherited from class com.microblink.blinkid.entities.Entity.Result
mOwner
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageresult.EncodedFaceImageResult
CLASS_NAME
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageresult.EncodedFullDocumentImageResult
CLASS_NAME
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageresult.EncodedSignatureImageResult
CLASS_NAME
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageresult.FaceImageResult
CLASS_NAME
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageresult.FullDocumentImageResult
CLASS_NAME
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.ProcessingStatusResult
CLASS_NAME
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageresult.SignatureImageResult
CLASS_NAME
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Create a copy of the result.protected void
deserializeFromByteArray
(byte[] arr) The additional address information of the document owner.The additional name information of the document owner.The one more additional address information of the document owner.Additional info on processing.The address of the document owner.int
getAge()
The current age of the document owner in years.getAgeLimitStatus
(int ageLimit) Calculates whether the document owner is older than the givenageLimit
in years or not.Barcode camera frame.The data extracted from the barcode.The blood type of the document owner.Camera frame.The document class information.The date of birth of the document owner.The date of expiry of the document.The date of issue of the document.The additional number of the document.The document number.The one more additional number of the document.The driver license detailed info.The employer of the document owner.byte[]
byte[]
byte[]
The face image location.Side of the card of the face image.The fathers name of the document owner.The first name of the document owner.The full name of the document owner.Image analysis result for the scanned document imageThe issuing authority of the document.The last name of the document owner.The localized name of the document owner.The marital status of the document owner.The mothers name of the document owner.The data extracted from the machine readable zone.The nationality of the documet owner.The personal identification number.The place of birth of the document owner.Status of the last recognition process.The profession of the document owner.getRace()
The race of the document owner.Recognition mode used to scan current document.The religion of the document owner.The residential stauts of the document owner.getSex()
The sex of the document owner.The sponsor of the document owner.The data extracted from the visual inspection zone.boolean
Determines if date of expiry is permanent.boolean
Checks whether the document has expired or not by comparing the current time on the device with the date of expiry.protected byte[]
protected void
terminateNative
(long nativeContext) toString()
Methods inherited from class com.microblink.blinkid.entities.recognizers.Recognizer.Result
getResultState, isEmpty
Methods inherited from class com.microblink.blinkid.entities.Entity.Result
describeContents, finalize, getNativeContext, readFromParcel, writeToParcel
-
Field Details
-
CREATOR
-
-
Constructor Details
-
Result
protected Result(long nativeResult)
-
-
Method Details
-
getAdditionalOptionalAddressInformation
The one more additional address information of the document owner. -
getFathersName
The fathers name of the document owner. -
getDocumentNumber
The document number. -
getDocumentOptionalAdditionalNumber
The one more additional number of the document. -
getBarcodeCameraFrame
Barcode camera frame. -
getCameraFrame
Camera frame. -
getAdditionalAddressInformation
The additional address information of the document owner. -
getEmployer
The employer of the document owner. -
getImageAnalysisResult
Image analysis result for the scanned document image -
getProfession
The profession of the document owner. -
getClassInfo
The document class information.- Specified by:
getClassInfo
in interfaceClassInfoResult
-
getDateOfExpiry
The date of expiry of the document. -
getLocalizedName
The localized name of the document owner. -
getMrzResult
The data extracted from the machine readable zone. -
getProcessingStatus
Description copied from interface:ProcessingStatusResult
Status of the last recognition process.- Specified by:
getProcessingStatus
in interfaceProcessingStatusResult
-
getFirstName
The first name of the document owner. -
getNationality
The nationality of the documet owner. -
getAdditionalNameInformation
The additional name information of the document owner. -
getMothersName
The mothers name of the document owner. -
getMaritalStatus
The marital status of the document owner. -
getLastName
The last name of the document owner. -
getSponsor
The sponsor of the document owner. -
getAdditionalProcessingInfo
Additional info on processing. -
getDriverLicenseDetailedInfo
The driver license detailed info. -
getPersonalIdNumber
The personal identification number. -
getEncodedFullDocumentImage
@NonNull public byte[] getEncodedFullDocumentImage()- Specified by:
getEncodedFullDocumentImage
in interfaceEncodedFullDocumentImageResult
- Returns:
- encoded full document image in JPEG format if enabled with
EncodeFullDocumentImagesOptions.setEncodeFullDocumentImage(boolean)
, elsenull
-
getEncodedFaceImage
@NonNull public byte[] getEncodedFaceImage()- Specified by:
getEncodedFaceImage
in interfaceEncodedFaceImageResult
- Returns:
- encoded face image in JPEG from the document if enabled with
EncodeFaceImageOptions.setEncodeFaceImage(boolean)
, elsenull
-
getBloodType
The blood type of the document owner. -
getFaceImage
- Specified by:
getFaceImage
in interfaceFaceImageResult
- Returns:
- face image from the document if enabled with
FaceImageOptions.setReturnFaceImage(boolean)
, elsenull
-
getEncodedSignatureImage
@NonNull public byte[] getEncodedSignatureImage()- Specified by:
getEncodedSignatureImage
in interfaceEncodedSignatureImageResult
- Returns:
- encoded signature in JPEG from the document if enabled with
EncodeSignatureImageOptions.setEncodeSignatureImage(boolean)
, elsenull
-
getFullDocumentImage
- Specified by:
getFullDocumentImage
in interfaceFullDocumentImageResult
- Returns:
- image of the full document if enabled with
FullDocumentImageOptions.setReturnFullDocumentImage(boolean)
, elsenull
-
isDateOfExpiryPermanent
public boolean isDateOfExpiryPermanent()Determines if date of expiry is permanent. -
getResidentialStatus
The residential stauts of the document owner. -
getBarcodeResult
The data extracted from the barcode. -
getPlaceOfBirth
The place of birth of the document owner. -
getAddress
The address of the document owner. -
getRace
The race of the document owner. -
getRecognitionMode
Recognition mode used to scan current document. -
getSex
The sex of the document owner. -
getFullName
The full name of the document owner. -
getDateOfBirth
The date of birth of the document owner. -
getDocumentAdditionalNumber
The additional number of the document. -
getDateOfIssue
The date of issue of the document. -
getReligion
The religion of the document owner. -
getIssuingAuthority
The issuing authority of the document. -
getVizResult
The data extracted from the visual inspection zone. -
getSignatureImage
- Specified by:
getSignatureImage
in interfaceSignatureImageResult
- Returns:
- signature image from the document if enabled with
SignatureImageOptions.setReturnSignatureImage(boolean)
, elsenull
-
getFaceImageSide
Side of the card of the face image. -
getFaceImageLocation
The face image location. -
getAge
public int getAge()The current age of the document owner in years. It is calculated difference between now and date of birth. Now is current time on the device.- Returns:
- current age of the document owner in years or
-1
if date of birth is unknown.
-
getAgeLimitStatus
Calculates whether the document owner is older than the givenageLimit
in years or not. Status is calculated by using the date of birth and the current time on the device.- Parameters:
ageLimit
- age limit in years- Returns:
- age limit status for the document owner:
-
AgeLimitStatus.OverAgeLimit
: age is greater than or equal to the given age limit -
AgeLimitStatus.BelowAgeLimit
: age is less than the given age limit -
AgeLimitStatus.NotAvailable
: date of birth is unknown
-
-
isExpired
public boolean isExpired()Checks whether the document has expired or not by comparing the current time on the device with the date of expiry.- Returns:
true
if the document has expired,false
in following cases:- document does not expire (date of expiry is permanent)
- date of expiry has passed
- date of expiry is unknown and it is not permanent
-
toString
-
serializeToByteArray
@Nullable protected byte[] serializeToByteArray()- Specified by:
serializeToByteArray
in classEntity.Result
-
deserializeFromByteArray
protected void deserializeFromByteArray(@NonNull byte[] arr) - Specified by:
deserializeFromByteArray
in classEntity.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 classRecognizer.Result
- Returns:
- a copy of the result
-
terminateNative
protected void terminateNative(long nativeContext) - Specified by:
terminateNative
in classEntity.Result
-