Classes

The following classes are available globally.

  • MBAmountParser is used for extracting amount from OCR result

    See more

    Declaration

    Objective-C

    
@interface MBAmountParser : MBParser <NSCopying>

    Swift

    class MBAmountParser : MBParser, NSCopying

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

    See more

    Declaration

    Objective-C

    
@interface MBBarcodeRecognizer : MBRecognizer <NSCopying>

    Swift

    class MBBarcodeRecognizer : MBRecognizer, NSCopying

  • 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.

    See more

    Declaration

    Objective-C

    
@interface MBBaseOcrEngineOptions : NSObject

    Swift

    class MBBaseOcrEngineOptions : NSObject

  • Settings class containing parameters for camera capture

    See more

    Declaration

    Objective-C

    
@interface MBCameraSettings : NSObject <NSCopying>

    Swift

    class MBCameraSettings : NSObject, NSCopying

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

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

    See more

    Declaration

    Objective-C

    
@interface MBDPIBasedDewarpPolicy : MBDewarpPolicy

    Swift

    class MBDPIBasedDewarpPolicy : MBDewarpPolicy

  • MBDateParser that can extract date from OCR result.

    See more

    Declaration

    Objective-C

    
@interface MBDateParser : MBParser <NSCopying>

    Swift

    class MBDateParser : MBParser, NSCopying

  • 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.

    See more

    Declaration

    Objective-C

    
@interface MBDateResult : NSObject <MBNativeResult>

    Swift

    class MBDateResult : NSObject, MBNativeResult

  • 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.

    See more

    Declaration

    Objective-C

    
@interface MBDeepOcrEngineOptions : MBBaseOcrEngineOptions <NSCopying>

    Swift

    class MBDeepOcrEngineOptions : MBBaseOcrEngineOptions, NSCopying

  • Base class for all detectors results

    See more

    Declaration

    Objective-C

    
@interface MBDetectorResult : NSObject

    Swift

    class MBDetectorResult : NSObject

  • Base class for all dewarp policies

    See more

    Declaration

    Objective-C

    
@interface MBDewarpPolicy : NSObject

    Swift

    class MBDewarpPolicy : NSObject

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

    See more

    Declaration

    Objective-C

    
@interface MBDisplayableObject : NSObject

    Swift

    class MBDisplayableObject : NSObject

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

    See more

    Declaration

    Objective-C

    
@interface MBDocumentSpecification : NSObject <NSCopying>

    Swift

    class MBDocumentSpecification : NSObject, NSCopying

  • Overlay subview presenting the viewfinder for scanning ID documents

    The subview draws a rounded rectangle in the shape of an ID document, in which the user should position the ID (ideal positioning is not required).

    The rounded rectangle is centered on the screen.

    The aspect ratio of the document can be set as a parameter

    See more

    Declaration

    Objective-C

    
@interface MBDocumentSubview : MBSubview

    Swift

    class MBDocumentSubview : MBSubview

  • MBEmailParser is used for parsing emails

    See more

    Declaration

    Objective-C

    
@interface MBEmailParser : MBParser <NSCopying>

    Swift

    class MBEmailParser : MBParser, NSCopying

  • Base class for all entities processors, recognizers, detectors…

    Declaration

    Objective-C

    
@interface MBEntity : NSObject

    Swift

    class MBEntity : NSObject

  • 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.

    See more

    Declaration

    Objective-C

    
@interface MBFixedDewarpPolicy : MBDewarpPolicy

    Swift

    class MBFixedDewarpPolicy : MBDewarpPolicy

  • 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

    See more

    Declaration

    Objective-C

    
@interface MBGlareStatusSubview : MBSubview

    Swift

    class MBGlareStatusSubview : MBSubview

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

    See more

    Declaration

    Objective-C

    
@interface MBIbanParser : MBParser <NSCopying>

    Swift

    class MBIbanParser : MBParser, NSCopying

  • Object which represents an image.

    See more

    Declaration

    Objective-C

    
@interface MBImage : NSObject

    Swift

    class MBImage : NSObject

  • MBLicensePlatesParser is used for parsing license plates

    See more

    Declaration

    Objective-C

    
@interface MBLicensePlatesParser : MBParser <NSCopying>

    Swift

    class MBLicensePlatesParser : MBParser, NSCopying

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface MBMicroblinkApp : NSObject

@property (nonatomic) NSString *language;

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

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

/** Designated initializer */
- (id)init;

/** 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 MBMicroblinkApp : NSObject

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

    See more

    Declaration

    Objective-C

    
@interface MBMicroblinkSDK : NSObject

    Swift

    class MBMicroblinkSDK : NSObject

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

    See more

    Declaration

    Objective-C

    
@interface MBMrtdSpecification : NSObject <NSCopying>

    Swift

    class MBMrtdSpecification : NSObject, NSCopying

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface MBMrzResult : NSObject

MB_INIT_UNAVAILABLE

/**
 * Returns the MRTD document type of recognized document.
 */
