Classes Reference


                    
                    
                    MBIAmountParser

MBIAmountParser is used for extracting amount from OCR result

Declaration

Objective-C


@interface MBIAmountParser : MBIParser <NSCopying>

Swift

class MBIAmountParser : MBIParser, NSCopying


                    
                    
                    MBIAmountParserResult

MBIAmountParser is used for extracting amount from OCR result

Declaration

Objective-C


@interface MBIAmountParserResult : MBIParserResult <NSCopying>

Swift

class MBIAmountParserResult : MBIParserResult, NSCopying


                    
                    
                    MBIBarcodeOverlaySettings

Settings class containing UI information

Declaration

Objective-C


@interface MBIBarcodeOverlaySettings : MBIBaseOverlaySettings

Swift

class MBIBarcodeOverlaySettings : MBIBaseOverlaySettings


                    
                    
                    MBIBarcodeOverlayViewController

Undocumented

Declaration

Objective-C


@interface MBIBarcodeOverlayViewController : MBIBaseOverlayViewController

Swift

class MBIBarcodeOverlayViewController : MBIBaseOverlayViewController


                    
                    
                    MBIBarcodeRecognizer

MBIBarcodeRecognizer is used for scanning most of 1D barcode formats, and 2D format such as Aztec, DataMatrix and QR code

Declaration

Objective-C


@interface MBIBarcodeRecognizer : MBIRecognizer <NSCopying>

Swift

class MBIBarcodeRecognizer : MBIRecognizer, NSCopying


                    
                    
                    MBIBarcodeRecognizerResult

Result of MBIBarcodeRecognizer; is used for scanning most of 1D barcode formats, and 2D format such as Aztec, DataMatrix and QR code

Declaration

Objective-C


@interface MBIBarcodeRecognizerResult : MBIRecognizerResult <NSCopying>

Swift

class MBIBarcodeRecognizerResult : MBIRecognizerResult, NSCopying


                    
                    
                    MBIBaseOcrEngineOptions

Options used for OCR process. These options enable you to customize how some OCR parsers work. For example, you can set character whitelists, character height, supported fonts etc.

Declaration

Objective-C


@interface MBIBaseOcrEngineOptions : NSObject

Swift

class MBIBaseOcrEngineOptions : NSObject


                    
                    
                    MBIBaseOverlaySettings

Settings class containing UI information

Declaration

Objective-C


@interface MBIBaseOverlaySettings : MBIOverlaySettings

Swift

class MBIBaseOverlaySettings : MBIOverlaySettings


                    
                    
                    MBIBaseOverlayViewController

Common base class for default overlay view controllers

Declaration

Objective-C


@interface MBIBaseOverlayViewController : MBIOverlayViewController

Swift

class MBIBaseOverlayViewController : MBIOverlayViewController


                    
                    
                    MBIBlinkInputRecognizer

A recognizer for BlinkInput API and general OCR recognition

Declaration

Objective-C


@interface MBIBlinkInputRecognizer : MBIRecognizer <NSCopying>

Swift

class MBIBlinkInputRecognizer : MBIRecognizer, NSCopying


                    
                    
                    MBIBlinkInputRecognizerResult

A recognizer result for BlinkInput API and general OCR recognition

Declaration

Objective-C


@interface MBIBlinkInputRecognizerResult : MBIRecognizerResult <NSCopying>

Swift

class MBIBlinkInputRecognizerResult : MBIRecognizerResult, NSCopying


                    
                    
                    MBICameraSettings

Settings class containing parameters for camera capture

Declaration

Objective-C


@interface MBICameraSettings : NSObject <NSCopying>

Swift

class MBICameraSettings : NSObject, NSCopying


                    
                    
                    MBICustomOverlayViewController

Custom Overlay View Controller is an abstract class for all custom overlay views placed on top View Controller. It’s responsibility is to provide meaningful and useful interface for the user to interact with.

Declaration

Objective-C


@interface MBICustomOverlayViewController : MBIOverlayViewController

Swift

class MBICustomOverlayViewController : MBIOverlayViewController


                    
                    
                    MBIDPIBasedDewarpPolicy

DPI based dewarp policy. Dewarp height will be calculated based on actual physical size provided by the MBIQuadWithSizeDetector and requested DPI (dots per inch).

This policy is usually best for processor groups that prepare image for output (e.g. MBIImageReturnProcessor).

Declaration

Objective-C


@interface MBIDPIBasedDewarpPolicy : MBIDewarpPolicy

Swift

class MBIDPIBasedDewarpPolicy : MBIDewarpPolicy


                    
                    
                    MBIDateParser

