Go to the documentation of this file.
1 
10 #ifndef SC_BARCODE_H_
11 #define SC_BARCODE_H_
12 
13 #include <Scandit/ScByteArray.h>
15 #include <Scandit/ScConfig.h>
16 #include <Scandit/ScCommon.h>
17 
19 
27 typedef enum {
128 
189 } ScSymbology;
190 
198 typedef enum {
227 
233 SC_EXPORT
234 SC_EXTERN
236 
240 SC_EXPORT
241 SC_EXTERN
243 
252 SC_EXPORT
253 char const *sc_symbology_to_string(ScSymbology symbology);
254 
263 SC_EXPORT
264 ScSymbology sc_symbology_from_string(char const *symbology_string);
265 
277 typedef struct ScOpaqueBarcode ScBarcode;
280 
301 SC_EXPORT
303 
321 SC_EXPORT
323 
332 SC_EXPORT
333 void sc_barcode_retain(ScBarcode *barcode);
334 
345 SC_EXPORT
346 void sc_barcode_release(ScBarcode *barcode);
347 
359 SC_EXPORT
361 
376 SC_EXPORT
378 
390 SC_EXPORT
392 
404 SC_EXPORT
406 
422 SC_EXPORT
424 
435 SC_EXPORT
436 uint32_t sc_barcode_get_frame_id(ScBarcode const *barcode);
437 
448 SC_EXPORT
449 int32_t sc_barcode_get_symbol_count(ScBarcode const *barcode);
450 
461 SC_EXPORT
463 
465 
466 #endif // SC_BARCODE_H_
ScEncodingArray sc_barcode_get_data_encoding(ScBarcode const *barcode)
Get the data encodings.
Definition: ScBarcode.h:113
Functions to manage an array of bytes.
Definition: ScBarcode.h:221
A located or recognized barcode/ 2d code in an image.
Definition: ScBarcode.h:49
Definition: ScBarcode.h:217
char const * sc_symbology_to_string(ScSymbology symbology)
Helper function to convert the symbology enum to a string.
Definition: ScBarcode.h:213
Definition: ScBarcode.h:136
int32_t sc_barcode_get_symbol_count(ScBarcode const *barcode)
Get the symbol count of the barcode.
Definition: ScBarcode.h:225
Definition: ScBarcode.h:152
Definition: ScBarcode.h:81
SC_EXTERN ScSymbology const SC_ALL_SYMBOLOGIES[]
Array holding all symbologies supported by the scandit barcode scanner.
Definition: ScBarcode.h:235
Definition: ScBarcode.h:208
ScByteArray sc_barcode_get_data(ScBarcode const *barcode)
Get the data encoded in the barcode.
void sc_barcode_retain(ScBarcode *barcode)
Increase reference count of barcode object by one.
Definition: ScBarcode.h:99
Definition: ScBarcode.h:53
uint32_t sc_barcode_get_frame_id(ScBarcode const *barcode)
Get the frame ID a barcode was found in.
Definition: ScBarcode.h:202
SC_EXTERN uint16_t const SC_ALL_SYMBOLOGIES_COUNT
The number of elements in the SC_ALL_SYMBOLOGIES array.
Definition: ScBarcode.h:242
Definition: ScBarcode.h:65
Definition: ScBarcode.h:31
Definition: ScBarcode.h:41
Definition: ScBarcode.h:93
Definition: ScBarcode.h:170
A 2-dimensional polygon with 4 corners.
Definition: ScCommon.h:61
Definition: ScBarcode.h:57
ScBool sc_barcode_is_recognized(ScBarcode const *barcode)
Check whether the barcode was fully decoded (recognized).
ScSymbology sc_barcode_get_symbology(ScBarcode const *barcode)
Get the symbology of the barcode.
ScCompositeFlag
Flags to hint that two codes form a composite code.
Definition: ScBarcode.h:198
Definition: ScBarcode.h:176
ScQuadrilateral sc_barcode_get_location(ScBarcode const *barcode)
Get the location of a recognized or located barcode.
Definition: ScBarcode.h:117
#define SC_EXTERN_C_BEGIN
Start of external C code.
Definition: ScConfig.h:19
ScBool sc_barcode_is_gs1_data_carrier(ScBarcode const *barcode)
Check whether the barcode is a "GS1" code.
Definition: ScBarcode.h:105
ScSymbology
Enumeration of all supported 1d and 2d barcode symbologies.
Definition: ScBarcode.h:27
Definition: ScBarcode.h:61
Definition: ScBarcode.h:156
ScCompositeFlag sc_barcode_get_composite_flag(ScBarcode const *barcode)
Flag to hint whether the barcode is part of a composite code.
ScSymbology sc_symbology_from_string(char const *symbology_string)
Helper function to convert a symbology string to its corresponding symbology enum.
Definition: ScBarcode.h:89
Definition: ScBarcode.h:37
Definition: ScBarcode.h:69
#define SC_EXTERN_C_END
End of external C code.
Definition: ScConfig.h:28
void sc_barcode_release(ScBarcode *barcode)
Decrease reference count of barcode object by one.
Definition: ScBarcode.h:45
Definition: ScBarcode.h:140
Common definitions used throughout the ScanditSDK API.
Definition: ScBarcode.h:188
Common functions and data structures.
An array of encoding ranges.
Definition: ScEncodingArray.h:68
Definition: ScBarcode.h:144
Definition: ScBarcode.h:132
Definition: ScBarcode.h:182
Definition: ScBarcode.h:148
Definition: ScBarcode.h:164
Definition: ScBarcode.h:73
Definition: ScBarcode.h:85
Definition: ScBarcode.h:160
Definition: ScBarcode.h:77
Functions to manage an array of encoding ranges.
A null terminated array of bytes.
Definition: ScBarcode.h:109
Definition: ScBarcode.h:127
Definition: ScBarcode.h:123
ScBool sc_barcode_is_color_inverted(ScBarcode const *barcode)
Get the color of the barcode.
int32_t ScBool
Boolean value, can be SC_TRUE or SC_FALSE.
Definition: ScConfig.h:158