Package com.microblink.blinkid.entities.recognizers.blinkid.mrtd

Class MrtdCombinedRecognizer

java.lang.Object
com.microblink.blinkid.entities.Entity<T>
com.microblink.blinkid.entities.recognizers.Recognizer<MrtdCombinedRecognizer.Result>
com.microblink.blinkid.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.

  • Field Details

  • Constructor Details

    • MrtdCombinedRecognizer

      public MrtdCombinedRecognizer()
      Deprecated.

  • Method Details

    • setReturnFaceImage

      public void setReturnFaceImage(boolean returnFaceImage)
      Deprecated.
      Description copied from interface: FaceImageOptions
      Sets whether face image from document should be available in FaceImageResult. If enabled, get image using FaceImageResult.getFaceImage() By default, this is set to 'false'. IMPORTANT NOTE: If you set MicroblinkSDK.setIntentDataTransferMode(com.microblink.blinkid.intent.IntentDataTransferMode) to IntentDataTransferMode.STANDARD recognizer which contains encoded image cannot be parcelized and passed by Intent extras because of Android limitations on intent extras size. If you are using one of the provided scan activities and expect receiving scan results in Activity.onActivityResult(int, int, android.content.Intent) method use either IntentDataTransferMode.OPTIMISED or IntentDataTransferMode.PERSISTED_OPTIMISED
      Specified by:
      setReturnFaceImage in interface FaceImageOptions
      Parameters:
      returnFaceImage - whether face image will be available in FaceImageResult.

    • shouldReturnFaceImage

      public boolean shouldReturnFaceImage()
      Deprecated.
      Description copied from interface: FaceImageOptions
      Returns whether face image will be available in FaceImageResult. By default, this is set to 'false'.
      Specified by:
      shouldReturnFaceImage in interface FaceImageOptions
      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 in FullDocumentImageResult. If enabled, get image using FullDocumentImageResult.getFullDocumentImage() By default, this is set to 'false'. IMPORTANT NOTE: If you set MicroblinkSDK.setIntentDataTransferMode(com.microblink.blinkid.intent.IntentDataTransferMode) to IntentDataTransferMode.STANDARD recognizer which contains encoded image cannot be parcelized and passed by Intent extras because of Android limitations on intent extras size. If you are using one of the provided scan activities and expect receiving scan results in Activity.onActivityResult(int, int, android.content.Intent) method use either IntentDataTransferMode.OPTIMISED or IntentDataTransferMode.PERSISTED_OPTIMISED By default, this is set to 'false'
      Specified by:
      setReturnFullDocumentImage in interface FullDocumentImageOptions
      Parameters:
      returnFullDocumentImage - whether full document image will be available in FullDocumentImageResult.

    • shouldReturnFullDocumentImage

      public boolean shouldReturnFullDocumentImage()
      Deprecated.
      Description copied from interface: FullDocumentImageOptions
      Returns whether full document image will be available in FullDocumentImageResult. By default, this is set to 'false'. By default, this is set to 'false'
      Specified by:
      shouldReturnFullDocumentImage in interface FullDocumentImageOptions
      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 set MicroblinkSDK.setIntentDataTransferMode(com.microblink.blinkid.intent.IntentDataTransferMode) to IntentDataTransferMode.STANDARD recognizer which contains encoded image cannot be parcelized and passed by Intent extras because of Android limitations on intent extras size. If you are using one of the provided scan activities and expect receiving scan results in Activity.onActivityResult(int, int, Intent) method use either IntentDataTransferMode.OPTIMISED or IntentDataTransferMode.PERSISTED_OPTIMISED
      Specified by:
      setEncodeFullDocumentImage in interface EncodeFullDocumentImagesOptions
      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 interface EncodeFullDocumentImagesOptions
      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 set MicroblinkSDK.setIntentDataTransferMode(com.microblink.blinkid.intent.IntentDataTransferMode) to IntentDataTransferMode.STANDARD recognizer which contains encoded image cannot be parcelized and passed by Intent extras because of Android limitations on intent extras size. If you are using one of the provided scan activities and expect receiving scan results in Activity.onActivityResult(int, int, android.content.Intent) method use either IntentDataTransferMode.OPTIMISED or IntentDataTransferMode.PERSISTED_OPTIMISED
      Specified by:
      setEncodeFaceImage in interface EncodeFaceImageOptions
      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 interface EncodeFaceImageOptions
      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 interface FaceImageDpiOptions
      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 interface FaceImageDpiOptions
      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 interface FullDocumentImageDpiOptions
      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 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.

    • 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 interface FullDocumentImageExtensionOptions
      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 interface CombinedRecognizer
      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 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.

    • writeToParcel

      public void writeToParcel(@NonNull android.os.Parcel dest, int flags)
      Deprecated.
      Specified by:
      writeToParcel in interface android.os.Parcelable
      Overrides:
      writeToParcel in class Entity<MrtdCombinedRecognizer.Result>

    • readFromParcel

      protected void readFromParcel(@NonNull android.os.Parcel in)
      Deprecated.
      Overrides:
      readFromParcel in class Entity<MrtdCombinedRecognizer.Result>

    • terminateNative

      protected void terminateNative(long nativeContext)
      Deprecated.
      Specified by:
      terminateNative in class Entity<MrtdCombinedRecognizer.Result>

    • serializeNativeSettings

      @Nullable protected byte[] serializeNativeSettings()
      Deprecated.
      Specified by:
      serializeNativeSettings in class Entity<MrtdCombinedRecognizer.Result>

    • deserializeNativeSettings

      protected void deserializeNativeSettings(@NonNull byte[] serializedSettings)
      Deprecated.
      Specified by:
      deserializeNativeSettings in class Entity<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 the RecognizerRunnerView or RecognizerRunner with the updated entity hierarchy.
      Specified by:
      clone in class Recognizer<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 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<MrtdCombinedRecognizer.Result>
      Parameters:
      other - Entity from which result should be consumed.