MBIDateParser that can extract date from OCR result.

Declaration

Objective-C


@interface MBIDateParser : MBIParser <NSCopying>

Swift

class MBIDateParser : MBIParser, NSCopying


                    
                    
                    MBIDateParserResult

MBIDateParser that can extract date from OCR result.

Declaration

Objective-C


@interface MBIDateParserResult : MBIParserResult <NSCopying>

Swift

class MBIDateParserResult : MBIParserResult, NSCopying


                    
                    
                    MBIDateResult

This class represents a Date result scanned from the image. It supports obtaining raw NSDates, or raw strings Which are in the same format to the text printed on the image.

While converting to NSDate, internally prior knowledge about scanned document is used to use the right format.

Declaration

Objective-C


@interface MBIDateResult : NSObject <MBINativeResult>

Swift

class MBIDateResult : NSObject, MBINativeResult


                    
                    
                    MBIDeepOcrEngineOptions

Options used for OCR process. These options enable you to customize how some OCR parsers work. For example, you can set nms threshold, score threshold, the ID of the requested Deep OCR model etc.

Declaration

Objective-C


@interface MBIDeepOcrEngineOptions : MBIBaseOcrEngineOptions <NSCopying>

Swift

class MBIDeepOcrEngineOptions : MBIBaseOcrEngineOptions, NSCopying


                    
                    
                    MBIDetector

Base class for all detectors

Declaration

Objective-C


@interface MBIDetector : MBIEntity

Swift

class MBIDetector : MBIEntity


                    
                    
                    MBIDetectorRecognizer

Recognizer for scanning generic documents using custom MBIDetector.

Declaration

Objective-C


@interface MBIDetectorRecognizer : MBITemplatingRecognizer <NSCopying>

Swift

class MBIDetectorRecognizer : MBITemplatingRecognizer, NSCopying


                    
                    
                    MBIDetectorRecognizerResult

Result of MBIDetectorRecognizer

Declaration

Objective-C


@interface MBIDetectorRecognizerResult
    : MBITemplatingRecognizerResult <NSCopying>

Swift

class MBIDetectorRecognizerResult : MBITemplatingRecognizerResult, NSCopying


                    
                    
                    MBIDetectorResult

Base class for all detectors results

Declaration

Objective-C


@interface MBIDetectorResult : NSObject

Swift

class MBIDetectorResult : NSObject


                    
                    
                    MBIDewarpPolicy

Base class for all dewarp policies

Declaration

Objective-C


@interface MBIDewarpPolicy : NSObject

Swift

class MBIDewarpPolicy : NSObject


                    
                    
                    MBIDisplayableDetection

Represents a detection that can be displayed on screen.

Declaration

Objective-C


@interface MBIDisplayableDetection : MBIDisplayableObject

Swift

class MBIDisplayableDetection : MBIDisplayableObject


                    
                    
                    MBIDisplayableObject

Represents any object that can be displayed on screen in terms of drawing.

Declaration

Objective-C


@interface MBIDisplayableObject : NSObject

Swift

class MBIDisplayableObject : NSObject


                    
                    
                    MBIDisplayablePointsDetection

Result of the detection of a point detector. Point Detectors are used for QR and similar barcodes

Declaration

Objective-C


@interface MBIDisplayablePointsDetection : MBIDisplayableDetection

Swift

class MBIDisplayablePointsDetection : MBIDisplayableDetection


                    
                    
                    MBIDisplayableQuadDetection

Represents a detection that can be displayed on screen.

Declaration

Objective-C


@interface MBIDisplayableQuadDetection : MBIDisplayableDetection

Swift

class MBIDisplayableQuadDetection : MBIDisplayableDetection


                    
                    
                    MBIDocumentCaptureOverlaySettings

Settings class containing parameters for Document Capture UI

Declaration

Objective-C


@interface MBIDocumentCaptureOverlaySettings : MBIBaseOverlaySettings

Swift

class MBIDocumentCaptureOverlaySettings : MBIBaseOverlaySettings


                    
                    
                    MBIDocumentCaptureOverlayViewController

Default version of overlay view controller with modern design.

Declaration

Objective-C


@interface MBIDocumentCaptureOverlayViewController
    : MBIBaseOverlayViewController

Swift

class MBIDocumentCaptureOverlayViewController : MBIBaseOverlayViewController


                    
                    
                    MBIDocumentCaptureRecognizer

A recognizer for DocumentCaptureRecognizer

Declaration

Objective-C


@interface MBIDocumentCaptureRecognizer
    : MBIRecognizer <NSCopying, MBIFullDocumentImage,
                     MBIEncodeFullDocumentImage,
                     MBIFullDocumentImageExtensionFactors>

