Package com.microblink.photopay.uisettings

Class BasicScanUISettings

java.lang.Object
com.microblink.photopay.uisettings.UISettings<BasicOverlayController>
com.microblink.photopay.uisettings.BasicScanUISettings
All Implemented Interfaces:
BeepSoundUIOptions, DebugImageListenerUIOptions, HelpIntentUIOptions, HighResSuccessFrameCaptureUIOptions, SplashScreenUIOptions
Direct Known Subclasses:
BarcodeUISettings, PhotopayUISettings
public abstract class BasicScanUISettings extends UISettings<BasicOverlayController> implements DebugImageListenerUIOptions, SplashScreenUIOptions, BeepSoundUIOptions, HighResSuccessFrameCaptureUIOptions, HelpIntentUIOptions

  • Constructor Details

    • BasicScanUISettings

      protected BasicScanUISettings(@NonNull RecognizerBundle recognizerBundle)

    • BasicScanUISettings

      protected BasicScanUISettings(@NonNull android.content.Intent intent)

  • Method Details

    • getRecognizerBundle

      @NonNull public RecognizerBundle getRecognizerBundle()
      Returns the RecognizerBundle containing recognizers that will be used for processing.
      Returns:
      the RecognizerBundle containing recognizers that will be used for processing.

    • saveToIntent

      public final void saveToIntent(@NonNull android.content.Intent intent)
      Description copied from class: UISettings
      Saves this scan activity settings to Intent so it can be passed to the corresponding scan activity. Intent target activity must be set before calling this method, and target activity must be compatible with this settings. DO NOT USE THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING. Improper usage will crash your app.
      Overrides:
      saveToIntent in class UISettings<BasicOverlayController>
      Parameters:
      intent - Intent to which this scan activity settings should be saved.

    • setScanRegionOfInterest

      public final void setScanRegionOfInterest(@Nullable Rectangle scanRegionOfInterest)
      Sets the scanning ROI (Region of Interest) that will be scanned.
      Parameters:
      scanRegionOfInterest - scanning ROI.
      See Also:

    • setRegionOfInterestRotatable

      public final void setRegionOfInterestRotatable(boolean regionOfInterestRotatable)
      Defines whether ROI (Region of Interest) will be rotated with user interface. Default is false.
      Parameters:
      regionOfInterestRotatable - whether ROI (Region of Interest) will be rotated with user interface.
      See Also:

    • setBeepSoundResourceID

      public final void setBeepSoundResourceID(int beepSoundResourceID)
      Description copied from interface: BeepSoundUIOptions
      Defines the resource ID of the sound to be played when recognition is successful.
      Specified by:
      setBeepSoundResourceID in interface BeepSoundUIOptions
      Parameters:
      beepSoundResourceID - resource ID of the sound to be played when recognition is successful.

    • setSplashScreenLayoutResourceID

      public final void setSplashScreenLayoutResourceID(@LayoutRes int splashScreenLayoutResourceID)
      Description copied from interface: SplashScreenUIOptions
      Defines the ID of the layout resource that will be used as camera splash screen displayed while camera is being initialized. If not set, default splash screen will be used.
      Specified by:
      setSplashScreenLayoutResourceID in interface SplashScreenUIOptions
      Parameters:
      splashScreenLayoutResourceID - ID of the layout resource that will be used as camera splash screen displayed while camera is being initialized.

    • setDebugImageListener

      public final void setDebugImageListener(@Nullable DebugImageListener debugImageListener)
      Description copied from interface: DebugImageListenerUIOptions
      Sets implementation of DebugImageListener interface that will obtain images that are being processed. DebugImageListener will receive all possible debug images that become available during recognition process.
      Specified by:
      setDebugImageListener in interface DebugImageListenerUIOptions
      Parameters:
      debugImageListener - Implementation of debug image listener or null to clear listener that has been set previously.

    • enableHighResSuccessFrameCapture

      public void enableHighResSuccessFrameCapture(boolean enabled)
      Description copied from interface: HighResSuccessFrameCaptureUIOptions
      Sets whether to enable capturing high res frames on recognition success. Default is false.
      Specified by:
      enableHighResSuccessFrameCapture in interface HighResSuccessFrameCaptureUIOptions
      Parameters:
      enabled - true if you wish to enable high res success frame capture

    • setForcedOrientation

      public void setForcedOrientation(@Nullable OverlayOrientation orientation)
      Defines forced overlay orientation.
      Parameters:
      orientation - forced overlay orientation.
      See Also:

    • setHelpIntent

      public final void setHelpIntent(@Nullable android.content.Intent helpIntent)
      Description copied from interface: HelpIntentUIOptions
      Defines intent for help activity called when help should be shown. If not set or set to null, help button will not be shown in the scanning UI.
      Specified by:
      setHelpIntent in interface HelpIntentUIOptions
      Parameters:
      helpIntent - intent for help activity called when help should be shown.

    • createOverlayController

      @NonNull public BasicOverlayController createOverlayController(@NonNull android.app.Activity activity, @NonNull ScanResultListener scanResultListener)
      Description copied from class: UISettings
      Creates overlay controller and configures it using set values.
      Specified by:
      createOverlayController in class UISettings<BasicOverlayController>

    • createOverlaySettingsBuilder

      @NonNull protected abstract BasicOverlaySettings.Builder createOverlaySettingsBuilder()