stable/c_api/_sc_barcode_generator_8h_source.html

#ifndef SC_BARCODE_GENERATOR_H_

#define SC_BARCODE_GENERATOR_H_


#include <stdlib.h>

#include <Scandit/ScEncodingArray.h>

#include <Scandit/ScConfig.h>

#include <Scandit/ScCommon.h>

#include <Scandit/ScBarcode.h>

#include <Scandit/ScRecognitionContext.h>


SC_EXTERN_C_BEGIN


typedef struct ScOpaqueBarcodeGenerator ScBarcodeGenerator;


SC_EXPORT

ScBarcodeGenerator *sc_barcode_generator_new(ScRecognitionContext const *context,

                                             ScSymbology symbology,

                                             ScError *out_error);


SC_EXPORT

ScBarcodeGenerator *sc_barcode_generator_new_with_options(ScRecognitionContext const *context,

                                                          ScSymbology symbology,

                                                          char const *json_options,

                                                          ScError *out_error);


SC_EXPORT

void sc_barcode_generator_set_options(ScBarcodeGenerator *generator,

                                      char const *json_options,

                                      ScError *out_error);


SC_EXPORT

void sc_barcode_generator_free(ScBarcodeGenerator *generator);


SC_EXPORT

ScImageBuffer *sc_barcode_generator_generate(ScBarcodeGenerator const *generator,

                                             uint8_t const *data,

                                             size_t data_length,

                                             ScEncodingArray const encoding,

                                             ScError *out_error);


SC_EXTERN_C_END


#endif // SC_BARCODE_GENERATOR_H_

ScBarcode.h
Functions for retrieving barcode information.

ScSymbology
ScSymbology
Enumeration of all supported 1d and 2d barcode symbologies.
Definition: ScBarcode.h:27

ScCommon.h
Common functions and data structures.

ScError
Structure for holding error information.
Definition: ScCommon.h:264

ScConfig.h
Common definitions used throughout the ScanditSDK API.

SC_EXTERN_C_BEGIN
#define SC_EXTERN_C_BEGIN
Start of external C code.
Definition: ScConfig.h:19

SC_EXTERN_C_END
#define SC_EXTERN_C_END
End of external C code.
Definition: ScConfig.h:28

ScEncodingArray.h
Functions to manage an array of encoding ranges.

ScRecognitionContext.h
Recognition context interface.

ScBarcodeGenerator
A 1d/2d barcode generator.

ScBarcodeGenerator::sc_barcode_generator_generate
ScImageBuffer * sc_barcode_generator_generate(ScBarcodeGenerator const *generator, uint8_t const *data, size_t data_length, ScEncodingArray const encoding, ScError *out_error)
Generates an image containing a barcode encoding the provided data.

ScBarcodeGenerator::sc_barcode_generator_set_options
void sc_barcode_generator_set_options(ScBarcodeGenerator *generator, char const *json_options, ScError *out_error)
sets the options on a given barcode generator

ScBarcodeGenerator::sc_barcode_generator_new_with_options
ScBarcodeGenerator * sc_barcode_generator_new_with_options(ScRecognitionContext const *context, ScSymbology symbology, char const *json_options, ScError *out_error)
Create a new barcode generator instance for the given symbology and options.

ScBarcodeGenerator::sc_barcode_generator_new
ScBarcodeGenerator * sc_barcode_generator_new(ScRecognitionContext const *context, ScSymbology symbology, ScError *out_error)
Create a new barcode generator instance for the given symbology.

ScBarcodeGenerator::sc_barcode_generator_free
void sc_barcode_generator_free(ScBarcodeGenerator *generator)
Free a previously instantiated barcode generator. May be null.

ScEncodingArray
An array of encoding ranges.
Definition: ScEncodingArray.h:68

ScImageBuffer
A 2-dimensional bitmap/image.
Definition: ScCommon.h:332

ScRecognitionContext
Opaque recognition context data structure.