Swift

class MBIDocumentCaptureRecognizer : MBIRecognizer, NSCopying, MBIFullDocumentImage, MBIEncodeFullDocumentImage, MBIFullDocumentImageExtensionFactors


                    
                    
                    MBIDocumentCaptureRecognizerResult

Class representing values obtained when capturing document

Declaration

Objective-C


@interface MBIDocumentCaptureRecognizerResult
    : MBIRecognizerResult <NSCopying, MBIFullDocumentImageResult,
                           MBIEncodedFullDocumentImageResult>

Swift

class MBIDocumentCaptureRecognizerResult : MBIRecognizerResult, NSCopying, MBIFullDocumentImageResult, MBIEncodedFullDocumentImageResult


                    
                    
                    MBIDocumentCaptureSubview

Overlay subview presenting the status of detection. The subview is presented as rectangle view over document

Declaration

Objective-C


@interface MBIDocumentCaptureSubview : MBISubview <MBIQuadDetectorSubview>

Swift

class MBIDocumentCaptureSubview : MBISubview, MBIQuadDetectorSubview


                    
                    
                    MBIDocumentDetector

Detector that can perform detection of card documents, cheques, papers, etc.

Declaration

Objective-C


@interface MBIDocumentDetector : MBIQuadWithSizeDetector <NSCopying>

Swift

class MBIDocumentDetector : MBIQuadWithSizeDetector, NSCopying


                    
                    
                    MBIDocumentDetectorResult

Detector that can perform detection of card documents, cheques, papers, etc.

Declaration

Objective-C


@interface MBIDocumentDetectorResult : MBIQuadWithSizeDetectorResult <NSCopying>

Swift

class MBIDocumentDetectorResult : MBIQuadWithSizeDetectorResult, NSCopying


                    
                    
                    MBIDocumentSpecification

Document class describes a document which is being detected by DocumentDetector. We encurage users to create specifications with one of our presets, if possible.

Declaration

Objective-C


@interface MBIDocumentSpecification : NSObject <NSCopying>

Swift

class MBIDocumentSpecification : NSObject, NSCopying


                    
                    
                    MBIDotsResultSubview

Overlay subview presenting status of OCR detection. Dots are displayed over locations of detected characters.

Declaration

Objective-C


@interface MBIDotsResultSubview : MBISubview <MBIPointDetectorSubview>

Swift

class MBIDotsResultSubview : MBISubview, MBIPointDetectorSubview


                    
                    
                    MBIDotsSubview

A wrapper around CAShapeLayer which is used for presenting a status about barcode detections

The layer is used to draw dots representing barcodes

Declaration

Objective-C


@interface MBIDotsSubview : MBISubview <MBIPointDetectorSubview>

Swift

class MBIDotsSubview : MBISubview, MBIPointDetectorSubview


                    
                    
                    MBIEmailParser

MBIEmailParser is used for parsing emails

Declaration

Objective-C


@interface MBIEmailParser : MBIParser <NSCopying>

Swift

class MBIEmailParser : MBIParser, NSCopying


                    
                    
                    MBIEmailParserResult

MBIEmailParser is used for parsing emails

Declaration

Objective-C


@interface MBIEmailParserResult : MBIParserResult <NSCopying>

Swift

class MBIEmailParserResult : MBIParserResult, NSCopying


                    
                    
                    MBIEntity

Base class for all entities processors, recognizers, detectors…

Declaration

Objective-C


@interface MBIEntity : NSObject

Swift

class MBIEntity : NSObject


                    
                    
                    MBIFieldByFieldOverlaySettings

Settings class containing UI information

Declaration

Objective-C


@interface MBIFieldByFieldOverlaySettings : MBIOverlaySettings

Swift

class MBIFieldByFieldOverlaySettings : MBIOverlaySettings


                    
                    
                    MBIFieldByFieldOverlayViewController

View Controller responsible for view hierarchy for Form OCR scannning. This view hierarchy is added as an overlay to Camera preview

Declaration

Objective-C


@interface MBIFieldByFieldOverlayViewController : MBIOverlayViewController

Swift

class MBIFieldByFieldOverlayViewController : MBIOverlayViewController


                    
                    
                    MBIFixedDewarpPolicy

Fixed dewarp policy. Dewarp height will be exactly as defined by its dewarpHeight.

This policy is usually best for processor groups that use legacy BlinkOCR.

Declaration

Objective-C


@interface MBIFixedDewarpPolicy : MBIDewarpPolicy

Swift

