Protocols

Objective-C

@protocol MBIBarcodeOverlayViewControllerDelegate <NSObject>

Swift

protocol MBIBarcodeOverlayViewControllerDelegate : NSObjectProtocol

Objective-C

@protocol MBIDebugRecognizerRunnerDelegate <NSObject>

Swift

protocol MBIDebugRecognizerRunnerDelegate

Objective-C

@protocol MBIDebugRecognizerRunnerViewControllerDelegate <NSObject>

Swift

protocol MBIDebugRecognizerRunnerViewControllerDelegate : NSObjectProtocol

Objective-C

@protocol MBIDetectionRecognizerRunnerDelegate <NSObject>

Swift

protocol MBIDetectionRecognizerRunnerDelegate

Objective-C

@protocol MBIDetectionRecognizerRunnerViewControllerDelegate <NSObject>

Swift

protocol MBIDetectionRecognizerRunnerViewControllerDelegate : NSObjectProtocol

Objective-C

@protocol MBIDocumentCaptureOverlayViewControllerDelegate <NSObject>

Swift

protocol MBIDocumentCaptureOverlayViewControllerDelegate : NSObjectProtocol

Objective-C

@protocol MBIEncodeFullDocumentImage

@required

/**
 * Sets whether full document image should be extracted and JPEG-encoded.
 *
 * Default: NO
 */
@property (nonatomic, assign) BOOL encodeFullDocumentImage;

@end

Swift

protocol MBIEncodeFullDocumentImage

Objective-C

@protocol MBIEncodedFullDocumentImageResult

@required

/**
 * JPEG-encoded full document image if enabled with `MBIEncodeFullDocumentImage encodeFullDocumentImage` property.
 */
@property (nonatomic, readonly, nullable) NSData* encodedFullDocumentImage;

@end

Swift

protocol MBIEncodedFullDocumentImageResult

Objective-C

@protocol MBIFieldByFieldOverlayViewControllerDelegate <NSObject>

Swift

protocol MBIFieldByFieldOverlayViewControllerDelegate : NSObjectProtocol

Objective-C

@protocol MBIFrameGrabberRecognizerDelegate <NSObject>
@required
/**
 * Called when {FrameGrabberRecognizer} received new frame for processing.
 * Note that all buffers associated with image are available only during life of this method.
 * As soon as this method exits, there is no guarantee that buffers will be valid. If you need
 * to store image for later processing, showing or saving, make sure you create a copy of it.
 * @param cameraFrame The {MBIImage} containing frame that will be processed.
 * @param focused Information whether or not given frame is considered to be in focus. This
 *                  information is calculated on the basis of frame quality estimation algorithm
 *                  combined with information about actual frame that was provided by camera device.
 * @param frameQuality A number indicating calculated quality of given frame. This number is
 *                     non-negative, however it's maximum is not defined - the higher the number
 *                     is, the better the observed quality of frame is.
 */
- (void)onFrameAvailable:(MBIImage *)cameraFrame isFocused:(BOOL)focused frameQuality:(CGFloat)frameQuality;

@end

Swift

protocol MBIFrameGrabberRecognizerDelegate : NSObjectProtocol

Objective-C

@protocol MBIFrameRecognitionRecognizerRunnerViewControllerDelegate <NSObject>

Swift

protocol MBIFrameRecognitionRecognizerRunnerViewControllerDelegate : NSObjectProtocol

Objective-C

@protocol MBIFullDocumentImage

@required

/**
 * Sets whether full document image of ID card should be extracted.
 *
 * Default: NO
 */
@property (nonatomic, assign) BOOL returnFullDocumentImage;

@end

Swift

protocol MBIFullDocumentImage

Objective-C

@protocol MBIFullDocumentImageExtensionFactors

@required

/**
 * Image extension factors for full document image.
 *
 * @see MBIImageExtensionFactors
 * Default: {0.0f, 0.0f, 0.0f, 0.0f}
 */
@property (nonatomic, assign) MBIImageExtensionFactors fullDocumentImageExtensionFactors;

@end

Objective-C

@protocol MBIFullDocumentImageResult

@required

/**
 * full document image if enabled with `MBIFullDocumentImage returnFullDocumentImage` property.
 */
@property (nonatomic, readonly, nullable) MBIImage* fullDocumentImage;

@end

Swift

protocol MBIFullDocumentImageResult

Objective-C

@protocol MBIGlareRecognizerRunnerDelegate <NSObject>
@required

/**
 * Called when scanning library finishes glare detection.
 * NOTE: This method is called on background processing thread. Make sure that you dispatch all your UI API calls to main thread.
 */
- (void) recognizerRunner:(nonnull MBIRecognizerRunner *)recognizerRunner didFinishGlareDetectionWithResult:(BOOL)glareFound;
@end

