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,
157 
158 
159 } ScSymbology;
160 
168 typedef enum {
197 
203 SC_EXPORT
204 SC_EXTERN const ScSymbology SC_ALL_SYMBOLOGIES[];
205 
209 SC_EXPORT
210 SC_EXTERN const uint16_t SC_ALL_SYMBOLOGIES_COUNT;
211 
212 
221 SC_EXPORT const char* sc_symbology_to_string(ScSymbology symbology);
222 
223 
232 SC_EXPORT ScSymbology sc_symbology_from_string(const char *symbology_string);
233 
234 
246 typedef struct ScOpaqueBarcode ScBarcode;
249 
270 SC_EXPORT ScByteArray
271 sc_barcode_get_data(const ScBarcode *barcode);
272 
290 SC_EXPORT ScEncodingArray
292 
293 
302 SC_EXPORT void sc_barcode_retain(ScBarcode *barcode);
303 
314 SC_EXPORT void sc_barcode_release(ScBarcode *barcode);
315 
316 
328 SC_EXPORT ScSymbology sc_barcode_get_symbology(const ScBarcode *barcode);
329 
344 SC_EXPORT ScBool sc_barcode_is_gs1_data_carrier(const ScBarcode *barcode);
345 
358 
370 SC_EXPORT ScBool sc_barcode_is_recognized(const ScBarcode *barcode);
371 
387 SC_EXPORT ScQuadrilateral sc_barcode_get_location(const ScBarcode *barcode);
388 
399 SC_EXPORT uint32_t sc_barcode_get_frame_id(const ScBarcode *barcode);
400 
411 SC_EXPORT int32_t sc_barcode_get_symbol_count(const ScBarcode *barcode);
412 
423 SC_EXPORT ScBool sc_barcode_is_color_inverted(const ScBarcode *barcode);
424 
425 #if defined(__cplusplus)
426 }
427 #endif
428 
429 
430 #endif //SC_BARCODE_H_
431 
432 
Definition: ScBarcode.h:117
Definition: ScBarcode.h:37
Functions to manage an array of bytes.
Definition: ScBarcode.h:191
A located or recognized barcode/ 2d code in an image.
Definition: ScBarcode.h:53
Definition: ScBarcode.h:187
SC_EXTERN const uint16_t SC_ALL_SYMBOLOGIES_COUNT
The number of elements in the SC_ALL_SYMBOLOGIES array.
Definition: ScBarcode.h:210
ScCompositeFlag sc_barcode_get_composite_flag(const ScBarcode *barcode)
Flag to hint whether the barcode is part of a composite code.
Definition: ScBarcode.h:183
Definition: ScBarcode.h:140
ScSymbology sc_barcode_get_symbology(const ScBarcode *barcode)
Get the symbology of the barcode.
Definition: ScBarcode.h:195
Definition: ScBarcode.h:156
Definition: ScBarcode.h:85
Definition: ScBarcode.h:178
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:172
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:65
Definition: ScBarcode.h:61
ScCompositeFlag
Flags to hint that two codes form a composite code.
Definition: ScBarcode.h:168
ScBool sc_barcode_is_gs1_data_carrier(const ScBarcode *barcode)
Check whether the barcode is a "GS1" code.
Definition: ScBarcode.h:121
SC_EXTERN const ScSymbology SC_ALL_SYMBOLOGIES[]
Array holding all symbologies supported by the scandit barcode scanner.
Definition: ScBarcode.h:204
Definition: ScBarcode.h:109
ScSymbology
Enumeration of all supported 1d and 2d barcode symbologies.
Definition: ScBarcode.h:29
ScBool sc_barcode_is_color_inverted(const ScBarcode *barcode)
Get the color of the barcode.
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
ScSymbology sc_symbology_from_string(const char *symbology_string)
Helper function to convert a symbology string to its corresponding symbology enum.
void sc_barcode_release(ScBarcode *barcode)
Decrease reference count of barcode object by one.
Definition: ScBarcode.h:49
Definition: ScBarcode.h:144
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:88
Definition: ScBarcode.h:148
Definition: ScBarcode.h:136
Definition: ScBarcode.h:152
const char * sc_symbology_to_string(ScSymbology symbology)
Helper function to 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 null terminated array of bytes.
Definition: ScBarcode.h:113
Definition: ScBarcode.h:131
Definition: ScBarcode.h:127
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:127
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.