MRZ_Interface Interface Reference

Description

Interface class for Grabba MRZ reader events.

Objects which implement this interface may receive callbacks when these events occur, via delegation from a MRZ_Listener object.

Note that this interface need not be directly implemented; it may be simpler to subclass MRZ_Listener and thereby receive the events directly.

Thread safety: This interface is intended to be thread-safe; any classes deriving from it should ensure that the relevant methods are callable from any thread.

See also

MRZ_API for related API functions, and MRZ_Listener for more detailed descriptions of each event.

Inheritance diagram for MRZ_Interface:

Public Member Functions
void	dataEvent (@NonNull MRZ_Data data)
	Callback which is invoked when a Machine-Readable Zone (MRZ) is read, regardless of validation outcome. More...
void	validatedDataEvent (@NonNull ValidatedMRZ data)
	Callback which is invoked when a Machine-Readable Zone (MRZ) is read and successfully validated. More...
void	validationFailedEvent (@NonNull MRZ_Data data, @NonNull String reason)
	Callback which is invoked when a Machine-Readable Zone (MRZ) is read, but fails to pass validation. More...

Member Function Documentation

dataEvent()

void dataEvent

(

@NonNull MRZ_Data

data

)

Callback which is invoked when a Machine-Readable Zone (MRZ) is read, regardless of validation outcome.

Note

Implementations of this method are required to be thread-safe; no guarantees are made about which thread(s) they will be called from.

Parameters

data	Passport, visa or identity card data which was read from the MRZ; see MRZ_Data for details

Implemented in MRZ_Listener.

validatedDataEvent()

void validatedDataEvent

(

@NonNull ValidatedMRZ

data

)

Callback which is invoked when a Machine-Readable Zone (MRZ) is read and successfully validated.

Note

Implementations of this method are required to be thread-safe; no guarantees are made about which thread(s) they will be called from.

Parameters

data	Passport, visa or identity card data which was read from the MRZ; see ValidatedMRZ for details

Implemented in MRZ_Listener.

validationFailedEvent()

void validationFailedEvent	(	@NonNull MRZ_Data	data,
		@NonNull String	reason
	)

Callback which is invoked when a Machine-Readable Zone (MRZ) is read, but fails to pass validation.

Note

Implementations of this method are required to be thread-safe; no guarantees are made about which thread(s) they will be called from.

Parameters

data	Passport, visa or identity card data which was read from the MRZ; see MRZ_Data for details
reason	Brief description of the reason why validation failed

Implemented in MRZ_Listener.