Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Android

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,
117  SC_SYMBOLOGY_CODE11 = 0x0080000,
127  SC_SYMBOLOGY_CODE25 = 0x0200000,
132 
136  SC_SYMBOLOGY_RM4SCC = 0x0800000,
140  SC_SYMBOLOGY_KIX = 0x1000000,
144  SC_SYMBOLOGY_DOTCODE = 0x2000000,
152  SC_SYMBOLOGY_CODE32 = 0x8000000,
156  SC_SYMBOLOGY_LAPA4SC = 0x10000000,
161 
162 } ScSymbology;
163 
171 typedef enum {
198  SC_COMPOSITE_FLAG_GS1_C = 0x0000010
200 
206 SC_EXPORT
207 SC_EXTERN const ScSymbology SC_ALL_SYMBOLOGIES[];
208 
212 SC_EXPORT
213 SC_EXTERN const uint16_t SC_ALL_SYMBOLOGIES_COUNT;
214 
215 
224 SC_EXPORT const char* sc_symbology_to_string(ScSymbology symbology);
225 
226 
235 SC_EXPORT ScSymbology sc_symbology_from_string(const char *symbology_string);
236 
237 
249 typedef struct ScOpaqueBarcode ScBarcode;
252 
273 SC_EXPORT ScByteArray
275 
293 SC_EXPORT ScEncodingArray
295 
296 
305 SC_EXPORT void sc_barcode_retain(ScBarcode *barcode);
306 
317 SC_EXPORT void sc_barcode_release(ScBarcode *barcode);
318 
319 
332 
348 
361 
373 SC_EXPORT ScBool sc_barcode_is_recognized(const ScBarcode *barcode);
374 
391 
402 SC_EXPORT uint32_t sc_barcode_get_frame_id(const ScBarcode *barcode);
403 
414 SC_EXPORT int32_t sc_barcode_get_symbol_count(const ScBarcode *barcode);
415 
427 
428 #if defined(__cplusplus)
429 }
430 #endif
431 
432 
433 #endif //SC_BARCODE_H_
434 
435 
@ SC_SYMBOLOGY_CODE39
Definition: ScBarcode.h:57
@ SC_COMPOSITE_FLAG_GS1_B
Definition: ScBarcode.h:194
ScQuadrilateral sc_barcode_get_location(const ScBarcode *barcode)
Get the location of a recognized or located barcode.
@ SC_SYMBOLOGY_FIVE_DIGIT_ADD_ON
Definition: ScBarcode.h:109
ScByteArray sc_barcode_get_data(const ScBarcode *barcode)
Get the data encoded in the barcode.
@ SC_SYMBOLOGY_DOTCODE
Definition: ScBarcode.h:144
@ SC_COMPOSITE_FLAG_UNKNOWN
Definition: ScBarcode.h:181
@ SC_SYMBOLOGY_MAXICODE
Definition: ScBarcode.h:113
@ SC_SYMBOLOGY_PDF417
Definition: ScBarcode.h:77
@ SC_SYMBOLOGY_EAN8
Definition: ScBarcode.h:41
ScCompositeFlag
Flags to hint that two codes form a composite code.
Definition: ScBarcode.h:171
@ SC_SYMBOLOGY_UPCA
Definition: ScBarcode.h:45
ScBool sc_barcode_is_recognized(const ScBarcode *barcode)
Check whether the barcode was fully decoded (recognized).
@ SC_COMPOSITE_FLAG_NONE
Definition: ScBarcode.h:175
@ SC_SYMBOLOGY_RM4SCC
Definition: ScBarcode.h:136
@ SC_COMPOSITE_FLAG_LINKED
Definition: ScBarcode.h:186
ScBool sc_barcode_is_color_inverted(const ScBarcode *barcode)
Get the color of the barcode.
ScBool sc_barcode_is_gs1_data_carrier(const ScBarcode *barcode)
Check whether the barcode is a "GS1" code.
@ SC_SYMBOLOGY_QR
Definition: ScBarcode.h:69
@ SC_SYMBOLOGY_TWO_DIGIT_ADD_ON
Definition: ScBarcode.h:103
@ SC_SYMBOLOGY_LAPA4SC
Definition: ScBarcode.h:156
@ SC_SYMBOLOGY_UPCE
Definition: ScBarcode.h:49
A 2-dimensional polygon with 4 corners.
Definition: ScCommon.h:65
Common functions and data structures.
void sc_barcode_retain(ScBarcode *barcode)
Increase reference count of barcode object by one.
@ SC_SYMBOLOGY_IATA_2_OF_5
Definition: ScBarcode.h:160
@ SC_SYMBOLOGY_CODE93
Definition: ScBarcode.h:61
@ SC_SYMBOLOGY_CODE25
Definition: ScBarcode.h:127
SC_EXTERN const uint16_t SC_ALL_SYMBOLOGIES_COUNT
The number of elements in the SC_ALL_SYMBOLOGIES array.
Definition: ScBarcode.h:213
Common definitions used throughout the ScanditSDK API.
@ SC_SYMBOLOGY_AZTEC
Definition: ScBarcode.h:97
Functions to manage an array of encoding ranges.
@ SC_SYMBOLOGY_MICRO_PDF417
Definition: ScBarcode.h:131
An array of encoding ranges.
Definition: ScEncodingArray.h:88
@ SC_SYMBOLOGY_KIX
Definition: ScBarcode.h:140
int32_t sc_barcode_get_symbol_count(const ScBarcode *barcode)
Get the symbol count of the barcode.
SC_EXTERN const ScSymbology SC_ALL_SYMBOLOGIES[]
Array holding all symbologies supported by the scandit barcode scanner.
Definition: ScBarcode.h:207
@ SC_SYMBOLOGY_EAN13
Definition: ScBarcode.h:37
ScEncodingArray sc_barcode_get_data_encoding(const ScBarcode *barcode)
Get the data encodings.
ScSymbology sc_symbology_from_string(const char *symbology_string)
Helper function to convert a symbology string to its corresponding symbology enum.
@ SC_SYMBOLOGY_CODABAR
Definition: ScBarcode.h:93
@ SC_SYMBOLOGY_MSI_PLESSEY
Definition: ScBarcode.h:81
@ SC_SYMBOLOGY_CODE32
Definition: ScBarcode.h:152
int32_t ScBool
Boolean value, can be SC_TRUE or SC_FALSE.
Definition: ScConfig.h:127
const char * sc_symbology_to_string(ScSymbology symbology)
Helper function to convert the symbology enum to a string.
void sc_barcode_release(ScBarcode *barcode)
Decrease reference count of barcode object by one.
@ SC_SYMBOLOGY_INTERLEAVED_2_OF_5
Definition: ScBarcode.h:65
@ SC_SYMBOLOGY_MICRO_QR
Definition: ScBarcode.h:148
uint32_t sc_barcode_get_frame_id(const ScBarcode *barcode)
Get the frame ID a barcode was found in.
ScSymbology
Enumeration of all supported 1d and 2d barcode symbologies.
Definition: ScBarcode.h:29
@ SC_SYMBOLOGY_UNKNOWN
Definition: ScBarcode.h:33
@ SC_SYMBOLOGY_DATA_MATRIX
Definition: ScBarcode.h:73
ScCompositeFlag sc_barcode_get_composite_flag(const ScBarcode *barcode)
Flag to hint whether the barcode is part of a composite code.
@ SC_SYMBOLOGY_GS1_DATABAR_LIMITED
Definition: ScBarcode.h:121
@ SC_SYMBOLOGY_GS1_DATABAR
Definition: ScBarcode.h:85
A located or recognized barcode/ 2d code in an image.
@ SC_SYMBOLOGY_CODE11
Definition: ScBarcode.h:117
A null terminated array of bytes.
@ SC_COMPOSITE_FLAG_GS1_C
Definition: ScBarcode.h:198
@ SC_COMPOSITE_FLAG_GS1_A
Definition: ScBarcode.h:190
ScSymbology sc_barcode_get_symbology(const ScBarcode *barcode)
Get the symbology of the barcode.
@ SC_SYMBOLOGY_CODE128
Definition: ScBarcode.h:53
Functions to manage an array of bytes.
@ SC_SYMBOLOGY_GS1_DATABAR_EXPANDED
Definition: ScBarcode.h:89