MBBlinkIdCombinedRecognizer Struct Reference

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

#include <IdCombinedRecognizer.h>

Public Member Functions
MB_API MBRecognizerErrorStatus MB_CALL	blinkIdCombinedRecognizerCreate (MBBlinkIdCombinedRecognizer **blinkIdCombinedRecognizer, MBBlinkIdCombinedRecognizerSettings const *blinkIdCombinedRecognizerSettings)
	Allocates and initializes new BlinkIDCombinedRecognizer object. More...
MB_API MBRecognizerErrorStatus MB_CALL	blinkIdCombinedRecognizerUpdate (MBBlinkIdCombinedRecognizer *blinkIdCombinedRecognizer, MBBlinkIdCombinedRecognizerSettings const *blinkIdCombinedRecognizerSettings)
	Updates the BlinkIDCombinedRecognizer 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	blinkIdCombinedRecognizerResult (MBBlinkIdCombinedRecognizerResult *result, MBBlinkIdCombinedRecognizer const *blinkIdCombinedRecognizer)
	Obtains the result from the given BlinkIDCombinedRecognizer object. More...
MB_API MBRecognizerErrorStatus MB_CALL	blinkIdCombinedRecognizerDelete (MBBlinkIdCombinedRecognizer **blinkIdCombinedRecognizer)
	Destroys the given BlinkIDCombinedRecognizer. More...

Detailed Description

A recognizer that can scan and parse identity cards.

Typedef for the MBBlinkIdCombinedRecognizer structure.

Member Function Documentation

blinkIdCombinedRecognizerCreate()

MB_API MBRecognizerErrorStatus MB_CALL blinkIdCombinedRecognizerCreate	(	MBBlinkIdCombinedRecognizer **	blinkIdCombinedRecognizer,
		MBBlinkIdCombinedRecognizerSettings const *	blinkIdCombinedRecognizerSettings
	)

Allocates and initializes new BlinkIDCombinedRecognizer object.

Parameters

blinkIdCombinedRecognizer	Pointer to pointer referencing the created BlinkIDCombinedRecognizer object.
blinkIdCombinedRecognizerSettings	Settings that will be used for creating of the BlinkIDCombinedRecognizer 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.

blinkIdCombinedRecognizerDelete()

MB_API MBRecognizerErrorStatus MB_CALL blinkIdCombinedRecognizerDelete

(

MBBlinkIdCombinedRecognizer **

blinkIdCombinedRecognizer

)

Destroys the given BlinkIDCombinedRecognizer.

Parameters

blinkIdCombinedRecognizer

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

Returns

status of the operation

blinkIdCombinedRecognizerResult()

MB_API MBRecognizerErrorStatus MB_CALL blinkIdCombinedRecognizerResult	(	MBBlinkIdCombinedRecognizerResult *	result,
		MBBlinkIdCombinedRecognizer const *	blinkIdCombinedRecognizer
	)

Obtains the result from the given BlinkIDCombinedRecognizer object.

Parameters

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

Returns

status of the operation.

blinkIdCombinedRecognizerUpdate()

MB_API MBRecognizerErrorStatus MB_CALL blinkIdCombinedRecognizerUpdate	(	MBBlinkIdCombinedRecognizer *	blinkIdCombinedRecognizer,
		MBBlinkIdCombinedRecognizerSettings const *	blinkIdCombinedRecognizerSettings
	)

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

Parameters

blinkIdCombinedRecognizer	BlinkIDCombinedRecognizer that should be updated with new settings.
blinkIdCombinedRecognizerSettings	Settings that will be used for updating the BlinkIDCombinedRecognizer 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/IdCombinedRecognizer.h