MBBarcodeRecognizer Struct Reference

A recognizer that can scan barcodes. More...

#include <BarcodeRecognizer.h>

Public Member Functions
MB_API MBRecognizerErrorStatus MB_CALL	barcodeRecognizerCreate (MBBarcodeRecognizer **barcodeRecognizer, MBBarcodeRecognizerSettings const *barcodeRecognizerSettings)
	Allocates and initializes new MBBarcodeRecognizer object. More...
MB_API MBRecognizerErrorStatus MB_CALL	barcodeRecognizerUpdate (MBBarcodeRecognizer *barcodeRecognizer, MBBarcodeRecognizerSettings const *barcodeRecognizerSettings)
	Updates the MBBarcodeRecognizer 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	barcodeRecognizerResult (MBBarcodeRecognizerResult *result, MBBarcodeRecognizer const *barcodeRecognizer)
	Obtains the result from the given MBBarcodeRecognizer object. More...
MB_API MBRecognizerErrorStatus MB_CALL	barcodeRecognizerDelete (MBBarcodeRecognizer **barcodeRecognizer)
	Destroys the given MBBarcodeRecognizer. More...

Detailed Description

A recognizer that can scan barcodes.

Member Function Documentation

barcodeRecognizerCreate()

MB_API MBRecognizerErrorStatus MB_CALL barcodeRecognizerCreate	(	MBBarcodeRecognizer **	barcodeRecognizer,
		MBBarcodeRecognizerSettings const *	barcodeRecognizerSettings
	)

Allocates and initializes new MBBarcodeRecognizer object.

Parameters

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

barcodeRecognizerDelete()

MB_API MBRecognizerErrorStatus MB_CALL barcodeRecognizerDelete

(

MBBarcodeRecognizer **

barcodeRecognizer

)

Destroys the given MBBarcodeRecognizer.

Parameters

barcodeRecognizer

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

Returns

status of the operation

barcodeRecognizerResult()

MB_API MBRecognizerErrorStatus MB_CALL barcodeRecognizerResult	(	MBBarcodeRecognizerResult *	result,
		MBBarcodeRecognizer const *	barcodeRecognizer
	)

Obtains the result from the given MBBarcodeRecognizer object.

Parameters

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

Returns

status of the operation.

barcodeRecognizerUpdate()

MB_API MBRecognizerErrorStatus MB_CALL barcodeRecognizerUpdate	(	MBBarcodeRecognizer *	barcodeRecognizer,
		MBBarcodeRecognizerSettings const *	barcodeRecognizerSettings
	)

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

Parameters

barcodeRecognizer	MBBarcodeRecognizer that should be updated with new settings.
barcodeRecognizerSettings	Settings that will be used for updating the MBBarcodeRecognizer 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/BlinkBarcode/BarcodeRecognizer/BarcodeRecognizer.h