Package com.cognex.cmbsdk

Class PreviewOption

java.lang.Object
com.cognex.cmbsdk.PreviewOption
public class PreviewOption extends Object
Controls the preview/scanning options when using the Mobile device camera. Preview defaults are set by the CameraMode but can be overridden. Multiple options can be OR'd together.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALWAYS_SHOW
    Force the preview to be displayed, even if off by default (e.g., when using CameraMode.PASSIVE_AIMER).
    static final int
    DEFAULTS
    Use defaults (no overrides).
    static final int
    HARDWARE_TRIGGER
    Enables the simulated hardware trigger (the volume down button).
    static final int
    HIGH_FRAME_RATE
    Use higher framerate if the device supports it.
    static final int
    HIGH_RESOLUTION
    Use higher resolution if the device supports it.
    static final int
    KEEP_PREVIEW_IN_PAUSED_STATE
    Keep the preview in paused state after read
    static final int
    NO_ILLUMINATION_BUTTON
    Disable illumination (removes illumination button from preview).
    static final int
    NO_ZOOM_BUTTON
    Disable zoom feature (removes zoom button from preview).
    static final int
    PAUSED
    When scanning starts, the preview is displayed but decoding is paused until a trigger (either the on screen button or the volume down button, if enabled) is pressed.
    static final int
    QHD_RESOLUTION
    Use 2K resolution if the device supports it.
    static final int
    SHOW_CLOSE_BUTTON
    Show close button in partial view.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PreviewOption()
     

  • Method Summary

    Methods inherited from class java.lang.Object

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

  • Field Details

    • DEFAULTS

      public static final int DEFAULTS
      Use defaults (no overrides).
      See Also:

    • NO_ZOOM_BUTTON

      public static final int NO_ZOOM_BUTTON
      Disable zoom feature (removes zoom button from preview).
      See Also:

    • NO_ILLUMINATION_BUTTON

      public static final int NO_ILLUMINATION_BUTTON
      Disable illumination (removes illumination button from preview).
      See Also:

    • HARDWARE_TRIGGER

      public static final int HARDWARE_TRIGGER
      Enables the simulated hardware trigger (the volume down button).
      See Also:

    • PAUSED

      public static final int PAUSED
      When scanning starts, the preview is displayed but decoding is paused until a trigger (either the on screen button or the volume down button, if enabled) is pressed.
      See Also:

    • ALWAYS_SHOW

      public static final int ALWAYS_SHOW
      Force the preview to be displayed, even if off by default (e.g., when using CameraMode.PASSIVE_AIMER).
      See Also:

    • HIGH_RESOLUTION

      public static final int HIGH_RESOLUTION
      Use higher resolution if the device supports it. Default is 1280x720, with this param 1920x1080 will be used.
      See Also:

    • HIGH_FRAME_RATE

      public static final int HIGH_FRAME_RATE
      Use higher framerate if the device supports it. Default is 30 FPS, with this param 60 FPS will be used.
      See Also:

    • SHOW_CLOSE_BUTTON

      public static final int SHOW_CLOSE_BUTTON
      Show close button in partial view.
      See Also:

    • KEEP_PREVIEW_IN_PAUSED_STATE

      public static final int KEEP_PREVIEW_IN_PAUSED_STATE
      Keep the preview in paused state after read
      See Also:

    • QHD_RESOLUTION

      public static final int QHD_RESOLUTION
      Use 2K resolution if the device supports it. Default is 1280x720, with this param 2560x1440 will be used.
      See Also:

  • Constructor Details

    • PreviewOption

      public PreviewOption()