Package io.scanbot.sdk.common

Enum ProcessingMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ProcessingMode>
    public enum ProcessingMode
extends java.lang.Enum<ProcessingMode>
    Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it. On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AUTO
      The scanner chooses live or single-shot mode based on the source of the image.
      LIVE
      In live mode input images are expected to come from a video source like a camera.
      SINGLE_SHOT
      In single-shot the scanner tries to extract the maximum amount of information possible from each input image.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ProcessingMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ProcessingMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • LIVE

        public static final ProcessingMode LIVE
        In live mode input images are expected to come from a video source like a camera. Scanners in live mode typically spend little time on each image and are able to quickly analyze multiple images and combine the individual image results into a final result. Individual results from a particular image may be less accurate than running the scanner in single-shot mode on that frame, but after aggregating a few images of the same subject, the final result becomes much more accurate.

      • SINGLE_SHOT

        public static final ProcessingMode SINGLE_SHOT
        In single-shot the scanner tries to extract the maximum amount of information possible from each input image. The scanner typically spends much longer on analyzing the image to ensure that all available information has been extracted.

      • AUTO

        public static final ProcessingMode AUTO
        The scanner chooses live or single-shot mode based on the source of the image. An image constructed with RawImageLoadOptions.liveSource equal to true will be processed in live mode, otherwise it will be processed in single-shot mode. On Android liveSource is automatically set to true if the ImageRef is created from Nv21 image data. On iOS liveSource is automatically set to true if the ImageRef is created from a CMSampleBuffer.

    • Method Detail

      • values

        public static ProcessingMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ProcessingMode c : ProcessingMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ProcessingMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null