MBDocumentOverlayViewControllerDelegate

@protocol MBDocumentOverlayViewControllerDelegate <NSObject>

Protocol for obtaining scanning results

  • Scanning library did output scanning results

    Depending on how you want to treat the result, you might want to dismiss the scanningViewController here.

    This method is the default way for getting access to results of scanning.

    Note:

    • there may be 0, 1, or more than one scanning results.
    • each scanning result belongs to a common MBRecognizerResult type

    • handle different types differently

    NOTE: This method is called on background processing thread. Make sure that you dispatch all your UI API calls to main thread.

    Declaration

    Objective-C

    - (void)
documentOverlayViewControllerDidFinishScanning:
    (nonnull MBDocumentOverlayViewController *)documentOverlayViewController
                                         state:(MBRecognizerResultState)state;

    Swift

    func documentOverlayViewControllerDidFinishScanning(_ documentOverlayViewController: MBDocumentOverlayViewController, state: MBRecognizerResultState)

    Parameters

    documentOverlayViewController

    documentOverlayViewController Scanning view controller responsible for scanning
    state

    state of scanning

  • Scanning library was closed, usually by the user pressing close button and cancelling the scan

    Declaration

    Objective-C

    - (void)documentOverlayViewControllerDidTapClose:
    (nonnull MBDocumentOverlayViewController *)documentOverlayViewController;

    Swift

    func documentOverlayViewControllerDidTapClose(_ documentOverlayViewController: MBDocumentOverlayViewController)

    Parameters

    documentOverlayViewController

    Scanning view controller responsible for scanning

  • Scanning library did output high resolution image

    NOTE: This method is called on background processing thread. Make sure that you dispatch all your UI API calls to main thread.

    Declaration

    Objective-C

    - (void)
documentOverlayViewControllerDidCaptureHighResolutionImage:
    (nonnull MBDocumentOverlayViewController *)documentOverlayViewController
                                              highResImage:(nonnull MBImage *)
                                                               highResImage;

    Swift

    optional func documentOverlayViewControllerDidCaptureHighResolutionImage(_ documentOverlayViewController: MBDocumentOverlayViewController, highResImage: MBImage)

    Parameters

    documentOverlayViewController

    Scanning view controller responsible for scanning
    highResImage

    High resolution image of finished scan