class MBIFixedDewarpPolicy : MBIDewarpPolicy


                    
                    
                    MBIFrameGrabberRecognizer

A recognizer that can returns success frame.

Declaration

Objective-C


@interface MBIFrameGrabberRecognizer : MBIRecognizer <NSCopying>

Swift

class MBIFrameGrabberRecognizer : MBIRecognizer, NSCopying


                    
                    
                    MBIGlareStatusSubview

Overlay subview presenting the status of glare detection. The subview is presented as translucent view with detection status label in the center of ID Card View Finder View

Declaration

Objective-C


@interface MBIGlareStatusSubview : MBISubview

Swift

class MBIGlareStatusSubview : MBISubview


                    
                    
                    MBIIbanParser

MBIAmountParser that can extract IBAN (International Bank Account Number) from OCR result.

Declaration

Objective-C


@interface MBIIbanParser : MBIParser <NSCopying>

Swift

class MBIIbanParser : MBIParser, NSCopying


                    
                    
                    MBIIbanParserResult

MBIAmountParser that can extract IBAN (International Bank Account Number) from OCR result.

Declaration

Objective-C


@interface MBIIbanParserResult : MBIParserResult <NSCopying>

Swift

class MBIIbanParserResult : MBIParserResult, NSCopying


                    
                    
                    MBIImage

Object which represents an image.

Declaration

Objective-C


@interface MBIImage : NSObject

Swift

class MBIImage : NSObject


                    
                    
                    MBIImageReturnProcessor

Processor that will simply save given image.

Declaration

Objective-C


@interface MBIImageReturnProcessor : MBIProcessor <NSCopying>

Swift

class MBIImageReturnProcessor : MBIProcessor, NSCopying


                    
                    
                    MBIImageReturnProcessorResult

Processor that will simply save given image.

Declaration

Objective-C


@interface MBIImageReturnProcessorResult : MBIProcessorResult <NSCopying>

Swift

class MBIImageReturnProcessorResult : MBIProcessorResult, NSCopying


                    
                    
                    MBILicensePlatesParser

MBILicensePlatesParser is used for parsing license plates

Declaration

Objective-C


@interface MBILicensePlatesParser : MBIParser <NSCopying>

Swift

class MBILicensePlatesParser : MBIParser, NSCopying


                    
                    
                    MBILicensePlatesParserResult

MBILicensePlatesParser is used for parsing license plates

Declaration

Objective-C


@interface MBILicensePlatesParserResult : MBIParserResult <NSCopying>

Swift

class MBILicensePlatesParserResult : MBIParserResult, NSCopying


                    
                    
                    MBILogger

Undocumented

Declaration

Objective-C

@interface MBILogger : NSObject

@property (nonatomic) id<MBILoggerDelegate> delegate;

+ (instancetype)sharedInstance NS_SWIFT_NAME(shared());

- (void)disableMicroblinkLogging;

@end

Swift

class MBILogger : NSObject


                    
                    
                    MBIMicroblinkApp

Undocumented

Declaration

Objective-C

@interface MBIMicroblinkApp : NSObject

@property (nonatomic) NSString *language;

/** Bundle with resources used in framework */
@property (nonatomic) NSBundle *resourcesBundle;

/** Custom bundle for overriding resourcesBundle */
@property (nonatomic) NSBundle *customResourcesBundle;

/** Localization file in main bundle used for overrideing framework's localizations */
@property (nonatomic) NSString *customLocalizationFileName;

/** Obtain the shared instance */
+ (instancetype)sharedInstance NS_SWIFT_NAME(shared());

/** Sets the language used in PhotoPaySDK */
- (void)setLanguage:(NSString *)language;

/** Sets the language to default (i.e. language specified in the user's device settings */
- (void)setDefaultLanguage;

/** Pushes the UIApplication status bar style to a internally handled stack */
- (void)pushStatusBarStyle:(UIStatusBarStyle)statusBarStyle;

/** Returns the status bar style to the last saved value */
- (void)popStatusBarStyle;

/** Push the status bar hidden value */
- (void)pushStatusBarHidden:(BOOL)hidden;

/** pops the status bar hidden value */
- (void)popStatusBarHidden;

/** Sets the key that the help was shown to true */
- (void)setHelpShown:(BOOL)value;

/** Returns true if the help was already shown */
- (BOOL)isHelpShown;

/**
 * Returns the default resources bundle. If it doesn't exist, it will be nil.
 */
+ (NSBundle *)getDefaultResourcesBundle;

@end

Swift

class MBIMicroblinkApp : NSObject


                    
                    
                    MBIMicroblinkSDK

