Class MrtdCombinedRecognizer
- java.lang.Object
-
- com.microblink.entities.Entity<T>
-
- com.microblink.entities.recognizers.Recognizer<MrtdCombinedRecognizer.Result>
-
- com.microblink.entities.recognizers.blinkid.mrtd.MrtdCombinedRecognizer
-
- All Implemented Interfaces:
android.os.Parcelable
,CombinedRecognizer
,FaceImageDpiOptions
,FullDocumentImageDpiOptions
,EncodeFaceImageOptions
,EncodeFullDocumentImagesOptions
,FullDocumentImageExtensionOptions
,FaceImageOptions
,FullDocumentImageOptions
,JsonizableEntity
@Deprecated public final class MrtdCombinedRecognizer extends Recognizer<MrtdCombinedRecognizer.Result> implements CombinedRecognizer, FaceImageOptions, FaceImageDpiOptions, EncodeFaceImageOptions, FullDocumentImageOptions, FullDocumentImageDpiOptions, FullDocumentImageExtensionOptions, EncodeFullDocumentImagesOptions
Deprecated.Recognizer for combined reading of face from front side of documents and MRZ from back side of Machine Readable Travel Document.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MrtdCombinedRecognizer.Result
Deprecated.static class
MrtdCombinedRecognizer.VerificationConstants
Deprecated.Constants used for building JSON for the verification service, in case when result fields can be edited and/or inserted.
-
Field Summary
Fields Modifier and Type Field Description static android.os.Parcelable.Creator<MrtdCombinedRecognizer>
CREATOR
Deprecated.-
Fields inherited from interface com.microblink.entities.recognizers.blinkid.CombinedRecognizer
CLASS_NAME
-
Fields inherited from interface com.microblink.entities.recognizers.blinkid.imageoptions.encode.EncodeFaceImageOptions
CLASS_NAME
-
Fields inherited from interface com.microblink.entities.recognizers.blinkid.imageoptions.encode.EncodeFullDocumentImagesOptions
CLASS_NAME
-
Fields inherited from interface com.microblink.entities.recognizers.blinkid.imageoptions.FaceImageOptions
CLASS_NAME
-
Fields inherited from interface com.microblink.entities.recognizers.blinkid.imageoptions.FullDocumentImageOptions
CLASS_NAME
-
-
Constructor Summary
Constructors Constructor Description MrtdCombinedRecognizer()
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MrtdCombinedRecognizer
clone()
Deprecated.Create a copy of the entity.void
consumeResultFrom(Entity other)
Deprecated.Consume result from other entity.protected void
deserializeNativeSettings(byte[] serializedSettings)
Deprecated.CombinedResult
getCombinedResult()
Deprecated.Getter for combined result which is associated with this combined recognizer.DocumentFaceDetectorType
getDetectorType()
Deprecated.Returns currently used detector type.int
getFaceImageDpi()
Deprecated.Returns the DPI (Dots Per Inch) for face image that should be returned.int
getFullDocumentImageDpi()
Deprecated.Returns the DPI (Dots Per Inch) for full document image that should be returned.ImageExtensionFactors
getFullDocumentImageExtensionFactors()
Deprecated.Returns the extension factors for full document image.int
getNumStableDetectionsThreshold()
Deprecated.Minimum number of stable detections required for detection to be successful.boolean
isAllowSpecialCharacters()
Deprecated.Whether special characters are allowed.boolean
isAllowUnparsedResults()
Deprecated.Whether returning of unparsed results is allowed.boolean
isAllowUnverifiedResults()
Deprecated.Whether returning of unverified results is allowed.protected void
readFromParcel(android.os.Parcel in)
Deprecated.protected byte[]
serializeNativeSettings()
Deprecated.void
setAllowSpecialCharacters(boolean allowSpecialCharacters)
Deprecated.Whether special characters are allowed.void
setAllowUnparsedResults(boolean allowUnparsedResults)
Deprecated.Whether returning of unparsed results is allowed.void
setAllowUnverifiedResults(boolean allowUnverifiedResults)
Deprecated.Whether returning of unverified results is allowed.void
setDetectorType(DocumentFaceDetectorType detectorType)
Deprecated.Sets detector type to be used.void
setEncodeFaceImage(boolean encodeFaceImage)
Deprecated.Sets whether face image from document should be encoded in JPEG format and written into the corresponding recognition result.void
setEncodeFullDocumentImage(boolean encodeFullDocumentImage)
Deprecated.Sets whether full document image should be encoded in JPEG format and written into the corresponding recognition result.void
setFaceImageDpi(int desiredDPI)
Deprecated.Sets desired DPI (Dots Per Inch) for face image that should be returned.void
setFullDocumentImageDpi(int desiredDPI)
Deprecated.Sets desired DPI (Dots Per Inch) for full document image that should be returned.void
setFullDocumentImageExtensionFactors(ImageExtensionFactors fullDocumentImageExtensionFactors)
Deprecated.Sets extension factors for full document image.void
setMRZFilter(MrzFilter mrzFilter)
Deprecated.Sets theMrzFilter
that can determine whether document should be processed or filtered out.void
setNumStableDetectionsThreshold(int numStableDetectionsThreshold)
Deprecated.Minimum number of stable detections required for detection to be successful.void
setReturnFaceImage(boolean returnFaceImage)
Deprecated.Sets whether face image from document should be available inFaceImageResult
.void
setReturnFullDocumentImage(boolean returnFullDocumentImage)
Deprecated.Sets whether full document image should be available inFullDocumentImageResult
.boolean
shouldEncodeFaceImage()
Deprecated.Returns whether encoding of face image from document and writing it into the recognition result is enabled.boolean
shouldEncodeFullDocumentImage()
Deprecated.Returns whether encoding of full document images and writing them into the recognition result is enabled.boolean
shouldReturnFaceImage()
Deprecated.Returns whether face image will be available inFaceImageResult
.boolean
shouldReturnFullDocumentImage()
Deprecated.Returns whether full document image will be available inFullDocumentImageResult
.protected void
terminateNative(long nativeContext)
Deprecated.void
writeToParcel(android.os.Parcel dest, int flags)
Deprecated.-
Methods inherited from class com.microblink.entities.recognizers.Recognizer
getName, isExcludedFromPing, requiresAutofocus, requiresLandscapeMode, signedJsonNativeGet, toSignedJson
-
Methods inherited from class com.microblink.entities.Entity
describeContents, finalize, getNativeContext, getResult, nativeGetNativeResultContext
-
-
-
-
Field Detail
-
CREATOR
public static final android.os.Parcelable.Creator<MrtdCombinedRecognizer> CREATOR
Deprecated.
-
-
Method Detail
-
setReturnFaceImage
public void setReturnFaceImage(boolean returnFaceImage)
Deprecated.Description copied from interface:FaceImageOptions
Sets whether face image from document should be available inFaceImageResult
. If enabled, get image usingFaceImageResult.getFaceImage()
By default, this is set to 'false'. IMPORTANT NOTE: If you setMicroblinkSDK.setIntentDataTransferMode(com.microblink.intent.IntentDataTransferMode)
toIntentDataTransferMode.STANDARD
recognizer which contains encoded image cannot be parcelized and passed byIntent
extras because of Android limitations on intent extras size. If you are using one of the provided scan activities and expect receiving scan results inActivity.onActivityResult(int, int, android.content.Intent)
method use eitherIntentDataTransferMode.OPTIMISED
orIntentDataTransferMode.PERSISTED_OPTIMISED
- Specified by:
setReturnFaceImage
in interfaceFaceImageOptions
- Parameters:
returnFaceImage
- whether face image will be available inFaceImageResult
.
-
shouldReturnFaceImage
public boolean shouldReturnFaceImage()
Deprecated.Description copied from interface:FaceImageOptions
Returns whether face image will be available inFaceImageResult
. By default, this is set to 'false'.- Specified by:
shouldReturnFaceImage
in interfaceFaceImageOptions
- Returns:
- whether face image will be available in
FaceImageResult
.
-
setAllowSpecialCharacters
public void setAllowSpecialCharacters(boolean allowSpecialCharacters)
Deprecated.Whether special characters are allowed. By default, this is set to 'false'.
-
isAllowSpecialCharacters
public boolean isAllowSpecialCharacters()
Deprecated.Whether special characters are allowed. By default, this is set to 'false'.
-
setAllowUnverifiedResults
public void setAllowUnverifiedResults(boolean allowUnverifiedResults)
Deprecated.Whether returning of unverified results is allowed. Unverified result is result that is parsed, but check digits are incorrect. By default, this is set to 'false'.
-
isAllowUnverifiedResults
public boolean isAllowUnverifiedResults()
Deprecated.Whether returning of unverified results is allowed. Unverified result is result that is parsed, but check digits are incorrect. By default, this is set to 'false'.
-
setReturnFullDocumentImage
public void setReturnFullDocumentImage(boolean returnFullDocumentImage)
Deprecated.Description copied from interface:FullDocumentImageOptions
Sets whether full document image should be available inFullDocumentImageResult
. If enabled, get image usingFullDocumentImageResult.getFullDocumentImage()
By default, this is set to 'false'. IMPORTANT NOTE: If you setMicroblinkSDK.setIntentDataTransferMode(com.microblink.intent.IntentDataTransferMode)
toIntentDataTransferMode.STANDARD
recognizer which contains encoded image cannot be parcelized and passed byIntent
extras because of Android limitations on intent extras size. If you are using one of the provided scan activities and expect receiving scan results inActivity.onActivityResult(int, int, android.content.Intent)
method use eitherIntentDataTransferMode.OPTIMISED
orIntentDataTransferMode.PERSISTED_OPTIMISED
By default, this is set to 'false'- Specified by:
setReturnFullDocumentImage
in interfaceFullDocumentImageOptions
- Parameters:
returnFullDocumentImage
- whether full document image will be available inFullDocumentImageResult
.
-
shouldReturnFullDocumentImage
public boolean shouldReturnFullDocumentImage()
Deprecated.Description copied from interface:FullDocumentImageOptions
Returns whether full document image will be available inFullDocumentImageResult
. By default, this is set to 'false'. By default, this is set to 'false'- Specified by:
shouldReturnFullDocumentImage
in interfaceFullDocumentImageOptions
- Returns:
- whether full document image will be available in
FullDocumentImageResult
.
-
setEncodeFullDocumentImage
public void setEncodeFullDocumentImage(boolean encodeFullDocumentImage)
Deprecated.Description copied from interface:EncodeFullDocumentImagesOptions
Sets whether full document image should be encoded in JPEG format and written into the corresponding recognition result. By default, this is set to 'false'.
IMPORTANT NOTE: If you setMicroblinkSDK.setIntentDataTransferMode(com.microblink.intent.IntentDataTransferMode)
toIntentDataTransferMode.STANDARD
recognizer which contains encoded image cannot be parcelized and passed byIntent
extras because of Android limitations on intent extras size. If you are using one of the provided scan activities and expect receiving scan results inActivity.onActivityResult(int, int, Intent)
method use eitherIntentDataTransferMode.OPTIMISED
orIntentDataTransferMode.PERSISTED_OPTIMISED
- Specified by:
setEncodeFullDocumentImage
in interfaceEncodeFullDocumentImagesOptions
- Parameters:
encodeFullDocumentImage
- whether full document images should be encoded in JPEG format and written into the corresponding recognition result.
-
shouldEncodeFullDocumentImage
public boolean shouldEncodeFullDocumentImage()
Deprecated.Description copied from interface:EncodeFullDocumentImagesOptions
Returns whether encoding of full document images and writing them into the recognition result is enabled. By default, this is set to 'false'.- Specified by:
shouldEncodeFullDocumentImage
in interfaceEncodeFullDocumentImagesOptions
- Returns:
- whether encoding of full document images and writing them into the recognition result is enabled.
-
setNumStableDetectionsThreshold
public void setNumStableDetectionsThreshold(@IntRange(from=1L,to=255L) int numStableDetectionsThreshold)
Deprecated.Minimum number of stable detections required for detection to be successful. By default, this is set to '6'.
-
getNumStableDetectionsThreshold
@IntRange(from=1L, to=255L) public int getNumStableDetectionsThreshold()
Deprecated.Minimum number of stable detections required for detection to be successful. By default, this is set to '6'.
-
setEncodeFaceImage
public void setEncodeFaceImage(boolean encodeFaceImage)
Deprecated.Description copied from interface:EncodeFaceImageOptions
Sets whether face image from document should be encoded in JPEG format and written into the corresponding recognition result. By default, this is set to 'false'.
IMPORTANT NOTE: If you setMicroblinkSDK.setIntentDataTransferMode(com.microblink.intent.IntentDataTransferMode)
toIntentDataTransferMode.STANDARD
recognizer which contains encoded image cannot be parcelized and passed byIntent
extras because of Android limitations on intent extras size. If you are using one of the provided scan activities and expect receiving scan results inActivity.onActivityResult(int, int, android.content.Intent)
method use eitherIntentDataTransferMode.OPTIMISED
orIntentDataTransferMode.PERSISTED_OPTIMISED
- Specified by:
setEncodeFaceImage
in interfaceEncodeFaceImageOptions
- Parameters:
encodeFaceImage
- whether face image should be encoded in JPEG format and written into the corresponding recognition result.
-
shouldEncodeFaceImage
public boolean shouldEncodeFaceImage()
Deprecated.Description copied from interface:EncodeFaceImageOptions
Returns whether encoding of face image from document and writing it into the recognition result is enabled. By default, this is set to 'false'.- Specified by:
shouldEncodeFaceImage
in interfaceEncodeFaceImageOptions
- Returns:
- whether encoding of face image from document and writing it into the recognition result is enabled.
-
setAllowUnparsedResults
public void setAllowUnparsedResults(boolean allowUnparsedResults)
Deprecated.Whether returning of unparsed results is allowed. By default, this is set to 'false'.
-
isAllowUnparsedResults
public boolean isAllowUnparsedResults()
Deprecated.Whether returning of unparsed results is allowed. By default, this is set to 'false'.
-
getFaceImageDpi
public int getFaceImageDpi()
Deprecated.Returns the DPI (Dots Per Inch) for face image that should be returned. By default, this is set to '250'.- Specified by:
getFaceImageDpi
in interfaceFaceImageDpiOptions
- Returns:
- DPI for face image that should be returned.
-
setFaceImageDpi
public void setFaceImageDpi(@IntRange(from=100L,to=400L) int desiredDPI)
Deprecated.Sets desired DPI (Dots Per Inch) for face image that should be returned. By default, this is set to '250'.- Specified by:
setFaceImageDpi
in interfaceFaceImageDpiOptions
- Parameters:
desiredDPI
- desired DPI in range [100, 400]
-
getFullDocumentImageDpi
public int getFullDocumentImageDpi()
Deprecated.Returns the DPI (Dots Per Inch) for full document image that should be returned. By default, this is set to '250'.- Specified by:
getFullDocumentImageDpi
in interfaceFullDocumentImageDpiOptions
- Returns:
- DPI for full document image that should be returned.
-
setFullDocumentImageDpi
public void setFullDocumentImageDpi(@IntRange(from=100L,to=400L) int desiredDPI)
Deprecated.Sets desired DPI (Dots Per Inch) for full document image that should be returned. By default, this is set to '250'.- Specified by:
setFullDocumentImageDpi
in interfaceFullDocumentImageDpiOptions
- Parameters:
desiredDPI
- desired DPI in range [100, 400]
-
setFullDocumentImageExtensionFactors
public void setFullDocumentImageExtensionFactors(@NonNull ImageExtensionFactors fullDocumentImageExtensionFactors)
Deprecated.Sets extension factors for full document image. By default, this is set to '[0.0, 0.0, 0.0, 0.0]'.- Specified by:
setFullDocumentImageExtensionFactors
in interfaceFullDocumentImageExtensionOptions
- Parameters:
fullDocumentImageExtensionFactors
- extension factors for full document image.
-
getFullDocumentImageExtensionFactors
@NonNull public ImageExtensionFactors getFullDocumentImageExtensionFactors()
Deprecated.Returns the extension factors for full document image. By default, this is set to '[0.0, 0.0, 0.0, 0.0]'.- Specified by:
getFullDocumentImageExtensionFactors
in interfaceFullDocumentImageExtensionOptions
- Returns:
- extension factors for full document image.
-
getCombinedResult
@Nullable public CombinedResult getCombinedResult()
Deprecated.Getter for combined result which is associated with this combined recognizer.- Specified by:
getCombinedResult
in interfaceCombinedRecognizer
- Returns:
- combined result which is associated with this combined recognizer.
-
getDetectorType
public DocumentFaceDetectorType getDetectorType()
Deprecated.Returns currently used detector type. By default, this is set to 'IDENTITY_CARD_TD1'- Returns:
- currently used detector type
-
setDetectorType
public void setDetectorType(DocumentFaceDetectorType detectorType)
Deprecated.Sets detector type to be used. By default, this is set to 'IDENTITY_CARD_TD1'- Parameters:
detectorType
- to be used
-
setMRZFilter
public void setMRZFilter(@Nullable MrzFilter mrzFilter)
Deprecated.Sets theMrzFilter
that can determine whether document should be processed or filtered out.- Parameters:
mrzFilter
-MrzFilter
that can determine whether document should be processed or filtered out or null to allow processing of all documents.
-
writeToParcel
public void writeToParcel(@NonNull android.os.Parcel dest, int flags)
Deprecated.- Specified by:
writeToParcel
in interfaceandroid.os.Parcelable
- Overrides:
writeToParcel
in classEntity<MrtdCombinedRecognizer.Result>
-
readFromParcel
protected void readFromParcel(@NonNull android.os.Parcel in)
Deprecated.- Overrides:
readFromParcel
in classEntity<MrtdCombinedRecognizer.Result>
-
terminateNative
protected void terminateNative(long nativeContext)
Deprecated.- Specified by:
terminateNative
in classEntity<MrtdCombinedRecognizer.Result>
-
serializeNativeSettings
@Nullable protected byte[] serializeNativeSettings()
Deprecated.- Specified by:
serializeNativeSettings
in classEntity<MrtdCombinedRecognizer.Result>
-
deserializeNativeSettings
protected void deserializeNativeSettings(@NonNull byte[] serializedSettings)
Deprecated.- Specified by:
deserializeNativeSettings
in classEntity<MrtdCombinedRecognizer.Result>
-
clone
public MrtdCombinedRecognizer clone()
Deprecated.Description copied from class:Entity
Create a copy of the entity. This is required if properties of the entity must be modified while background thread performs processing. In order to avoid race conditions, changing properties is not allowed while entity is used in background processing. However, you are able to make a copy of the entity, change properties of it and then update theRecognizerRunnerView
orRecognizerRunner
with the updated entity hierarchy.- Specified by:
clone
in classRecognizer<MrtdCombinedRecognizer.Result>
- Returns:
- a copy of the entity
-
consumeResultFrom
public void consumeResultFrom(@NonNull Entity other)
Deprecated.Description copied from class:Entity
Consume result from other entity. The result from other will be put instead current result of this entity. This method is used insideBaseIntentTransferable.loadFromIntent(Intent)
and similar methods to replace the result content of the saved entities with results that have arrived overIntent
- Specified by:
consumeResultFrom
in classEntity<MrtdCombinedRecognizer.Result>
- Parameters:
other
- Entity from which result should be consumed.
-
-