MBBlinkIdRecognizer Struct Reference

A recognizer that can scan and parse identity cards. More...

#include <IdRecognizer.h>

Public Member Functions
MB_API MBRecognizerErrorStatus MB_CALL	blinkIdRecognizerCreate (MBBlinkIdRecognizer **blinkIdRecognizer, MBBlinkIdRecognizerSettings const *blinkIdRecognizerSettings)
	Allocates and initializes new GenericIDRecognizer object. More...
MB_API MBRecognizerErrorStatus MB_CALL	blinkIdRecognizerUpdate (MBBlinkIdRecognizer *blinkIdRecognizer, MBBlinkIdRecognizerSettings const *blinkIdRecognizerSettings)
	Updates the GenericIDRecognizer with the new settings. Note that updating the recognizer while it is being in use by MBRecognizerRunner will fail. More...
MB_API MBRecognizerErrorStatus MB_CALL	blinkIdRecognizerResult (MBBlinkIdRecognizerResult *result, MBBlinkIdRecognizer const *blinkIdRecognizer)
	Obtains the result from the given GenericIDRecognizer object. More...
MB_API MBRecognizerErrorStatus MB_CALL	blinkIdRecognizerDelete (MBBlinkIdRecognizer **blinkIdRecognizer)
	Destroys the given GenericIDRecognizer. More...

Detailed Description

A recognizer that can scan and parse identity cards.

Typedef for the MBBlinkIdRecognizer structure.

Member Function Documentation

blinkIdRecognizerCreate()

MB_API MBRecognizerErrorStatus MB_CALL blinkIdRecognizerCreate	(	MBBlinkIdRecognizer **	blinkIdRecognizer,
		MBBlinkIdRecognizerSettings const *	blinkIdRecognizerSettings
	)

Allocates and initializes new GenericIDRecognizer object.

Parameters

blinkIdRecognizer	Pointer to pointer referencing the created GenericIDRecognizer object.
blinkIdRecognizerSettings	Settings that will be used for creating of the GenericIDRecognizer object.

Returns

status of the operation. The operation may fail (i.e. if license key is not set or does not allow usage of the requested recognizer), so please check the returned status for possible errors.

blinkIdRecognizerDelete()

MB_API MBRecognizerErrorStatus MB_CALL blinkIdRecognizerDelete

(

MBBlinkIdRecognizer **

blinkIdRecognizer

)

Destroys the given GenericIDRecognizer.

Parameters

blinkIdRecognizer

Pointer to pointer to GenericIDRecognizer structure that needs to be destroyed. After destruction, the pointer to GenericIDRecognizer structure will be set to NULL.

Returns

status of the operation

blinkIdRecognizerResult()

MB_API MBRecognizerErrorStatus MB_CALL blinkIdRecognizerResult	(	MBBlinkIdRecognizerResult *	result,
		MBBlinkIdRecognizer const *	blinkIdRecognizer
	)

Obtains the result from the given GenericIDRecognizer object.

Parameters

result	GenericIDRecognizerResult structure that will be filled with the recognized data. Note that all pointers in structure will remain valid until given recognizer is destroyed with blinkIdRecognizerDelete function or is used for performing the new recognition.
blinkIdRecognizer	GenericIDRecognizer from which result should be obtained.

Returns

status of the operation.

blinkIdRecognizerUpdate()

MB_API MBRecognizerErrorStatus MB_CALL blinkIdRecognizerUpdate	(	MBBlinkIdRecognizer *	blinkIdRecognizer,
		MBBlinkIdRecognizerSettings const *	blinkIdRecognizerSettings
	)

Updates the GenericIDRecognizer with the new settings. Note that updating the recognizer while it is being in use by MBRecognizerRunner will fail.

Parameters

blinkIdRecognizer	GenericIDRecognizer that should be updated with new settings.
blinkIdRecognizerSettings	Settings that will be used for updating the GenericIDRecognizer object.

Returns

status of the operation. The operation may fail (i.e. if recognizer is in use by the MBRecognizerRunner), so please check the returned status for possible errors.

---

The documentation for this struct was generated from the following file:

• inc/Recognizer/BlinkID/Generic/IdRecognizer.h