Package com.microblink.documentverification.entities.recognizers.blinkid.generic

Class BlinkIdCombinedRecognizer

    • Constructor Detail

      • BlinkIdCombinedRecognizer

        public BlinkIdCombinedRecognizer()

    • Method Detail

      • setValidateResultCharacters

        public void setValidateResultCharacters​(boolean validateResultCharacters)
        Whether result characters validatation is performed. If a result member contains invalid character, the result state cannot be valid. By default, this is set to 'true'.

      • shouldValidateResultCharacters

        public boolean shouldValidateResultCharacters()
        Whether result characters validatation is performed. If a result member contains invalid character, the result state cannot be valid. By default, this is set to 'true'.

      • setScanCroppedDocumentImage

        public void setScanCroppedDocumentImage​(boolean scanCroppedDocumentImage)
        Configure the recognizer to only work on already cropped and dewarped images. This only works for still images - video feeds will ignore this setting. By default, this is set to 'false'.

      • shouldScanCroppedDocumentImage

        public boolean shouldScanCroppedDocumentImage()
        Configure the recognizer to only work on already cropped and dewarped images. This only works for still images - video feeds will ignore this setting. By default, this is set to 'false'.

      • setSaveCameraFrames

        public void setSaveCameraFrames​(boolean saveCameraFrames)
        Configure the recognizer to save the raw camera frames. This significantly increases memory consumption. By default, this is set to 'false'.

      • shouldSaveCameraFrames

        public boolean shouldSaveCameraFrames()
        Configure the recognizer to save the raw camera frames. This significantly increases memory consumption. By default, this is set to 'false'.

      • shouldEncodeFullDocumentImage

        public boolean shouldEncodeFullDocumentImage()
        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 interface EncodeFullDocumentImagesOptions
        Returns:
        whether encoding of full document images and writing them into the recognition result is enabled.

      • setAllowUnverifiedMrzResults

        public void setAllowUnverifiedMrzResults​(boolean allowUnverifiedMrzResults)
        Defines whether returning unverified MRZ (Machine Readable Zone) results is allowed. Unverified MRZ is parsed, but check digits are incorrect. By default, this is set to 'true'.

      • shouldAllowUnverifiedMrzResults

        public boolean shouldAllowUnverifiedMrzResults()
        Defines whether returning unverified MRZ (Machine Readable Zone) results is allowed. Unverified MRZ is parsed, but check digits are incorrect. By default, this is set to 'true'.

      • shouldEncodeFaceImage

        public boolean shouldEncodeFaceImage()
        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 interface EncodeFaceImageOptions
        Returns:
        whether encoding of face image from document and writing it into the recognition result is enabled.

      • setPaddingEdge

        public void setPaddingEdge​(@FloatRange(from=0.0,to=1.0)
                           float paddingEdge)
        Padding is a minimum distance from the edge of the frame and it is defined as a percentage of the frame width. Recommended value is '0.02'. By default, this is set to '0.0' which means that padding edge and image edge are the same.

      • getPaddingEdge

        @FloatRange(from=0.0,
            to=1.0)
public float getPaddingEdge()
        Padding is a minimum distance from the edge of the frame and it is defined as a percentage of the frame width. Recommended value is '0.02'. By default, this is set to '0.0' which means that padding edge and image edge are the same.

      • shouldEncodeSignatureImage

        public boolean shouldEncodeSignatureImage()
        Description copied from interface: EncodeSignatureImageOptions
        Returns whether encoding of signature image and writing it into the recognition result is enabled. By default, this is set to 'false'.
        Specified by:
        shouldEncodeSignatureImage in interface EncodeSignatureImageOptions
        Returns:
        whether encoding of signature image and writing it into the recognition result is enabled.

      • setMaxAllowedMismatchesPerField

        public void setMaxAllowedMismatchesPerField​(@IntRange(from=0L)
                                            int maxAllowedMismatchesPerField)
        Configure the number of characters per field that are allowed to be inconsistent in data match. By default, this is set to '0'.

      • getMaxAllowedMismatchesPerField

        @IntRange(from=0L)
public int getMaxAllowedMismatchesPerField()
        Configure the number of characters per field that are allowed to be inconsistent in data match. By default, this is set to '0'.

      • setAllowBlurFilter

        public void setAllowBlurFilter​(boolean allowBlurFilter)
        Defines whether blured frames filtering is allowed. By default, this is set to 'true'

      • shouldAllowBlurFilter

        public boolean shouldAllowBlurFilter()
        Defines whether blured frames filtering is allowed. By default, this is set to 'true'

      • setAllowUncertainFrontSideScan

        public void setAllowUncertainFrontSideScan​(boolean allowUncertainFrontSideScan)
        Proceed with scanning the back side even if the front side result is uncertain. This only works for still images - video feeds will ignore this setting. By default, this is set to 'false'.

      • shouldAllowUncertainFrontSideScan

        public boolean shouldAllowUncertainFrontSideScan()
        Proceed with scanning the back side even if the front side result is uncertain. This only works for still images - video feeds will ignore this setting. By default, this is set to 'false'.

      • setAllowUnparsedMrzResults

        public void setAllowUnparsedMrzResults​(boolean allowUnparsedMrzResults)
        Defines whether returning of unparsed MRZ (Machine Readable Zone) results is allowed. By default, this is set to 'false'.

      • shouldAllowUnparsedMrzResults

        public boolean shouldAllowUnparsedMrzResults()
        Defines whether returning of unparsed MRZ (Machine Readable Zone) results is allowed. By default, this is set to 'false'.

      • setAnonymizationMode

        public void setAnonymizationMode​(@NonNull
                                 AnonymizationMode anonymizationMode)
        Whether sensitive data should be removed from images, result fields or both. The setting only applies to certain documents. By default, this is set to 'FullResult'.

      • getAnonymizationMode

        @NonNull