@property (nonatomic, assign, readonly) MBMrtdDocumentType documentType;

/**
 * Returns the primary indentifier. If there is more than one component, they are separated with space.
 */
@property (nonatomic, strong, readonly) NSString *primaryID;

/**
 * Returns the secondary identifier. If there is more than one component, they are separated with space.
 */
@property (nonatomic, strong, readonly) NSString *secondaryID;

/**
 * Returns three-letter or two-letter code which indicate the issuing State. Three-letter codes are based
 * on Aplha-3 codes for entities specified in ISO 3166-1, with extensions for certain States. Two-letter
 * codes are based on Aplha-2 codes for entities specified in ISO 3166-1, with extensions for certain States.
 */
@property (nonatomic, strong, readonly) NSString *issuer;

/**
 * Returns holder's date of birth
 */
@property (nonatomic, strong, readonly) MBDateResult *dateOfBirth;

/**
 * Returns document number. Document number contains up to 9 characters.
 * Element does not exist on US Green Card. To see which document was scanned use documentType.
 */
@property (nonatomic, strong, readonly) NSString *documentNumber;

/**
 * Returns nationality of the holder represented by a three-letter or two-letter code. Three-letter
 * codes are based on Alpha-3 codes for entities specified in ISO 3166-1, with extensions for certain
 * States. Two-letter codes are based on Aplha-2 codes for entities specified in ISO 3166-1, with
 * extensions for certain States.
 */
@property (nonatomic, strong, readonly) NSString *nationality;

/**
 * Returns gender of the card holder. Gender is specified by use of the single initial, capital letter F for female,
 * M for male or ; for unspecified.
 */
@property (nonatomic, strong, readonly) NSString *gender;

/**
 * Returns document code. Document code contains two characters. For MRTD the first character shall
 * be A, C or I. The second character shall be discretion of the issuing State or organization except
 * that V shall not be used, and `C` shall not be used after `A` except in the crew member certificate.
 * On machine-readable passports (MRP) first character shall be `P` to designate an MRP. One additional
 * letter may be used, at the discretion of the issuing State or organization, to designate a particular
 * MRP. If the second character position is not used for this purpose, it shall be filled by the filter
 * character ;.
 */
@property (nonatomic, strong, readonly) NSString *documentCode;

/**
 * Returns date of expiry
 */
@property (nonatomic, strong, readonly) MBDateResult *dateOfExpiry;

/**
 * Returns first optional data. Returns empty string if not available.
 * Element does not exist on US Green Card. To see which document was scanned use documentType.
 */
@property (nonatomic, strong, readonly) NSString *opt1;

/**
 * Returns second optional data. Returns empty string if not available.
 * Element does not exist on US Green Card. To see which document was scanned use documentType.
 */
@property (nonatomic, strong, readonly) NSString *opt2;

/**
 * Returns alien number. Returns empty string if not available.
 * Exists only on US Green Cards. To see which document was scanned use documentType.
 */
@property (nonatomic, strong, readonly) NSString *alienNumber;

/**
 * Returns application receipt number. Returns empty string if not available.
 * Exists only on US Green Cards. To see which document was scanned use documentType.
 */
@property (nonatomic, strong, readonly) NSString *applicationReceiptNumber;

/**
 * Returns immigrant case number. Returns empty string if not available.
 * Exists only on US Green Cards. To see which document was scanned use documentType.
 */
@property (nonatomic, strong, readonly) NSString *immigrantCaseNumber;

/**
 * Returns the entire Machine Readable Zone text from ID. This text is usually used for parsing
 * other elements.
 * NOTE: This string is available only if OCR result was parsed successfully.
 */
@property (nonatomic, strong, readonly) NSString *mrzText;

/**
 * Returns true if Machine Readable Zone has been parsed, false otherwise.
 */
@property (nonatomic, assign, readonly) BOOL isParsed;

/**
 * Returns true if all check digits inside MRZ are correct, false otherwise.
 */
@property (nonatomic, assign, readonly) BOOL isVerified;

@end

    Swift

    class MBMrzResult : NSObject

  • 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.

    See more

    Declaration

    Objective-C

    
@interface MBNoUpScalingDewarpPolicy : MBDewarpPolicy

    Swift

    class MBNoUpScalingDewarpPolicy : MBDewarpPolicy

  • Class representing a char in specific font.

    @example char ‘k’ in font Arial

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

    @example char ‘ü’ in any font

     MBOcrCharKey* key = [[MBOcrCharKey alloc] initWithCode:'ü' font:MB_OCR_FONT_ANY];
    See more

    Declaration

    Objective-C

    
@interface MBOcrCharKey : NSObject

    Swift

    class MBOcrCharKey : NSObject

  • 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.

    See more

    Declaration

    Objective-C

    
