BlinkID C SDK version 5.16.0
Public Member Functions
MBIdBarcodeRecognizer Struct Reference

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

#include <IdBarcodeRecognizer.h>

Public Member Functions

MB_API MBRecognizerErrorStatus MB_CALL barcodeIdRecognizerCreate (MBIdBarcodeRecognizer **barcodeIdRecognizer)
 Allocates and initializes new IDBarcodeRecognizer object. More...
 
MB_API MBRecognizerErrorStatus MB_CALL barcodeIdRecognizerResult (MBIdBarcodeRecognizerResult *result, MBIdBarcodeRecognizer const *barcodeIdRecognizer)
 Obtains the result from the given IDBarcodeRecognizer object. More...
 
MB_API MBRecognizerErrorStatus MB_CALL barcodeIdRecognizerDelete (MBIdBarcodeRecognizer **barcodeIdRecognizer)
 Destroys the given IDBarcodeRecognizer. More...
 

Detailed Description

A recognizer that can scan and parse identity cards.

Typedef for the MBIdBarcodeRecognizer structure.

Member Function Documentation

◆ barcodeIdRecognizerCreate()

MB_API MBRecognizerErrorStatus MB_CALL barcodeIdRecognizerCreate ( MBIdBarcodeRecognizer **  barcodeIdRecognizer)

Allocates and initializes new IDBarcodeRecognizer object.

Parameters
barcodeIdRecognizerPointer to pointer referencing the created IDBarcodeRecognizer 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.

◆ barcodeIdRecognizerDelete()

MB_API MBRecognizerErrorStatus MB_CALL barcodeIdRecognizerDelete ( MBIdBarcodeRecognizer **  barcodeIdRecognizer)

Destroys the given IDBarcodeRecognizer.

Parameters
barcodeIdRecognizerPointer to pointer to IDBarcodeRecognizer structure that needs to be destroyed. After destruction, the pointer to IDBarcodeRecognizer structure will be set to NULL.
Returns
status of the operation

◆ barcodeIdRecognizerResult()

MB_API MBRecognizerErrorStatus MB_CALL barcodeIdRecognizerResult ( MBIdBarcodeRecognizerResult result,
MBIdBarcodeRecognizer const *  barcodeIdRecognizer 
)

Obtains the result from the given IDBarcodeRecognizer object.

Parameters
resultIDBarcodeRecognizerResult structure that will be filled with the recognized data. Note that all pointers in structure will remain valid until given recognizer is destroyed with barcodeIdRecognizerDelete function or is used for performing the new recognition.
barcodeIdRecognizerIDBarcodeRecognizer from which result should be obtained.
Returns
status of the operation.

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