public AnonymizationMode getAnonymizationMode()
        Whether sensitive data should be removed from images, result fields or both. The setting only applies to certain documents. By default, this is set to 'FullResult'.

      • setSkipUnsupportedBack

        public void setSkipUnsupportedBack​(boolean skipUnsupportedBack)
        Skip back side capture and processing step when back side of the document is not supported. By default, this is set to 'false'.

      • shouldSkipUnsupportedBack

        public boolean shouldSkipUnsupportedBack()
        Skip back side capture and processing step when back side of the document is not supported. By default, this is set to 'false'.

      • getFaceImageDpi

        public int getFaceImageDpi()
        Returns the DPI (Dots Per Inch) for face image that should be returned. By default, this is set to '250'.
        Specified by:
        getFaceImageDpi in interface FaceImageDpiOptions
        Returns:
        DPI for face image that should be returned.

      • setFaceImageDpi

        public void setFaceImageDpi​(@IntRange(from=100L,to=400L)
                            int desiredDPI)
        Sets desired DPI (Dots Per Inch) for face image that should be returned. By default, this is set to '250'.
        Specified by:
        setFaceImageDpi in interface FaceImageDpiOptions
        Parameters:
        desiredDPI - desired DPI in range [100, 400]

      • getFullDocumentImageDpi

        public int getFullDocumentImageDpi()
        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 interface FullDocumentImageDpiOptions
        Returns:
        DPI for full document image that should be returned.

      • setFullDocumentImageDpi

        public void setFullDocumentImageDpi​(@IntRange(from=100L,to=400L)
                                    int desiredDPI)
        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 interface FullDocumentImageDpiOptions
        Parameters:
        desiredDPI - desired DPI in range [100, 400]

      • getSignatureImageDpi

        public int getSignatureImageDpi()
        Returns the DPI (Dots Per Inch) for signature image that should be returned. By default, this is set to '250'.
        Specified by:
        getSignatureImageDpi in interface SignatureImageDpiOptions
        Returns:
        DPI for signature image that should be returned.

      • setSignatureImageDpi

        public void setSignatureImageDpi​(@IntRange(from=100L,to=400L)
                                 int desiredDPI)
        Sets desired DPI (Dots Per Inch) for signature image that should be returned. By default, this is set to '250'.
        Specified by:
        setSignatureImageDpi in interface SignatureImageDpiOptions
        Parameters:
        desiredDPI - desired DPI in range [100, 400]

      • setRecognitionModeFilter

        public void setRecognitionModeFilter​(@NonNull
                                     RecognitionModeFilter recognitionModeFilter)
        Enable or disable recognition of specific document groups supported by the current license. By default, this is set to '[true, true, true, true, true, true]'.

      • getRecognitionModeFilter

        @NonNull
public RecognitionModeFilter getRecognitionModeFilter()
        Returns currently set recognition mode filter. By default, this is set to 'all modes are enabled'.

      • setClassFilter

        public void setClassFilter​(@Nullable
                           ClassFilter classFilter)
        Sets the ClassFilter that can determine whether document should be processed or filtered out.
        Parameters:
        classFilter - ClassFilter that can determine whether document should be processed or filtered out or null to allow processing of all documents.

      • getCombinedResult

        @Nullable
public CombinedResult getCombinedResult()
        Getter for combined result which is associated with this combined recognizer.
        Specified by:
        getCombinedResult in interface CombinedRecognizer
        Returns:
        combined result which is associated with this combined recognizer.

      • clone

        public BlinkIdCombinedRecognizer clone()
        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 the RecognizerRunnerView or RecognizerRunner with the updated entity hierarchy.
        Specified by:
        clone in class Recognizer<BlinkIdCombinedRecognizer.Result>
        Returns:
        a copy of the entity

      • consumeResultFrom

        public void consumeResultFrom​(@NonNull
                              Entity other)
        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 inside BaseIntentTransferable.loadFromIntent(Intent) and similar methods to replace the result content of the saved entities with results that have arrived over Intent
        Specified by:
        consumeResultFrom in class Entity<BlinkIdCombinedRecognizer.Result>
        Parameters:
        other - Entity from which result should be consumed.