Class DocumentFaceRecognizer
java.lang.Object
com.microblink.blinkid.entities.Entity<T>
com.microblink.blinkid.entities.recognizers.Recognizer<DocumentFaceRecognizer.Result>
com.microblink.blinkid.entities.recognizers.blinkid.documentface.DocumentFaceRecognizer
- All Implemented Interfaces:
android.os.Parcelable
,FaceImageDpiOptions
,FullDocumentImageDpiOptions
,EncodeFaceImageOptions
,EncodeFullDocumentImagesOptions
,FullDocumentImageExtensionOptions
,FaceImageOptions
,FullDocumentImageOptions
,JsonizableEntity
@Deprecated
public final class DocumentFaceRecognizer
extends Recognizer<DocumentFaceRecognizer.Result>
implements FullDocumentImageOptions, FullDocumentImageDpiOptions, FullDocumentImageExtensionOptions, EncodeFullDocumentImagesOptions, FaceImageOptions, FaceImageDpiOptions, EncodeFaceImageOptions
Deprecated.
Recognizer for detecting holder's photo on documents containing image.
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final android.os.Parcelable.Creator<DocumentFaceRecognizer>
Deprecated.Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageoptions.encode.EncodeFaceImageOptions
CLASS_NAME
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageoptions.encode.EncodeFullDocumentImagesOptions
CLASS_NAME
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageoptions.FaceImageOptions
CLASS_NAME
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageoptions.FullDocumentImageOptions
CLASS_NAME
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
Constructor Summary
ConstructorDescriptionDeprecated.DocumentFaceRecognizer
(DocumentFaceDetectorType detectorType) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Deprecated.Create a copy of the entity.void
consumeResultFrom
(Entity other) Deprecated.Consume result from other entity.protected void
deserializeNativeSettings
(byte[] serializedSettings) Deprecated.Deprecated.Returns currently used detector type.int
Deprecated.Returns the DPI (Dots Per Inch) for face image that should be returned.int
Deprecated.Returns the DPI (Dots Per Inch) for full document image that should be returned.Deprecated.Returns the extension factors for full document image.int
Deprecated.Minimum number of stable detections required for detection to be successful.protected byte[]
Deprecated.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
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
Deprecated.Returns whether encoding of face image from document and writing it into the recognition result is enabled.boolean
Deprecated.Returns whether encoding of full document images and writing them into the recognition result is enabled.boolean
Deprecated.Returns whether face image will be available inFaceImageResult
.boolean
Deprecated.Returns whether full document image will be available inFullDocumentImageResult
.protected void
terminateNative
(long nativeContext) Deprecated.Methods inherited from class com.microblink.blinkid.entities.recognizers.Recognizer
getName, isExcludedFromPing, requiresAutofocus, requiresLandscapeMode, signedJsonNativeGet, toSignedJson
Methods inherited from class com.microblink.blinkid.entities.Entity
describeContents, finalize, getNativeContext, getResult, nativeGetNativeResultContext, readFromParcel, writeToParcel
-
Field Details
-
CREATOR
Deprecated.
-
-
Constructor Details
-
DocumentFaceRecognizer
Deprecated. -
DocumentFaceRecognizer
public DocumentFaceRecognizer()Deprecated.
-
-
Method Details
-
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.blinkid.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
.
-
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.blinkid.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.blinkid.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.blinkid.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.
-
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
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.
-
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]
-
getDetectorType
Deprecated.Returns currently used detector type. By default, this is set to 'IDENTITY_CARD_TD1'- Returns:
- currently used detector type
-
setDetectorType
Deprecated.Sets detector type to be used. By default, this is set to 'IDENTITY_CARD_TD1'- Parameters:
detectorType
- to be used
-
terminateNative
protected void terminateNative(long nativeContext) Deprecated.- Specified by:
terminateNative
in classEntity<DocumentFaceRecognizer.Result>
-
serializeNativeSettings
@Nullable protected byte[] serializeNativeSettings()Deprecated.- Specified by:
serializeNativeSettings
in classEntity<DocumentFaceRecognizer.Result>
-
deserializeNativeSettings
protected void deserializeNativeSettings(@NonNull byte[] serializedSettings) Deprecated.- Specified by:
deserializeNativeSettings
in classEntity<DocumentFaceRecognizer.Result>
-
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<DocumentFaceRecognizer.Result>
- Returns:
- a copy of the entity
-
consumeResultFrom
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<DocumentFaceRecognizer.Result>
- Parameters:
other
- Entity from which result should be consumed.
-