Entry class for all Microblink SDKs - used for setting up license key and to add support for optimisation of passing data.

Declaration

Objective-C


@interface MBIMicroblinkSDK : NSObject

Swift

class MBIMicroblinkSDK : NSObject


                    
                    
                    MBIModernViewfinderSubview

Overlay subview presenting the status of detection. The subview is presented as green corners located on edges of detection points.

Declaration

Objective-C


@interface MBIModernViewfinderSubview : MBISubview <MBIQuadDetectorSubview>

Swift

class MBIModernViewfinderSubview : MBISubview, MBIQuadDetectorSubview


                    
                    
                    MBIMrtdDetector

Detector that can perform detection of Machine Readable Travel Documents (MRTD).

Declaration

Objective-C


@interface MBIMrtdDetector : MBIQuadWithSizeDetector <NSCopying>

Swift

class MBIMrtdDetector : MBIQuadWithSizeDetector, NSCopying


                    
                    
                    MBIMrtdDetectorResult

Detector that can perform detection of Machine Readable Travel Documents (MRTD).

Declaration

Objective-C


@interface MBIMrtdDetectorResult : MBIQuadWithSizeDetectorResult <NSCopying>

Swift

class MBIMrtdDetectorResult : MBIQuadWithSizeDetectorResult, NSCopying


                    
                    
                    MBIMrtdSpecification

Mrtd class describes a document which is being detected by MrtdDetector. We encurage users to create specifications with one of our presets, if possible.

Declaration

Objective-C


@interface MBIMrtdSpecification : NSObject <NSCopying>

Swift

class MBIMrtdSpecification : NSObject, NSCopying


                    
                    
                    MBINoUpScalingDewarpPolicy

No upscaling dewarp policy. Dewarp height will be calculated in a way that no part of image will be up-scaled. However, if dewarp height calculated in this way is larger than value defined by maxAllowedDewarpHeight, then maxAllowedDewarpHeight will be used for dewarp height, effectively scaling down the image.

This policy is usually best for processor groups that use DEEP OCR, hologram detection or NN-based classification.

Declaration

Objective-C


@interface MBINoUpScalingDewarpPolicy : MBIDewarpPolicy

Swift

class MBINoUpScalingDewarpPolicy : MBIDewarpPolicy


                    
                    
                    MBIOcrCharKey

Class representing a char in specific font.

@example char ‘k’ in font Arial

 MBIOcrCharKey* key = [[MBIOcrCharKey alloc] initWithCode:'k' font:MB_OCR_FONT_ARIAL];

@example char ‘ü’ in any font

 MBIOcrCharKey* key = [[MBIOcrCharKey alloc] initWithCode:'ü' font:MB_OCR_FONT_ANY];

Declaration

Objective-C


@interface MBIOcrCharKey : NSObject

Swift

class MBIOcrCharKey : NSObject


                    
                    
                    MBIOcrEngineOptions

Options used for OCR process. These options enable you to customize how some OCR parsers work. For example, you can set character whitelists, character height, supported fonts etc.

Declaration

Objective-C


@interface MBIOcrEngineOptions : MBIBaseOcrEngineOptions <NSCopying>

Swift

class MBIOcrEngineOptions : MBIBaseOcrEngineOptions, NSCopying


                    
                    
                    MBIOcrLayout

Class describing the layour of the document on which the OCR was preformed.

Ocr Layout contains one or mode OcrBlocks, each of which contains one or more OcrLines, Each of which contains one or more OcrChars.

Ocr layout coordinates and boxes are given in the coordinate system of the image on which the OCR was performed

See

MBIOcrBlock

See

MBIOcrLine

See

MBIOcrChar

Declaration

Objective-C


@interface MBIOcrLayout : NSObject

Swift

class MBIOcrLayout : NSObject


                    
                    
                    MBIOcrBlock

Class representing an Ocr Block. Block consists of one or more Ocr Lines.

See

MBIOcrLine

Declaration

Objective-C


@interface MBIOcrBlock : NSObject

Swift

class MBIOcrBlock : NSObject


                    
                    
                    MBIOcrLine

Class representing an Ocr line. line consists of one or more Ocr chars

See

MBIOcrChar

Declaration

Objective-C


@interface MBIOcrLine : NSObject

Swift

class MBIOcrLine : NSObject


                    
                    
                    MBICharWithVariants

Undocumented

Declaration

Objective-C

@interface MBICharWithVariants : NSObject

/**
 * Character that was recognised
 */
@property (nonatomic) MBIOcrChar * character;

