ScBarcode.h
Go to the documentation of this file.
Definition: ScBarcode.h:117
Definition: ScBarcode.h:37
Functions to manage an array of bytes.
Definition: ScBarcode.h:202
A located or recognized barcode/ 2d code in an image.
Definition: ScBarcode.h:53
Definition: ScBarcode.h:198
SC_EXTERN const uint16_t SC_ALL_SYMBOLOGIES_COUNT
The number of elements in the SC_ALL_SYMBOLOGIES array.
Definition: ScBarcode.h:221
ScCompositeFlag sc_barcode_get_composite_flag(const ScBarcode *barcode)
Flag to hint whether the barcode is part of a composite code.
Definition: ScBarcode.h:194
Definition: ScBarcode.h:140
ScSymbology sc_barcode_get_symbology(const ScBarcode *barcode)
Get the symbology of the barcode.
Definition: ScBarcode.h:206
Definition: ScBarcode.h:156
Definition: ScBarcode.h:85
Definition: ScBarcode.h:189
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:183
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
Definition: ScBarcode.h:61
ScCompositeFlag
Flags to hint that two codes form a composite code.
Definition: ScBarcode.h:179
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:215
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:160
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.
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:168
Definition: ScBarcode.h:77
Definition: ScBarcode.h:89
Definition: ScBarcode.h:164
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.
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.