All Implemented Interfaces:
android.os.Parcelable

public final class DocumentDetector extends QuadWithSizeDetector<DocumentDetector.Result>
Detector that can perform detection of card documents, cheques, papers, etc.
  • Field Details

    • CREATOR

      @NonNull public static final android.os.Parcelable.Creator<DocumentDetector> CREATOR
  • Constructor Details

    • DocumentDetector

      public DocumentDetector(@NonNull DocumentSpecification... specifications)
      Constructs detector that can perform detection of card documents, cheques, papers, etc.
      Parameters:
      specifications - Non-empty of non-null specifications describing possible documents that should be detected.
  • Method Details

    • setNumStableDetectionsThreshold

      public void setNumStableDetectionsThreshold(@IntRange(from=1L,to=255L) int numStableDetectionsThreshold)
      Sets minimum number of stable detections required for detection to be successful
      Parameters:
      numStableDetectionsThreshold - minimum number of stable detections required for detection to be successful
    • getNumStableDetectionsThreshold

      public int getNumStableDetectionsThreshold()
      Retrieves the minimum number of stable detections required for detection to be successful
      Returns:
      the minimum number of stable detections required for detection to be successful
    • getDocumentSpecifications

      @NonNull public DocumentSpecification[] getDocumentSpecifications()
    • terminateNative

      protected void terminateNative(long nativeContext)
      Specified by:
      terminateNative in class Entity<DocumentDetector.Result>
    • serializeNativeSettings

      @Nullable protected byte[] serializeNativeSettings()
      Specified by:
      serializeNativeSettings in class Entity<DocumentDetector.Result>
    • deserializeNativeSettings

      protected void deserializeNativeSettings(@NonNull byte[] serializedSettings)
      Specified by:
      deserializeNativeSettings in class Entity<DocumentDetector.Result>
    • clone

      @NonNull public DocumentDetector 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 Entity<DocumentDetector.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<DocumentDetector.Result>
      Parameters:
      other - Entity from which result should be consumed.