/**
 * Alternative characters which are possible instead of this character.
 *
 * In the list of characters, each char (unicode value), can appear multiple times, each time with different font.
 * This means variant is uniquely defined with a combination of value and font properties.
 *
 * Each variant has quality property set, so you can use it to verify other options.
 *
 * @Warning If you use variants, please note you need to take font into account.
 */
@property (nonatomic) NSSet *variants;

- (instancetype)init NS_UNAVAILABLE;

/**
 * Initializer for a CharWithVariant
 *
 *  @param character Character with all recognition information (value, font, position, etc.)
 *
 *  @return initialized char with zero variants
 */
- (instancetype)initWithValue:(MBIOcrChar *)character NS_DESIGNATED_INITIALIZER;

@end

Swift

class MBICharWithVariants : NSObject


                    
                    
                    MBIOcrChar

Class representing an individual OCR character obtained in the OCR process.

Declaration

Objective-C


@interface MBIOcrChar : NSObject

Swift

class MBIOcrChar : NSObject


                    
                    
                    MBIPosition

Class representing a position on the image. It’s given as a box, with sides aligned to the sides of the image.

Declaration

Objective-C


@interface MBIPosition : NSObject

Swift

class MBIPosition : NSObject


                    
                    
                    MBIOcrResultSubview

Overlay subview presenting status of OCR detection. OCR results are displayed as green characters over detected locations.

Declaration

Objective-C


@interface MBIOcrResultSubview : MBISubview <MBIOcrLayoutSubview>

Swift

class MBIOcrResultSubview : MBISubview, MBIOcrLayoutSubview


                    
                    
                    MBIOverlaySettings

Settings class containing UI information

Declaration

Objective-C


@interface MBIOverlaySettings : NSObject <NSCopying>

Swift

class MBIOverlaySettings : NSObject, NSCopying


                    
                    
                    MBIOverlayViewController

Overlay View Controller is an abstract class for all overlay views placed on top View Controller.

It’s responsibility is to provide meaningful and useful interface for the user to interact with.

Typical actions which need to be allowed to the user are:

intuitive and meaniningful way to guide the user through scanning process. This is usually done by presenting a “viewfinder” in which the user need to place the scanned object
a way to cancel the scanining, typically with a “cancel” or “back” button
a way to power on and off the light (i.e. “torch”) button

Declaration

Objective-C


@interface MBIOverlayViewController : UIViewController

Swift

class MBIOverlayViewController : UIViewController


                    
                    
                    MBIParser

Base class for all parsers

Declaration

Objective-C


@interface MBIParser : MBIEntity

Swift

class MBIParser : MBIEntity


                    
                    
                    MBIParserGroupProcessor

A processor for a group

Declaration

Objective-C


@interface MBIParserGroupProcessor : MBIProcessor <NSCopying>

Swift

class MBIParserGroupProcessor : MBIProcessor, NSCopying


                    
                    
                    MBIParserGroupProcessorResult

A recognizer that can scan PDF417 2D barcodes.

Declaration

Objective-C


@interface MBIParserGroupProcessorResult : MBIProcessorResult <NSCopying>

Swift

class MBIParserGroupProcessorResult : MBIProcessorResult, NSCopying


                    
                    
                    MBIParserResult

Base class for all parser results

Declaration

Objective-C


@interface MBIParserResult : NSObject

Swift

class MBIParserResult : NSObject


                    
                    
                    MBIPdf417Recognizer

Deprecated

Use MBIBarcodeRecognizer.

A recognizer that can scan PDF417 2D barcodes.

Declaration

Objective-C


@interface MBIPdf417Recognizer : MBIRecognizer <NSCopying>

Swift

class MBIPdf417Recognizer : MBIRecognizer, NSCopying


                    
                    
                    MBIPdf417RecognizerResult

A recognizer that can scan PDF417 2D barcodes.

Declaration

Objective-C


@interface MBIPdf417RecognizerResult : MBIRecognizerResult <NSCopying>

Swift

class MBIPdf417RecognizerResult : MBIRecognizerResult, NSCopying


                    
                    
                    MBIProcessor

Base class for all processors

Declaration

Objective-C


@interface MBIProcessor : MBIEntity

Swift

class MBIProcessor : MBIEntity


                    
                    
                    MBIProcessorGroup

Class that represents a group of processors that will be executed on same dewarped image.

Declaration

Objective-C


@interface MBIProcessorGroup : NSObject

Swift

class MBIProcessorGroup : NSObject


                    
                    
                    MBIProcessorResult

Base class for all processor results

Declaration

Objective-C


@interface MBIProcessorResult : NSObject

Swift

class MBIProcessorResult : NSObject


                    
                    
                    MBIQuadDetector

