ScBarcode.h
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 
18 #if defined(__cplusplus)
19 extern "C" {
20 #endif
21 
29 typedef enum {
33  SC_SYMBOLOGY_UNKNOWN = 0x0000000,
37  SC_SYMBOLOGY_EAN13 = 0x0000001,
41  SC_SYMBOLOGY_EAN8 = 0x0000002,
45  SC_SYMBOLOGY_UPCA = 0x0000004,
49  SC_SYMBOLOGY_UPCE = 0x0000008,
53  SC_SYMBOLOGY_CODE128 = 0x0000010,
57  SC_SYMBOLOGY_CODE39 = 0x0000020,
61  SC_SYMBOLOGY_CODE93 = 0x0000040,
69  SC_SYMBOLOGY_QR = 0x0000100,
77  SC_SYMBOLOGY_PDF417 = 0x0000400,
93  SC_SYMBOLOGY_CODABAR = 0x0004000,
97  SC_SYMBOLOGY_AZTEC = 0x0008000,
104 
118  SC_SYMBOLOGY_CODE11 = 0x0080000,
128  SC_SYMBOLOGY_CODE25 = 0x0200000,
133 
137  SC_SYMBOLOGY_RM4SCC = 0x0800000,
138 
142  SC_SYMBOLOGY_KIX = 0x1000000
143 } ScSymbology;
144 
152 typedef enum {
181 
187 SC_EXPORT
189 
193 SC_EXPORT
195 
196 
205 SC_EXPORT const char* sc_symbology_to_string(ScSymbology symbology);
206 
207 
219 typedef struct ScOpaqueBarcode ScBarcode;
222 
243 SC_EXPORT ScByteArray
244 sc_barcode_get_data(const ScBarcode *barcode);
245 
263 SC_EXPORT ScEncodingArray
265 
266 
275 SC_EXPORT void sc_barcode_retain(ScBarcode *barcode);
276 
287 SC_EXPORT void sc_barcode_release(ScBarcode *barcode);
288 
289 
301 SC_EXPORT ScSymbology sc_barcode_get_symbology(const ScBarcode *barcode);
302 
317 SC_EXPORT ScBool sc_barcode_is_gs1_data_carrier(const ScBarcode *barcode);
318 
331 
343 SC_EXPORT ScBool sc_barcode_is_recognized(const ScBarcode *barcode);
344 
360 SC_EXPORT ScQuadrilateral sc_barcode_get_location(const ScBarcode *barcode);
361 
372 SC_EXPORT uint32_t sc_barcode_get_frame_id(const ScBarcode *barcode);
373 
384 SC_EXPORT int32_t sc_barcode_get_symbol_count(const ScBarcode *barcode);
385 
386 #if defined(__cplusplus)
387 }
388 #endif
389 
390 
391 #endif //SC_BARCODE_H_
392 
393 
Definition: ScBarcode.h:118
Definition: ScBarcode.h:37
Functions to manage an array of bytes.
Definition: ScBarcode.h:175
A located or recognized barcode/ 2d code in an image.
Definition: ScBarcode.h:53
Definition: ScBarcode.h:171
SC_EXTERN const uint16_t SC_ALL_SYMBOLOGIES_COUNT
The number of elements in the SC_ALL_SYMBOLOGIES array.
Definition: ScBarcode.h:194
ScCompositeFlag sc_barcode_get_composite_flag(const ScBarcode *barcode)
Flag to hint whether the barcode is part of a composite code.
Definition: ScBarcode.h:167
Definition: ScBarcode.h:142
ScSymbology sc_barcode_get_symbology(const ScBarcode *barcode)
Get the symbology of the barcode.
Definition: ScBarcode.h:179
Definition: ScBarcode.h:85
Definition: ScBarcode.h:162
void sc_barcode_retain(ScBarcode *barcode)
Increase reference count of barcode object by one.
Definition: ScBarcode.h:103
Definition: ScBarcode.h:57
Definition: ScBarcode.h:45
Definition: ScBarcode.h:156
Definition: ScBarcode.h:69
Definition: ScBarcode.h:33
Definition: ScBarcode.h:41
ScQuadrilateral sc_barcode_get_location(const ScBarcode *barcode)
Get the location of a recognized or located barcode.
Definition: ScBarcode.h:97
A 2-dimensional polygon with 4 corners.
Definition: ScCommon.h:63
Definition: ScBarcode.h:61
ScCompositeFlag
Flags to hint that two codes form a composite code.
Definition: ScBarcode.h:152
ScBool sc_barcode_is_gs1_data_carrier(const ScBarcode *barcode)
Check whether the barcode is a "GS1" code.
Definition: ScBarcode.h:122
SC_EXTERN const ScSymbology SC_ALL_SYMBOLOGIES[]
Array holding all symbologies supported by the scandit barcode scanner.
Definition: ScBarcode.h:188
Definition: ScBarcode.h:110
ScSymbology
Enumeration of all supported 1d and 2d barcode symbologies.
Definition: ScBarcode.h:29
Definition: ScBarcode.h:65
Definition: ScBarcode.h:93
uint32_t sc_barcode_get_frame_id(const ScBarcode *barcode)
Get the frame ID a barcode was found in.
Definition: ScBarcode.h:73
void sc_barcode_release(ScBarcode *barcode)
Decrease reference count of barcode object by one.
Definition: ScBarcode.h:49
#define SC_EXTERN
Use this for defining external symbols.
Definition: ScConfig.h:17
ScBool sc_barcode_is_recognized(const ScBarcode *barcode)
Check whether the barcode was fully decoded (recognized).
Common definitions used throughout the ScanditSDK API.
Common functions and data structures.
An array of encoding ranges.
Definition: ScEncodingArray.h:42
Definition: ScBarcode.h:137
const char * sc_symbology_to_string(ScSymbology symbology)
Helper function convert the symbology enum to a string.
Definition: ScBarcode.h:77
Definition: ScBarcode.h:89
Definition: ScBarcode.h:81
Functions to manage an array of encoding ranges.
A nul terminated array of bytes.
Definition: ScByteArray.h:31
Definition: ScBarcode.h:114
Definition: ScBarcode.h:132
Definition: ScBarcode.h:128
ScByteArray sc_barcode_get_data(const ScBarcode *barcode)
Get the data encoded in the barcode.
int32_t ScBool
Boolean value, can be SC_TRUE or SC_FALSE.
Definition: ScConfig.h:123
ScEncodingArray sc_barcode_get_data_encoding(const ScBarcode *barcode)
Get the data encodings.
int32_t sc_barcode_get_symbol_count(const ScBarcode *barcode)
Get the symbol count of the barcode.