stable/c_api/_sc_barcode_scanner_8h_source.html

#ifndef SC_BARCODE_SCANNER_H_

#define SC_BARCODE_SCANNER_H_


#include <Scandit/ScConfig.h>

#include <Scandit/ScRecognitionContext.h>

#include <Scandit/ScBarcodeScannerSettings.h>

#include <Scandit/ScBarcodeScannerSession.h>


SC_EXTERN_C_BEGIN


typedef struct ScOpaqueBarcodeScanner ScBarcodeScanner;


SC_EXPORT

ScBarcodeScanner *sc_barcode_scanner_new(ScRecognitionContext *context);


SC_EXPORT

void sc_barcode_scanner_retain(ScBarcodeScanner const *scanner);


SC_EXPORT

void sc_barcode_scanner_release(ScBarcodeScanner const *scanner);


SC_EXPORT

ScBarcodeScannerSession *sc_barcode_scanner_get_session(ScBarcodeScanner *scanner);


SC_EXPORT

ScContextStatus sc_barcode_scanner_apply_settings(ScBarcodeScanner *scanner,

                                                  ScBarcodeScannerSettings const *settings);


SC_EXPORT

ScBool sc_barcode_scanner_is_setup_complete(ScBarcodeScanner const *scanner);


SC_EXPORT

ScBool sc_barcode_scanner_wait_for_setup_completed(ScBarcodeScanner const *scanner);


SC_EXTERN_C_END


#endif // SC_BARCODE_SCANNER_H_

ScBarcodeScannerSession.h
Barcode Scanner Session.

ScBarcodeScannerSettings.h
barcode scanner configuration

ScConfig.h
Common definitions used throughout the ScanditSDK API.

SC_EXTERN_C_BEGIN
#define SC_EXTERN_C_BEGIN
Start of external C code.
Definition: ScConfig.h:19

SC_EXTERN_C_END
#define SC_EXTERN_C_END
End of external C code.
Definition: ScConfig.h:28

ScBool
int32_t ScBool
Boolean value, can be SC_TRUE or SC_FALSE.
Definition: ScConfig.h:167

ScRecognitionContext.h
Recognition context interface.

ScContextStatus
Status information with error message details.
Definition: ScRecognitionContext.h:254

ScBarcodeScanner
Scans barcodes in images.

ScBarcodeScanner::sc_barcode_scanner_release
void sc_barcode_scanner_release(ScBarcodeScanner const *scanner)
Decrease reference count of barcode scanner by one.

ScBarcodeScanner::sc_barcode_scanner_get_session
ScBarcodeScannerSession * sc_barcode_scanner_get_session(ScBarcodeScanner *scanner)
Get the current scanning session.

ScBarcodeScanner::sc_barcode_scanner_is_setup_complete
ScBool sc_barcode_scanner_is_setup_complete(ScBarcodeScanner const *scanner)
Checks whether the barcode scanner has completed initialization.

ScBarcodeScanner::sc_barcode_scanner_new
ScBarcodeScanner * sc_barcode_scanner_new(ScRecognitionContext *context)
Create a new barcode scanner instance without any symbologies enabled. It has to be initialized with ...

ScBarcodeScanner::sc_barcode_scanner_apply_settings
ScContextStatus sc_barcode_scanner_apply_settings(ScBarcodeScanner *scanner, ScBarcodeScannerSettings const *settings)
Apply new settings.

ScBarcodeScanner::sc_barcode_scanner_retain
void sc_barcode_scanner_retain(ScBarcodeScanner const *scanner)
Increase reference count of barcode scanner object by one.

ScBarcodeScanner::sc_barcode_scanner_wait_for_setup_completed
ScBool sc_barcode_scanner_wait_for_setup_completed(ScBarcodeScanner const *scanner)
Block execution until the barcode scanner has completed setup.

ScBarcodeScannerSession
An opaque barcode scanner session object.

ScBarcodeScannerSettings
An opaque data structure holding configuration options for the barcode scanner.

ScRecognitionContext
Opaque recognition context data structure.