Base class for all detectors that are used for MBIQuadrangle detection.

Declaration

Objective-C


@interface MBIQuadDetector : MBIDetector

Swift

class MBIQuadDetector : MBIDetector


                    
                    
                    MBIQuadDetectorResult

Base class for all detectors that are used for MBIQuadrangle detection.

Declaration

Objective-C


@interface MBIQuadDetectorResult : MBIDetectorResult <NSCopying>

Swift

class MBIQuadDetectorResult : MBIDetectorResult, NSCopying


                    
                    
                    MBIQuadWithSizeDetector

Base class for all detectors that are used for MBIQuadrangle detection and can also provide physical size of the detected document.

Declaration

Objective-C


@interface MBIQuadWithSizeDetector : MBIQuadDetector

Swift

class MBIQuadWithSizeDetector : MBIQuadDetector


                    
                    
                    MBIQuadWithSizeDetectorResult

Base class for all detectors that are used for MBIQuadrangle detection and can also provide physical size of the detected document.

Declaration

Objective-C


@interface MBIQuadWithSizeDetectorResult : MBIQuadDetectorResult <NSCopying>

Swift

class MBIQuadWithSizeDetectorResult : MBIQuadDetectorResult, NSCopying


                    
                    
                    MBIQuadrangle

Class represents the quadrangle (arbitrary geometric object with 4 different corner points

Declaration

Objective-C


@interface MBIQuadrangle : NSObject

Swift

class MBIQuadrangle : NSObject


                    
                    
                    MBIRawParser

MBIRawParser that simply returns the string version of raw OCR result, without performing any smart parsing operations.

Declaration

Objective-C


@interface MBIRawParser : MBIParser <NSCopying>

Swift

class MBIRawParser : MBIParser, NSCopying


                    
                    
                    MBIRawParserResult

MBIDateParser that can extract date from OCR result.

Declaration

Objective-C


@interface MBIRawParserResult : MBIParserResult <NSCopying>

Swift

class MBIRawParserResult : MBIParserResult, NSCopying


                    
                    
                    MBIRecognizer

Base class for all recognizers

Declaration

Objective-C


@interface MBIRecognizer : MBIEntity

Swift

class MBIRecognizer : MBIEntity


                    
                    
                    MBIRecognizerCollection

Settings class containing settings related to scanner behaviour

Declaration

Objective-C


@interface MBIRecognizerCollection : NSObject <NSCopying>

Swift

class MBIRecognizerCollection : NSObject, NSCopying


                    
                    
                    MBIRecognizerResult

Base class for all recognizer results

Declaration

Objective-C


@interface MBIRecognizerResult : NSObject

Swift

class MBIRecognizerResult : NSObject


                    
                    
                    MBIRecognizerRunner

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.

Declaration

Objective-C


@interface MBIRecognizerRunner : NSObject

Swift

class MBIRecognizerRunner : NSObject


                    
                    
                    MBIRecognizerRunnerMetadataDelegates

Class containing all metadata delegates

Declaration

Objective-C


@interface MBIRecognizerRunnerMetadataDelegates : NSObject

Swift

class MBIRecognizerRunnerMetadataDelegates : NSObject


                    
                    
                    MBIRecognizerRunnerViewControllerMetadataDelegates

Class containing all metadata delegates

Declaration

Objective-C


@interface MBIRecognizerRunnerViewControllerMetadataDelegates : NSObject

Swift

class MBIRecognizerRunnerViewControllerMetadataDelegates : NSObject


                    
                    
                    MBIRegexParser

Represents a parser which parses OCR result according to given regular expression. Regular expression parsing is not performed with java’s regex engine. Instead, it is performed with custom regular expression engine which can work with multiple char recognition alternatives (if enabled in MBIBaseOcrEngineOptions). Due to differences between parsing normal strings and OCR results, this parser does not support some regex features found in java’s regex engine, like back references.

Declaration

Objective-C


@interface MBIRegexParser : MBIParser <NSCopying>

Swift

class MBIRegexParser : MBIParser, NSCopying


                    
                    
                    MBIRegexParserResult

MBIDateParser that can extract date from OCR result.

Declaration

Objective-C


@interface MBIRegexParserResult : MBIParserResult <NSCopying>

Swift

class MBIRegexParserResult : MBIParserResult, NSCopying


                    
                    
                    MBIScanElement

The easiest way to UI for Ocr scanning is by specifying the MBIScanElements.

Each MBIScanElement knows

it’s name and Parser factory - which are needed for actual parsing
localized Title and Tooltip - which are needed in the UI
scanning region - percentage of screen used in scanning the element
information whether the element was scanned or edited
actual value of the element, used in business logic after the scannig

Declaration

Objective-C


@interface MBIScanElement : NSObject

Swift

class MBIScanElement : NSObject


                    
                    
                    MBISimNumberRecognizer

Recognizer that can perform recognition of barcodes on SIM packaging.

Declaration

Objective-C


@interface MBISimNumberRecognizer : MBIRecognizer <NSCopying>

Swift

class MBISimNumberRecognizer : MBIRecognizer, NSCopying


                    
                    
                    MBISimNumberRecognizerResult

Recognizer that can perform recognition of barcodes on SIM packaging.

Declaration

Objective-C


@interface MBISimNumberRecognizerResult : MBIRecognizerResult <NSCopying>

Swift

class MBISimNumberRecognizerResult : MBIRecognizerResult, NSCopying


                    
                    
                    MBISubview

Base class for all overlay subviews

Declaration

Objective-C


@interface MBISubview : UIView

Swift

class MBISubview : UIView


                    
                    
                    MBISuccessFrameGrabberRecognizer

A recognizer that can returns success frame.

Declaration

Objective-C


@interface MBISuccessFrameGrabberRecognizer : MBIRecognizer <NSCopying>

Swift

class MBISuccessFrameGrabberRecognizer : MBIRecognizer, NSCopying


                    
                    
                    MBISuccessFrameGrabberRecognizerResult

A recognizer that returns SuccessFrameGrabber result.

Declaration

Objective-C


@interface MBISuccessFrameGrabberRecognizerResult
    : MBIRecognizerResult <NSCopying>

Swift

class MBISuccessFrameGrabberRecognizerResult : MBIRecognizerResult, NSCopying


                    
                    
                    MBITapToFocusSubview

Overlay subview presenting the effect which happens when the user taps to focus

Declaration

Objective-C


@interface MBITapToFocusSubview : MBISubview

Swift

class MBITapToFocusSubview : MBISubview


                    
                    
                    MBITemplatingClass

Class that represents a specific class of documents when used within Templating API.

Declaration

Objective-C


@interface MBITemplatingClass : NSObject

Swift

class MBITemplatingClass : NSObject


                    
                    
                    MBITemplatingRecognizer

Base of all recognizers that support Templating API.

Declaration

Objective-C


@interface MBITemplatingRecognizer : MBIRecognizer

Swift

class MBITemplatingRecognizer : MBIRecognizer


                    
                    
                    MBITemplatingRecognizerResult

Base of all recognizers result that support Templating API.

Declaration

Objective-C


@interface MBITemplatingRecognizerResult : MBIRecognizerResult

Swift

class MBITemplatingRecognizerResult : MBIRecognizerResult


                    
                    
                    MBITopUpParser

MBITopUpParser is used for parsing Top Up numbers

Declaration

Objective-C


@interface MBITopUpParser : MBIParser <NSCopying>

Swift

class MBITopUpParser : MBIParser, NSCopying


                    
                    
                    MBITopUpParserResult

MBITopUpParser is used for parsing Top Up numbers

Declaration

Objective-C


@interface MBITopUpParserResult : MBIParserResult <NSCopying>

Swift

class MBITopUpParserResult : MBIParserResult, NSCopying


                    
                    
                    MBIViewControllerFactory

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.

Declaration

Objective-C


@interface MBIViewControllerFactory : NSObject

Swift

class MBIViewControllerFactory : NSObject


                    
                    
                    MBIVinParser

MBIVinParser is used for parsing VIN numbers

Declaration

Objective-C


@interface MBIVinParser : MBIParser <NSCopying>

Swift

class MBIVinParser : MBIParser, NSCopying


                    
                    
                    MBIVinParserResult

MBIVinParser is used for parsing VIN numbers

Declaration

Objective-C


@interface MBIVinParserResult : MBIParserResult <NSCopying>

Swift

class MBIVinParserResult : MBIParserResult, NSCopying


                    
                    
                    MBIVinRecognizer

Recognizer that can perform recognition of VINs (Vehicle Identification Number).

Declaration

Objective-C


@interface MBIVinRecognizer : MBIRecognizer <NSCopying>

Swift

class MBIVinRecognizer : MBIRecognizer, NSCopying


                    
                    
                    MBIVinRecognizerResult

Recognizer that can perform recognition of VINs (Vehicle Identification Number).

Declaration

Objective-C


@interface MBIVinRecognizerResult : MBIRecognizerResult <NSCopying>

Swift

class MBIVinRecognizerResult : MBIRecognizerResult, NSCopying