MBIRecognizerRunner


@interface MBIRecognizerRunner : NSObject

Factory class containing static methods for creating camera view controllers. Camera view controllers created this way will be managed internally by the SDK, and input frames will be processed.

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull, readonly) MBIRecognizerRunnerMetadataDelegates *metadataDelegates

    Swift

    var metadataDelegates: MBIRecognizerRunnerMetadataDelegates { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, weak) id<MBIScanningRecognizerRunnerDelegate> scanningRecognizerRunnerDelegate

    Swift

    weak var scanningRecognizerRunnerDelegate: MBIScanningRecognizerRunnerDelegate? { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, weak, nullable) id<MBIImageProcessingRecognizerRunnerDelegate> imageProcessingRecognizerRunnerDelegate

    Swift

    weak var imageProcessingRecognizerRunnerDelegate: MBIImageProcessingRecognizerRunnerDelegate? { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, weak, nullable) id<MBIStringProcessingRecognizerRunnerDelegate> stringProcessingRecognizerRunnerDelegate

    Swift

    weak var stringProcessingRecognizerRunnerDelegate: MBIStringProcessingRecognizerRunnerDelegate? { get set }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, nullable) MBICoordinator *coordinator

    Swift

    var coordinator: MBICoordinator? { get set }

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Initializes the recognizer runner

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRecognizerCollection:
    (nonnull MBIRecognizerCollection *)recognizerCollection;

    Swift

    init(recognizerCollection: MBIRecognizerCollection)

  • Undocumented

    Declaration

    Objective-C

    - (void)resetState;

    Swift

    func resetState()

  • Undocumented

    Declaration

    Objective-C

    - (void)resetState:(BOOL)hard;

    Swift

    func resetState(_ hard: Bool)

  • Cancels all dispatched, but not yet processed image processing requests issued with processImage. NOTE: next call to processImage will resume processing.

    Declaration

    Objective-C

    - (void)cancelProcessing;

    Swift

    func cancelProcessing()

  • Processes a MBIImage object synchronously using current settings. Since this method is synchronous, calling it from a main thread will switch the call to alternate thread internally and output a warning.

    Results are passed a delegate object given upon a creation of MBICoordinator.

    Declaration

    Objective-C

    - (void)processImage:(nonnull MBIImage *)image;

    Swift

    func processImage(_ image: MBIImage)

    Parameters

    image

    image for processing

  • Processes a NSString object synchronously using current settings. Since this method is synchronous, calling it from a main thread will switch the call to alternate thread internally and output a warning.

    Results are passed a delegate object given upon a creation of MBICoordinator.

    Declaration

    Objective-C

    - (void)processString:(nonnull NSString *)string;

    Swift

    func processString(_ string: String)

    Parameters

    string

    string for processing

  • Method which is used to apply MBISettings object given by currentSettings property

    Usual use case is to update settings on the fly, to perform some complex scanning functionality where a reconfiguration of the recognizers is needed.

    Declaration

    Objective-C

    - (void)reconfigureRecognizers:
    (nonnull MBIRecognizerCollection *)recognizerCollection;

    Swift

    func reconfigureRecognizers(_ recognizerCollection: MBIRecognizerCollection)