Class MrtdRecognizer

    • Field Detail

      • CREATOR

        public static final android.os.Parcelable.Creator<MrtdRecognizer> CREATOR
        Deprecated.
    • Constructor Detail

      • MrtdRecognizer

        public MrtdRecognizer()
        Deprecated.
    • Method Detail

      • 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'.
      • setDetectGlare

        public void setDetectGlare​(boolean detectGlare)
        Deprecated.
        Description copied from interface: GlareDetectorOptions
        Defines whether glare detector will be used during recognition process. By default this option is set to true and glare detector is used. If the glare detector is used and GlareCallback is set to MetadataCallbacks, it will receive glare status will. Also when glare is detected OCR will not be performed on the affected document position to prevent errors in the extracted data. By default, this is set to 'true'.
        Specified by:
        setDetectGlare in interface GlareDetectorOptions
        Parameters:
        detectGlare - whether glare detector will be used during recognition process.
      • shouldDetectGlare

        public boolean shouldDetectGlare()
        Deprecated.
        Description copied from interface: GlareDetectorOptions
        Returns whether glare detector is enabled. By default, this is set to 'true'.
        Specified by:
        shouldDetectGlare in interface GlareDetectorOptions
        Returns:
        it the glare detector is enabled returns true, otherwise returns 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'.
      • 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 interface EncodeFullDocumentImagesOptions
        Returns:
        whether encoding of full document images and writing them 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'.
      • 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 interface FullDocumentImageDpiOptions
        Returns:
        DPI for full document image that should be returned.
      • setFullDocumentImageDpi

        public void setFullDocumentImageDpi​(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 interface FullDocumentImageDpiOptions
        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 interface FullDocumentImageExtensionOptions
        Parameters:
        fullDocumentImageExtensionFactors - extension factors for full document image.
      • setSpecifications

        public void setSpecifications​(@Nullable
                                      MrtdSpecification... specifications)
        Deprecated.
        Sets one or more MrtdSpecification objects that will define which MRTD documents should be detectable. Setting null or empty array will enable all possible specifications.
        Parameters:
        specifications - specifications for MRTD documents that should be detectable
      • getSpecifications

        @NonNull
        public MrtdSpecification[] getSpecifications()
        Deprecated.
        Returns the array of MrtdSpecification objects that will define which MRTD documents should be detectable.
        Returns:
        the array of MrtdSpecification objects that will define which MRTD documents should be detectable.
      • setMRZFilter

        public void setMRZFilter​(@Nullable
                                 MrzFilter mrzFilter)
        Deprecated.
        Sets the MrzFilter 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.
      • clone

        public MrtdRecognizer 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 the RecognizerRunnerView or RecognizerRunner with the updated entity hierarchy.
        Specified by:
        clone in class Recognizer<MrtdRecognizer.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 inside BaseIntentTransferable.loadFromIntent(Intent) and similar methods to replace the result content of the saved entities with results that have arrived over Intent
        Overrides:
        consumeResultFrom in class TemplatingRecognizer<MrtdRecognizer.Result>
        Parameters:
        other - Entity from which result should be consumed.