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 
191 } ScSymbology;
192 
200 typedef enum {
229 
235 SC_EXPORT
236 SC_EXTERN
238 
242 SC_EXPORT
243 SC_EXTERN
245 
254 SC_EXPORT
255 char const *sc_symbology_to_string(ScSymbology symbology);
256 
265 SC_EXPORT
266 ScSymbology sc_symbology_from_string(char const *symbology_string);
267 
279 typedef struct ScOpaqueBarcode ScBarcode;
282 
303 SC_EXPORT
305 
323 SC_EXPORT
325 
334 SC_EXPORT
335 void sc_barcode_retain(ScBarcode *barcode);
336 
347 SC_EXPORT
348 void sc_barcode_release(ScBarcode *barcode);
349 
361 SC_EXPORT
363 
378 SC_EXPORT
380 
392 SC_EXPORT
394 
406 SC_EXPORT
408 
424 SC_EXPORT
426 
437 SC_EXPORT
438 uint32_t sc_barcode_get_frame_id(ScBarcode const *barcode);
439 
450 SC_EXPORT
451 int32_t sc_barcode_get_symbol_count(ScBarcode const *barcode);
452 
463 SC_EXPORT
465 
467 
468 #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:223
A located or recognized barcode/ 2d code in an image.
Definition: ScBarcode.h:49
Definition: ScBarcode.h:219
char const * sc_symbology_to_string(ScSymbology symbology)
Helper function to convert the symbology enum to a string.
Definition: ScBarcode.h:215
Definition: ScBarcode.h:138
int32_t sc_barcode_get_symbol_count(ScBarcode const *barcode)
Get the symbol count of the barcode.
Definition: ScBarcode.h:227
Definition: ScBarcode.h:154
Definition: ScBarcode.h:81
SC_EXTERN ScSymbology const SC_ALL_SYMBOLOGIES[]
Array holding all symbologies supported by the scandit barcode scanner.
Definition: ScBarcode.h:237
Definition: ScBarcode.h:210
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:204
SC_EXTERN uint16_t const SC_ALL_SYMBOLOGIES_COUNT
The number of elements in the SC_ALL_SYMBOLOGIES array.
Definition: ScBarcode.h:244
Definition: ScBarcode.h:65
Definition: ScBarcode.h:31
Definition: ScBarcode.h:41
Definition: ScBarcode.h:93
Definition: ScBarcode.h:172
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:200
Definition: ScBarcode.h:178
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:158
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:142
Common definitions used throughout the ScanditSDK API.
Definition: ScBarcode.h:190
Common functions and data structures.
An array of encoding ranges.
Definition: ScEncodingArray.h:68
Definition: ScBarcode.h:146
Definition: ScBarcode.h:134
Definition: ScBarcode.h:184
Definition: ScBarcode.h:150
Definition: ScBarcode.h:166
Definition: ScBarcode.h:73
Definition: ScBarcode.h:85
Definition: ScBarcode.h:162
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