@interface MBOcrEngineOptions : MBBaseOcrEngineOptions <NSCopying>

    Swift

    class MBOcrEngineOptions : MBBaseOcrEngineOptions, NSCopying

  • 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

    MBOcrBlock

    See

    MBOcrLine

    See

    MBOcrChar
    See more

    Declaration

    Objective-C

    
@interface MBOcrLayout : NSObject

    Swift

    class MBOcrLayout : NSObject

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

    See

    MBOcrLine
    See more

    Declaration

    Objective-C

    
@interface MBOcrBlock : NSObject

    Swift

    class MBOcrBlock : NSObject

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

    See

    MBOcrChar
    See more

    Declaration

    Objective-C

    
@interface MBOcrLine : NSObject

    Swift

    class MBOcrLine : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface MBCharWithVariants : NSObject

/**
 * Character that was recognised
 */
@property (nonatomic) MBOcrChar * 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:(MBOcrChar *)character NS_DESIGNATED_INITIALIZER;

@end

    Swift

    class MBCharWithVariants : NSObject

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

    See more

    Declaration

    Objective-C

    
@interface MBOcrChar : NSObject

    Swift

    class MBOcrChar : NSObject

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

    See more

    Declaration

    Objective-C

    
@interface MBPosition : NSObject

    Swift

    class MBPosition : NSObject

  • Settings class containing UI information

    See more

    Declaration

    Objective-C

    
@interface MBOverlaySettings : NSObject <NSCopying>

    Swift

    class MBOverlaySettings : NSObject, NSCopying

  • 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
    See more

    Declaration

    Objective-C

    
@interface MBOverlayViewController : UIViewController

    Swift

    class MBOverlayViewController : UIViewController

  • Base class for all parser results

    See more

    Declaration

    Objective-C

    
@interface MBParserResult : NSObject

    Swift

    class MBParserResult : NSObject

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

    See more

    Declaration

    Objective-C

    
@interface MBProcessorGroup : NSObject

    Swift

    class MBProcessorGroup : NSObject

  • Base class for all processor results

    See more

    Declaration

    Objective-C

    
@interface MBProcessorResult : NSObject

    Swift

    class MBProcessorResult : NSObject

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

    See more

    Declaration

    Objective-C

    
@interface MBQuadWithSizeDetector : MBQuadDetector

    Swift

    class MBQuadWithSizeDetector : MBQuadDetector

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

    See more

    Declaration

    Objective-C

    
@interface MBQuadrangle : NSObject

    Swift

    class MBQuadrangle : NSObject

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

    See more

    Declaration

    Objective-C

    
@interface MBRawParser : MBParser <NSCopying>

    Swift

    class MBRawParser : MBParser, NSCopying

  • Settings class containing settings related to scanner behaviour

    See more

    Declaration

    Objective-C

    
@interface MBRecognizerCollection : NSObject <NSCopying>

    Swift

    class MBRecognizerCollection : NSObject, NSCopying

  • Base class for all recognizer results

    See more

    Declaration

    Objective-C

    
@interface MBRecognizerResult : NSObject

    Swift

    class MBRecognizerResult : 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.

    See more

    Declaration

    Objective-C

    
@interface MBRecognizerRunner : NSObject

    Swift

    class MBRecognizerRunner : NSObject

  • Class containing all metadata delegates

    See more

    Declaration

    Objective-C

    
@interface MBRecognizerRunnerMetadataDelegates : NSObject

    Swift

    class MBRecognizerRunnerMetadataDelegates : NSObject

  • 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 MBBaseOcrEngineOptions). 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.

    See more

    Declaration

    Objective-C

    
@interface MBRegexParser : MBParser <NSCopying>

    Swift

    class MBRegexParser : MBParser, NSCopying

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

    Each MBScanElement 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
    See more

    Declaration

    Objective-C

    
@interface MBScanElement : NSObject

    Swift

    class MBScanElement : NSObject

  • Base class for all overlay subviews

    See more

    Declaration

    Objective-C

    
@interface MBSubview : UIView

    Swift

    class MBSubview : UIView

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

    See more

    Declaration

    Objective-C

    
@interface MBTemplatingClass : NSObject

    Swift

    class MBTemplatingClass : NSObject

  • MBTopUpParser is used for parsing Top Up numbers

    See more

    Declaration

    Objective-C

    
@interface MBTopUpParser : MBParser <NSCopying>

    Swift

    class MBTopUpParser : MBParser, NSCopying

  • 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.

    See more

    Declaration

    Objective-C

    
@interface MBViewControllerFactory : NSObject

    Swift

    class MBViewControllerFactory : NSObject

  • MBVinParser is used for parsing VIN numbers

    See more

    Declaration

    Objective-C

    
@interface MBVinParser : MBParser <NSCopying>

    Swift

    class MBVinParser : MBParser, NSCopying

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

    See more

    Declaration

    Objective-C

    
@interface MBVinRecognizer : MBRecognizer <NSCopying>

    Swift

    class MBVinRecognizer : MBRecognizer, NSCopying