ScBarcodeScanner.h
Go to the documentation of this file.
1 
11 #ifndef SC_BARCODE_SCANNER_H_
12 #define SC_BARCODE_SCANNER_H_
13 
14 #include <Scandit/ScConfig.h>
15 #include <Scandit/ScRecognitionContext.h>
16 #include <Scandit/ScBarcodeScannerSettings.h>
17 #include <Scandit/ScBarcodeScannerSession.h>
18 
19 SC_EXTERN_C_BEGIN
20 
35 typedef struct ScOpaqueBarcodeScanner ScBarcodeScanner;
38 
52 SC_EXPORT
53 ScBarcodeScanner *sc_barcode_scanner_new(ScRecognitionContext *context);
54 
63 SC_EXPORT
64 void sc_barcode_scanner_retain(ScBarcodeScanner const *scanner);
65 
76 SC_EXPORT
77 void sc_barcode_scanner_release(ScBarcodeScanner const *scanner);
78 
94 SC_EXPORT
95 ScBarcodeScannerSession *sc_barcode_scanner_get_session(ScBarcodeScanner *scanner);
96 
108 SC_EXPORT
109 ScContextStatus sc_barcode_scanner_apply_settings(ScBarcodeScanner *scanner,
110  ScBarcodeScannerSettings const *settings);
111 
122 SC_EXPORT
123 ScBool sc_barcode_scanner_is_setup_complete(ScBarcodeScanner const *scanner);
124 
135 SC_EXPORT
136 ScBool sc_barcode_scanner_wait_for_setup_completed(ScBarcodeScanner const *scanner);
137 
138 SC_EXTERN_C_END
139 
140 #endif // SC_BARCODE_SCANNER_H_
ScRecognitionContext
Opaque recognition context data structure.
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_retain
void sc_barcode_scanner_retain(ScBarcodeScanner const *scanner)
Increase reference count of barcode scanner object by one.
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_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.
ScRecognitionContext.h
Recognition context interface.
ScBarcodeScannerSettings
An opaque data structure holding configuration options for the barcode scanner.
ScBarcodeScannerSettings.h
barcode scanner configuration
SC_EXTERN_C_BEGIN
#define SC_EXTERN_C_BEGIN
Start of external C code.
Definition: ScConfig.h:19
ScBarcodeScannerSession.h
Barcode Scanner Session.
ScBarcodeScanner::sc_barcode_scanner_apply_settings
ScContextStatus sc_barcode_scanner_apply_settings(ScBarcodeScanner *scanner, ScBarcodeScannerSettings const *settings)
Apply new settings.
ScBarcodeScanner::sc_barcode_scanner_get_session
ScBarcodeScannerSession * sc_barcode_scanner_get_session(ScBarcodeScanner *scanner)
Get the current scanning session.
SC_EXTERN_C_END
#define SC_EXTERN_C_END
End of external C code.
Definition: ScConfig.h:28
ScContextStatus
Status information with error message details.
Definition: ScRecognitionContext.h:255
ScConfig.h
Common definitions used throughout the ScanditSDK API.
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.
ScBool
int32_t ScBool
Boolean value, can be SC_TRUE or SC_FALSE.
Definition: ScConfig.h:167
Copyright (C) 2025 Scandit AG