Package io.scanbot.sdk.document.ui

Interface IDocumentScannerViewController

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Unit setIgnoreOrientationMismatch(Boolean ignoreOrientationMismatch) Flag to determine whether to treat DetectionStatus.
      abstract Unit setAcceptedAngleScore(Double acceptedAngleScore) The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document.
      abstract Unit setAcceptedSizeScore(Double acceptedSizeScore) The minimum size in percent (0 - 100) of the screen size to accept a detected document.
      abstract Unit setAcceptedBrightnessThreshold(Double acceptedBrightnessThreshold) The brightness threshold to accept a detected document in the range of 0 (very dark) to 255 (very bright).
      abstract Unit setAcceptedAspectRatioScore(Double acceptedAspectRatioScore) The minimum score in percent (0 - 100) that the aspect ratio of the document must match one of the required aspect ratios (if any) to accept a detected document.
      abstract Unit setRequiredAspectRatios(List<AspectRatio> requiredPageAspectRatios) Set required AspectRatios.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • setIgnoreOrientationMismatch

         abstract Unit setIgnoreOrientationMismatch(Boolean ignoreOrientationMismatch)

        Flag to determine whether to treat DetectionStatus.OK_BUT_ORIENTAION_MISMATCH status as DetectionStatus.OK. Default is false

      • setAcceptedAngleScore

         abstract Unit setAcceptedAngleScore(Double acceptedAngleScore)

        The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Default is 75.0. Set lower values to accept more perspective distortion.

        Warning: Lower values result in more blurred document images.

      • setAcceptedSizeScore

         abstract Unit setAcceptedSizeScore(Double acceptedSizeScore)

        The minimum size in percent (0 - 100) of the screen size to accept a detected document. It is sufficient that height or width match the score. Default is 80.0.

        Warning: Lower values result in low resolution document images.

      • setAcceptedBrightnessThreshold

         abstract Unit setAcceptedBrightnessThreshold(Double acceptedBrightnessThreshold)

        The brightness threshold to accept a detected document in the range of 0 (very dark) to 255 (very bright). If the average brightness value of the detectors input image is below this value, the status of the detection will be set to ERROR_TOO_DARK. Default is 50.

      • setAcceptedAspectRatioScore

         abstract Unit setAcceptedAspectRatioScore(Double acceptedAspectRatioScore)

        The minimum score in percent (0 - 100) that the aspect ratio of the document must match one of the required aspect ratios (if any) to accept a detected document. If acceptedAspectRatioScore is more than 0, then the document is only accepted if the aspect ratio matches one of the given aspect ratios (if any), otherwise OK_BUT_BAD_ASPECT_RATIO is returned.

        Default is 85