Swift

protocol MBIGlareRecognizerRunnerDelegate

Objective-C

@protocol MBIGlareRecognizerRunnerViewControllerDelegate <NSObject>
@required

/**
 * Called when scanning library finishes glare detection.
 * NOTE: This method is called on background processing thread. Make sure that you dispatch all your UI API calls to main thread.
 */
- (void) recognizerRunnerViewController:(nonnull UIViewController<MBIRecognizerRunnerViewController> *)recognizerRunnerViewController didFinishGlareDetectionWithResult:(BOOL)glareFound;
@end

Swift

protocol MBIGlareRecognizerRunnerViewControllerDelegate : NSObjectProtocol

Objective-C

@protocol MBIImageProcessingRecognizerRunnerDelegate <NSObject>
@required

/**
 * Called when MBIRecognizerRunner finishes processing given image.
 * NOTE: This method is called on background processing thread. Make sure that you dispatch all your UI API calls to main thread.
 */
- (void) recognizerRunner:(nonnull MBIRecognizerRunner *)recognizerRunner didFinishProcessingImage:(nonnull MBIImage *)image;

@end

Swift

protocol MBIImageProcessingRecognizerRunnerDelegate

Objective-C

@protocol MBILoggerDelegate <NSObject>

@optional

- (void)log:(MBILogLevel)level message:(const char *)message;
- (void)log:(MBILogLevel)level format:(const char *)format arguments:(const char *)arguments;

@end

Swift

protocol MBILoggerDelegate : NSObjectProtocol

Objective-C

@protocol MBINativeResult

/**
 * Returns the native object containing the result. For example, for MBIDateResult, this method
 * will return NSDate object.
 */
- (NSObject *_Nullable)nativeResult;

/**
 * Returns the string version of the result. For example, for MBIDateResult, this method
 * will return original string from which date was parsed (same as MBIDateResult's originalDateString property}.
 */
- (NSString *_Nullable)stringResult;

@end

Swift

protocol MBINativeResult

Objective-C

@protocol MBIOcrLayoutSubview <NSObject>

Swift

protocol MBIOcrLayoutSubview : NSObjectProtocol

Objective-C

@protocol MBIOcrRecognizerRunnerDelegate <NSObject>

Swift

protocol MBIOcrRecognizerRunnerDelegate

Objective-C

@protocol MBIOcrRecognizerRunnerViewControllerDelegate <NSObject>

Swift

protocol MBIOcrRecognizerRunnerViewControllerDelegate : NSObjectProtocol

Objective-C

@protocol MBIOverlayContainerViewController <MBIRecognizerRunnerViewController>

Swift

protocol MBIOverlayContainerViewController : MBIRecognizerRunnerViewController

Objective-C

@protocol MBIPointDetectorSubview <NSObject>

Swift

protocol MBIPointDetectorSubview : NSObjectProtocol

Objective-C

@protocol MBIQuadDetectorSubview <NSObject>

Swift

protocol MBIQuadDetectorSubview : NSObjectProtocol

Objective-C

@protocol MBIRecognizerRunnerViewController <NSObject>

Swift

protocol MBIRecognizerRunnerViewController : NSObjectProtocol

Objective-C

@protocol MBIRecognizerRunnerViewControllerDelegate <NSObject>

Swift

protocol MBIRecognizerRunnerViewControllerDelegate : NSObjectProtocol

Objective-C

@protocol MBIResultSubview <NSObject>

Swift

protocol MBIResultSubview : NSObjectProtocol

Objective-C

@protocol MBIScanningRecognizerRunnerDelegate <NSObject>

Swift

protocol MBIScanningRecognizerRunnerDelegate : NSObjectProtocol

Objective-C

@protocol MBIScanningRecognizerRunnerViewControllerDelegate <NSObject>

Swift

protocol MBIScanningRecognizerRunnerViewControllerDelegate : NSObjectProtocol

Objective-C

@protocol MBIStringProcessingRecognizerRunnerDelegate <NSObject>
@required

/**
 * Called when MBIRecognizerRunner finishes processing given string.
 * NOTE: This method is called on background processing thread. Make sure that you dispatch all your UI API calls to main thread.
 */
- (void)recognizerRunner:(nonnull MBIRecognizerRunner *)recognizerRunner didFinishProcessingString:(nonnull NSString *)string;

@end

Swift

protocol MBIStringProcessingRecognizerRunnerDelegate

Objective-C

@protocol MBISubviewDelegate <NSObject>

Swift

protocol MBISubviewDelegate : NSObjectProtocol

Objective-C

@protocol MBITemplatingClassifier <NSObject>
@required

- (BOOL)classify;
@end

Swift

protocol MBITemplatingClassifier : NSObjectProtocol