GrabbaMRZ_API Class Reference

Description

Provides access to Grabba Machine-Readable Zone (MRZ) functionality.

This API provides access to MRZ scanner functions. Note, however, that MRZ reading is triggered by the scanner itself (not the driver), so this API is quite small.

Callbacks to user-provided code may be triggered in response to relevant events, e.g. successful scan of a MRZ. Refer to the GrabbaMRZListener class for the details of these callbacks and how to enable them.

Calls to this class will not succeed until a connection to a Grabba device has been established. Refer to the GrabbaCoreAPI class for details of how to establish or query this connection.

Note

This is a static class; object construction is unnecessary and consequently disabled. Subclassing is strongly discouraged.

Thread safety: This class is fully thread-safe.

Inheritance diagram for GrabbaMRZ_API:

Instance Methods
(instancetype _Nullable)	- init
	Not callable (NS_UNAVAILABLE) since this is a static class. More...

Class Methods
(BOOL)	+ supported
	Query whether there is currently a connected Grabba device with MRZ scanner functionality. More...

Method Documentation

init()

- (instancetype _Nullable) init

Not callable (NS_UNAVAILABLE) since this is a static class.

supported()

+ (BOOL) supported

Query whether there is currently a connected Grabba device with MRZ scanner functionality.

This is a non-blocking call; device capabilities are cached internally by the driver.

Returns

YES if there is a connected Grabba device and that device supports MRZ functionality; NO otherwise.