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 #if defined(__cplusplus)
20 extern "C" {
21 #endif
22 
37 typedef struct ScOpaqueBarcodeScanner ScBarcodeScanner;
40 
54 SC_EXPORT
55 ScBarcodeScanner *sc_barcode_scanner_new_with_settings(ScRecognitionContext *context,
56  ScBarcodeScannerSettings const *settings);
57 
66 SC_EXPORT
67 void sc_barcode_scanner_retain(ScBarcodeScanner *scanner);
68 
79 SC_EXPORT
80 void sc_barcode_scanner_release(ScBarcodeScanner *scanner);
81 
97 SC_EXPORT
98 ScBarcodeScannerSession *sc_barcode_scanner_get_session(ScBarcodeScanner *scanner);
99 
109 SC_EXPORT
110 void sc_barcode_scanner_apply_settings(ScBarcodeScanner *scanner,
111  ScBarcodeScannerSettings const *settings);
112 
123 SC_EXPORT
124 ScBool sc_barcode_scanner_is_setup_complete(ScBarcodeScanner const *scanner);
125 
136 SC_EXPORT
137 ScBool sc_barcode_scanner_wait_for_setup_completed(ScBarcodeScanner *scanner);
138 
139 #if defined(__cplusplus)
140 }
141 #endif
142 
143 #endif // SC_BARCODE_SCANNER_H_
ScRecognitionContext
Opaque recognition context data structure.
ScBarcodeScanner::sc_barcode_scanner_new_with_settings
ScBarcodeScanner * sc_barcode_scanner_new_with_settings(ScRecognitionContext *context, ScBarcodeScannerSettings const *settings)
Create a new barcode scanner instance with the given settings.
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.
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
ScBarcodeScanner::sc_barcode_scanner_apply_settings
void sc_barcode_scanner_apply_settings(ScBarcodeScanner *scanner, ScBarcodeScannerSettings const *settings)
Apply new settings.
ScBarcodeScannerSession.h
Barcode Scanner Session.
ScBarcodeScanner::sc_barcode_scanner_get_session
ScBarcodeScannerSession * sc_barcode_scanner_get_session(ScBarcodeScanner *scanner)
Get the current scanning session.
ScBarcodeScanner::sc_barcode_scanner_retain
void sc_barcode_scanner_retain(ScBarcodeScanner *scanner)
Increase reference count of barcode scanner object by one.
ScConfig.h
Common definitions used throughout the ScanditSDK API.
ScBarcodeScanner::sc_barcode_scanner_release
void sc_barcode_scanner_release(ScBarcodeScanner *scanner)
Decrease reference count of barcode scanner by one.
ScBarcodeScanner
Scans barcodes in images.
ScBarcodeScanner::sc_barcode_scanner_wait_for_setup_completed
ScBool sc_barcode_scanner_wait_for_setup_completed(ScBarcodeScanner *scanner)
Block execution until the barcode scanner has completed setup.
ScBool
int32_t ScBool
Boolean value, can be SC_TRUE or SC_FALSE.
Definition: ScConfig.h:127
Copyright (C) 2024 Scandit AG