Classes
The following classes are available globally.
-
Settings class containing UI information
See moreDeclaration
Objective-C
@interface MBBBarcodeOverlaySettings : MBBBaseOverlaySettings
Swift
class MBBBarcodeOverlaySettings : MBBBaseOverlaySettings
-
Undocumented
See moreDeclaration
Objective-C
@interface MBBBarcodeOverlayViewController : MBBBaseOverlayViewController
Swift
class MBBBarcodeOverlayViewController : MBBBaseOverlayViewController
-
MBBBarcodeRecognizer is used for scanning most of 1D barcode formats, and 2D format such as Aztec, DataMatrix and QR code
See moreDeclaration
Objective-C
@interface MBBBarcodeRecognizer : MBBRecognizer <NSCopying>
Swift
class MBBBarcodeRecognizer : MBBRecognizer, NSCopying
-
Result of MBBBarcodeRecognizer; is used for scanning most of 1D barcode formats, and 2D format such as Aztec, DataMatrix and QR code
See moreDeclaration
Objective-C
@interface MBBBarcodeRecognizerResult : MBBRecognizerResult <NSCopying>
Swift
class MBBBarcodeRecognizerResult : MBBRecognizerResult, NSCopying
-
Settings class containing UI information
See moreDeclaration
Objective-C
@interface MBBBaseOverlaySettings : MBBOverlaySettings
Swift
class MBBBaseOverlaySettings : MBBOverlaySettings
-
Common base class for default overlay view controllers
See moreDeclaration
Objective-C
@interface MBBBaseOverlayViewController : MBBOverlayViewController
Swift
class MBBBaseOverlayViewController : MBBOverlayViewController
-
Settings class containing parameters for camera capture
See moreDeclaration
Objective-C
@interface MBBCameraSettings : NSObject <NSCopying>
Swift
class MBBCameraSettings : NSObject, NSCopying
-
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.
See moreDeclaration
Objective-C
@interface MBBCustomOverlayViewController : MBBOverlayViewController
Swift
class MBBCustomOverlayViewController : MBBOverlayViewController
-
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 moreDeclaration
Objective-C
@interface MBBDateResult : NSObject <MBBNativeResult>
Swift
class MBBDateResult : NSObject, MBBNativeResult
-
Represents a detection that can be displayed on screen.
See moreDeclaration
Objective-C
@interface MBBDisplayableDetection : MBBDisplayableObject
Swift
class MBBDisplayableDetection : MBBDisplayableObject
-
Represents any object that can be displayed on screen in terms of drawing.
See moreDeclaration
Objective-C
@interface MBBDisplayableObject : NSObject
Swift
class MBBDisplayableObject : NSObject
-
Result of the detection of a point detector. Point Detectors are used for QR and similar barcodes
See moreDeclaration
Objective-C
@interface MBBDisplayablePointsDetection : MBBDisplayableDetection
Swift
class MBBDisplayablePointsDetection : MBBDisplayableDetection
-
Represents a detection that can be displayed on screen.
See moreDeclaration
Objective-C
@interface MBBDisplayableQuadDetection : MBBDisplayableDetection
Swift
class MBBDisplayableQuadDetection : MBBDisplayableDetection
-
Overlay subview presenting status of OCR detection. Dots are displayed over locations of detected characters.
See moreDeclaration
Objective-C
@interface MBBDotsResultSubview : MBBSubview <MBBPointDetectorSubview>
Swift
class MBBDotsResultSubview : MBBSubview, MBBPointDetectorSubview
-
A wrapper around CAShapeLayer which is used for presenting a status about barcode detections
The layer is used to draw dots representing barcodes
See moreDeclaration
Objective-C
@interface MBBDotsSubview : MBBSubview <MBBPointDetectorSubview>
Swift
class MBBDotsSubview : MBBSubview, MBBPointDetectorSubview
-
Base class for all entities processors, recognizers, detectors…
Declaration
Objective-C
@interface MBBEntity : NSObject
Swift
class MBBEntity : NSObject
-
A recognizer that can returns success frame.
See moreDeclaration
Objective-C
@interface MBBFrameGrabberRecognizer : MBBRecognizer <NSCopying>
Swift
class MBBFrameGrabberRecognizer : MBBRecognizer, NSCopying
-
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 moreDeclaration
Objective-C
@interface MBBGlareStatusSubview : MBBSubview
Swift
class MBBGlareStatusSubview : MBBSubview
-
Object which represents an image.
See moreDeclaration
Objective-C
@interface MBBImage : NSObject
Swift
class MBBImage : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface MBBLogger : NSObject @property (nonatomic) id<MBBLoggerDelegate> delegate; + (instancetype)sharedInstance NS_SWIFT_NAME(shared()); - (void)disableMicroblinkLogging; @end
Swift
class MBBLogger : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface MBBMicroblinkApp : 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 MBBMicroblinkApp : NSObject
-
Entry class for all Microblink SDKs - used for setting up license key and to add support for optimisation of passing data.
See moreDeclaration
Objective-C
@interface MBBMicroblinkSDK : NSObject
Swift
class MBBMicroblinkSDK : NSObject
-
Overlay subview presenting the status of detection. The subview is presented as green corners located on edges of detection points.
See moreDeclaration
Objective-C
@interface MBBModernViewfinderSubview : MBBSubview <MBBQuadDetectorSubview>
Swift
class MBBModernViewfinderSubview : MBBSubview, MBBQuadDetectorSubview
-
Settings class containing UI information
See moreDeclaration
Objective-C
@interface MBBOverlaySettings : NSObject <NSCopying>
Swift
class MBBOverlaySettings : 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
Declaration
Objective-C
@interface MBBOverlayViewController : UIViewController
Swift
class MBBOverlayViewController : UIViewController
-
Deprecated
Use MBBBarcodeRecognizer.
A recognizer that can scan PDF417 2D barcodes.
See moreDeclaration
Objective-C
@interface MBBPdf417Recognizer : MBBRecognizer <NSCopying>
Swift
class MBBPdf417Recognizer : MBBRecognizer, NSCopying
-
A recognizer that can scan PDF417 2D barcodes.
See moreDeclaration
Objective-C
@interface MBBPdf417RecognizerResult : MBBRecognizerResult <NSCopying>
Swift
class MBBPdf417RecognizerResult : MBBRecognizerResult, NSCopying
-
Class represents the quadrangle (arbitrary geometric object with 4 different corner points
See moreDeclaration
Objective-C
@interface MBBQuadrangle : NSObject
Swift
class MBBQuadrangle : NSObject
-
Base class for all recognizers
See more -
Settings class containing settings related to scanner behaviour
See moreDeclaration
Objective-C
@interface MBBRecognizerCollection : NSObject <NSCopying>
Swift
class MBBRecognizerCollection : NSObject, NSCopying
-
Base class for all recognizer results
See moreDeclaration
Objective-C
@interface MBBRecognizerResult : NSObject
Swift
class MBBRecognizerResult : 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 moreDeclaration
Objective-C
@interface MBBRecognizerRunner : NSObject
Swift
class MBBRecognizerRunner : NSObject
-
Class containing all metadata delegates
See moreDeclaration
Objective-C
@interface MBBRecognizerRunnerMetadataDelegates : NSObject
Swift
class MBBRecognizerRunnerMetadataDelegates : NSObject
-
Class containing all metadata delegates
See moreDeclaration
Objective-C
@interface MBBRecognizerRunnerViewControllerMetadataDelegates : NSObject
Swift
class MBBRecognizerRunnerViewControllerMetadataDelegates : NSObject
-
Recognizer that can perform recognition of barcodes on SIM packaging.
See moreDeclaration
Objective-C
@interface MBBSimNumberRecognizer : MBBRecognizer <NSCopying>
-
Recognizer that can perform recognition of barcodes on SIM packaging.
See moreDeclaration
Objective-C
@interface MBBSimNumberRecognizerResult : MBBRecognizerResult <NSCopying>
-
Base class for all overlay subviews
See moreDeclaration
Objective-C
@interface MBBSubview : UIView
Swift
class MBBSubview : UIView
-
A recognizer that can returns success frame.
See moreDeclaration
Objective-C
@interface MBBSuccessFrameGrabberRecognizer : MBBRecognizer <NSCopying>
Swift
class MBBSuccessFrameGrabberRecognizer : MBBRecognizer, NSCopying
-
A recognizer that returns SuccessFrameGrabber result.
See moreDeclaration
Objective-C
@interface MBBSuccessFrameGrabberRecognizerResult : MBBRecognizerResult <NSCopying>
Swift
class MBBSuccessFrameGrabberRecognizerResult : MBBRecognizerResult, NSCopying
-
Overlay subview presenting the effect which happens when the user taps to focus
See moreDeclaration
Objective-C
@interface MBBTapToFocusSubview : MBBSubview
Swift
class MBBTapToFocusSubview : MBBSubview
-
A recognizer that can scan USDL.
See moreDeclaration
Objective-C
@interface MBBUsdlRecognizer : MBBRecognizer <NSCopying>
-
A recognizer that can scan PDF417 2D barcodes.
See moreDeclaration
Objective-C
@interface MBBUsdlRecognizerResult : MBBRecognizerResult <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 moreDeclaration
Objective-C
@interface MBBViewControllerFactory : NSObject
Swift
class MBBViewControllerFactory : NSObject