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

ScBarcodeGenerator.h
Go to the documentation of this file.
1 
10 #ifndef SC_BARCODE_GENERATOR_H_
11 #define SC_BARCODE_GENERATOR_H_
12 
13 #include <stdlib.h>
14 #include <Scandit/ScEncodingArray.h>
15 #include <Scandit/ScConfig.h>
16 #include <Scandit/ScCommon.h>
17 #include <Scandit/ScBarcode.h>
18 #include <Scandit/ScRecognitionContext.h>
19 
20 #if defined(__cplusplus)
21 extern "C" {
22 #endif
23 
34 typedef struct ScOpaqueBarcodeGenerator ScBarcodeGenerator;
37 
55 SC_EXPORT ScBarcodeGenerator*
56 sc_barcode_generator_new(const ScRecognitionContext *context, ScSymbology symbology, ScError *out_error);
57 
73 SC_EXPORT ScBarcodeGenerator*
74 sc_barcode_generator_new_with_options(const ScRecognitionContext *context,
75  ScSymbology symbology,
76  const char* json_options,
77  ScError *out_error);
78 
91 SC_EXPORT void
92 sc_barcode_generator_set_options(ScBarcodeGenerator *generator,
93  const char* json_options,
94  ScError *out_error);
95 
103 SC_EXPORT void
104 sc_barcode_generator_free(ScBarcodeGenerator *generator);
105 
121 SC_EXPORT ScImageBuffer *
122 sc_barcode_generator_generate(const ScBarcodeGenerator * generator,
123  const uint8_t* data, size_t data_length,
124  const ScEncodingArray encoding,
125  ScError *out_error);
126 
127 #if defined(__cplusplus)
128 }
129 #endif
130 
131 #endif // SC_BARCODE_GENERATOR_H_
ScRecognitionContext
Opaque recognition context data structure.
sc_barcode_generator_free
void sc_barcode_generator_free(ScBarcodeGenerator *generator)
Free a previously instantiated barcode generator. May be null.
sc_barcode_generator_new
ScBarcodeGenerator * sc_barcode_generator_new(const ScRecognitionContext *context, ScSymbology symbology, ScError *out_error)
Create a new barcode generator instance for the given symbology.
sc_barcode_generator_new_with_options
ScBarcodeGenerator * sc_barcode_generator_new_with_options(const ScRecognitionContext *context, ScSymbology symbology, const char *json_options, ScError *out_error)
Create a new barcode generator instance for the given symbology and options.
ScRecognitionContext.h
Recognition context interface.
ScBarcode.h
Functions for retrieving barcode information.
sc_barcode_generator_set_options
void sc_barcode_generator_set_options(ScBarcodeGenerator *generator, const char *json_options, ScError *out_error)
sets the options on a given barcode generator
ScImageBuffer
A 2-dimensional bitmap/image.
Definition: ScCommon.h:292
ScBarcodeGenerator
A 1d/2d barcode generator.
ScSymbology
ScSymbology
Enumeration of all supported 1d and 2d barcode symbologies.
Definition: ScBarcode.h:29
ScError
Structure for holding error information.
Definition: ScCommon.h:226
ScConfig.h
Common definitions used throughout the ScanditSDK API.
ScCommon.h
Common functions and data structures.
ScEncodingArray
An array of encoding ranges.
Definition: ScEncodingArray.h:88
sc_barcode_generator_generate
ScImageBuffer * sc_barcode_generator_generate(const ScBarcodeGenerator *generator, const uint8_t *data, size_t data_length, const ScEncodingArray encoding, ScError *out_error)
Generates a n image containing a barcode encoding the provided data.
ScEncodingArray.h
Functions to manage an array of encoding ranges.
Copyright (C) 2018 Scandit AG