ScanbotSDKBarcodeScannerTypes.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/BarcodeScannerTypes.yaml
 
#pragma once
#ifndef SCANBOTSDK_BARCODESCANNERTYPES_H
#define SCANBOTSDK_BARCODESCANNERTYPES_H
 
 
#include <ScanbotSDKImage.h>
#include <ScanbotSDKTypes.h>
#include <barcode/ScanbotSDKBarcodeConfigurationTypes.h>
#include <barcode/ScanbotSDKBarcodeDocumentTypes.h>
#include <barcode/ScanbotSDKBarcodeTypes.h>
#include <common/ScanbotSDKCommonTypes.h>
#include <generic_document/ScanbotSDKGenericDocument.h>
#include <ml/ScanbotSDKAcceleratorTypes.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <string.h>
#include <ScanbotSDKErrorCode.h>
#include <ScanbotSDKDefs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 

typedef struct scanbotsdk_barcode_item_t scanbotsdk_barcode_item_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_free(scanbotsdk_barcode_item_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_format(scanbotsdk_barcode_item_t* self, scanbotsdk_barcode_format_t* format);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_text(scanbotsdk_barcode_item_t* self, const char** text);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_raw_bytes(scanbotsdk_barcode_item_t* self, uint8_t** raw_bytes);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_raw_bytes_size(scanbotsdk_barcode_item_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_raw_bytes_encodings(scanbotsdk_barcode_item_t* self, scanbotsdk_range_encoding_t** raw_bytes_encodings, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_raw_bytes_encodings_size(scanbotsdk_barcode_item_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_structured_append_info(scanbotsdk_barcode_item_t* self, scanbotsdk_structured_append_info_t** structured_append_info);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_quad(scanbotsdk_barcode_item_t* self, scanbotsdk_point_t** quad);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_quad_size(scanbotsdk_barcode_item_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_quad_normalized(scanbotsdk_barcode_item_t* self, scanbotsdk_pointf_t** quad_normalized);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_quad_normalized_size(scanbotsdk_barcode_item_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_extended_quad(scanbotsdk_barcode_item_t* self, scanbotsdk_point_t** extended_quad);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_extended_quad_size(scanbotsdk_barcode_item_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_extended_quad_normalized(scanbotsdk_barcode_item_t* self, scanbotsdk_pointf_t** extended_quad_normalized);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_extended_quad_normalized_size(scanbotsdk_barcode_item_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_is_upside_down(scanbotsdk_barcode_item_t* self, bool* is_upside_down);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_source_image(scanbotsdk_barcode_item_t* self, scanbotsdk_image_t** source_image);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_upc_ean_extension(scanbotsdk_barcode_item_t* self, const char** upc_ean_extension);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_is_gs_1_message(scanbotsdk_barcode_item_t* self, bool* is_gs_1_message);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_is_gs_1_composite_part(scanbotsdk_barcode_item_t* self, bool* is_gs_1_composite_part);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_data_bar_stack_size(scanbotsdk_barcode_item_t* self, int* data_bar_stack_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_size_score(scanbotsdk_barcode_item_t* self, double* size_score);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_extracted_document(scanbotsdk_barcode_item_t* self, scanbotsdk_generic_document_t** extracted_document);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_global_index(scanbotsdk_barcode_item_t* self, int* global_index);
 

typedef enum scanbotsdk_barcode_scanner_engine_mode_t {

    SCANBOTSDK_BARCODE_SCANNER_ENGINE_MODE_LEGACY = 0,

    SCANBOTSDK_BARCODE_SCANNER_ENGINE_MODE_NEXT_GEN_LOW_POWER = 1,

    SCANBOTSDK_BARCODE_SCANNER_ENGINE_MODE_NEXT_GEN = 2,

    SCANBOTSDK_BARCODE_SCANNER_ENGINE_MODE_NEXT_GEN_LOW_POWER_FAR_DISTANCE = 3,

    SCANBOTSDK_BARCODE_SCANNER_ENGINE_MODE_NEXT_GEN_FAR_DISTANCE = 4,

    SCANBOTSDK_BARCODE_SCANNER_ENGINE_MODE_NEXT_GEN_MAX_DISTANCE = 5,
 
} scanbotsdk_barcode_scanner_engine_mode_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_engine_mode_t_to_string(scanbotsdk_barcode_scanner_engine_mode_t value, const char** result);

typedef enum scanbotsdk_barcode_accumulation_method_t {

    SCANBOTSDK_BARCODE_ACCUMULATION_METHOD_LAST_VISIBLE = 0,

    SCANBOTSDK_BARCODE_ACCUMULATION_METHOD_INTERPOLATE_BY_CAMERA = 1,
 
} scanbotsdk_barcode_accumulation_method_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_method_t_to_string(scanbotsdk_barcode_accumulation_method_t value, const char** result);

typedef struct scanbotsdk_barcode_accumulation_configuration_t scanbotsdk_barcode_accumulation_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_create(
    int accumulation_time,
    bool remove_unconnected_results,
    scanbotsdk_barcode_accumulation_method_t method,
    scanbotsdk_barcode_accumulation_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_create_with_defaults(
    scanbotsdk_barcode_accumulation_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_free(scanbotsdk_barcode_accumulation_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_get_accumulation_time(scanbotsdk_barcode_accumulation_configuration_t* self, int* accumulation_time);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_set_accumulation_time(scanbotsdk_barcode_accumulation_configuration_t* self, int accumulation_time);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_get_remove_unconnected_results(scanbotsdk_barcode_accumulation_configuration_t* self, bool* remove_unconnected_results);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_set_remove_unconnected_results(scanbotsdk_barcode_accumulation_configuration_t* self, bool remove_unconnected_results);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_get_method(scanbotsdk_barcode_accumulation_configuration_t* self, scanbotsdk_barcode_accumulation_method_t* method);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_set_method(scanbotsdk_barcode_accumulation_configuration_t* self, scanbotsdk_barcode_accumulation_method_t method);
 

typedef struct scanbotsdk_barcode_scanner_configuration_t scanbotsdk_barcode_scanner_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_create(
    scanbotsdk_barcode_format_configuration_base_t** barcode_format_configurations,
    size_t barcode_format_configurations_size,
    scanbotsdk_barcode_document_format_t* extracted_document_formats,
    size_t extracted_document_formats_size,
    bool only_accept_documents,
    bool return_barcode_image,
    scanbotsdk_accelerator_t* accelerator,
    scanbotsdk_barcode_scanner_engine_mode_t engine_mode,
    scanbotsdk_barcode_accumulation_configuration_t* accumulation_config,
    bool optimized_for_overlays,
    scanbotsdk_processing_mode_t processing_mode,
    scanbotsdk_barcode_scanner_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_create_with_defaults(
    scanbotsdk_barcode_scanner_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_free(scanbotsdk_barcode_scanner_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_barcode_format_configurations(scanbotsdk_barcode_scanner_configuration_t* self, scanbotsdk_barcode_format_configuration_base_t** barcode_format_configurations, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_barcode_format_configurations_size(scanbotsdk_barcode_scanner_configuration_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_barcode_format_configurations(scanbotsdk_barcode_scanner_configuration_t* self, scanbotsdk_barcode_format_configuration_base_t** barcode_format_configurations, size_t barcode_format_configurations_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_extracted_document_formats(scanbotsdk_barcode_scanner_configuration_t* self, scanbotsdk_barcode_document_format_t** extracted_document_formats);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_extracted_document_formats_size(scanbotsdk_barcode_scanner_configuration_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_extracted_document_formats(scanbotsdk_barcode_scanner_configuration_t* self, scanbotsdk_barcode_document_format_t* extracted_document_formats, size_t extracted_document_formats_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_only_accept_documents(scanbotsdk_barcode_scanner_configuration_t* self, bool* only_accept_documents);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_only_accept_documents(scanbotsdk_barcode_scanner_configuration_t* self, bool only_accept_documents);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_return_barcode_image(scanbotsdk_barcode_scanner_configuration_t* self, bool* return_barcode_image);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_return_barcode_image(scanbotsdk_barcode_scanner_configuration_t* self, bool return_barcode_image);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_accelerator(scanbotsdk_barcode_scanner_configuration_t* self, scanbotsdk_accelerator_t** accelerator);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_accelerator(scanbotsdk_barcode_scanner_configuration_t* self, scanbotsdk_accelerator_t* accelerator);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_engine_mode(scanbotsdk_barcode_scanner_configuration_t* self, scanbotsdk_barcode_scanner_engine_mode_t* engine_mode);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_engine_mode(scanbotsdk_barcode_scanner_configuration_t* self, scanbotsdk_barcode_scanner_engine_mode_t engine_mode);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_accumulation_config(scanbotsdk_barcode_scanner_configuration_t* self, scanbotsdk_barcode_accumulation_configuration_t** accumulation_config);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_accumulation_config(scanbotsdk_barcode_scanner_configuration_t* self, scanbotsdk_barcode_accumulation_configuration_t* accumulation_config);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_optimized_for_overlays(scanbotsdk_barcode_scanner_configuration_t* self, bool* optimized_for_overlays);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_optimized_for_overlays(scanbotsdk_barcode_scanner_configuration_t* self, bool optimized_for_overlays);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_processing_mode(scanbotsdk_barcode_scanner_configuration_t* self, scanbotsdk_processing_mode_t* processing_mode);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_processing_mode(scanbotsdk_barcode_scanner_configuration_t* self, scanbotsdk_processing_mode_t processing_mode);
 

typedef struct scanbotsdk_barcode_scanner_result_t scanbotsdk_barcode_scanner_result_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_result_free(scanbotsdk_barcode_scanner_result_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_result_get_barcodes(scanbotsdk_barcode_scanner_result_t* self, scanbotsdk_barcode_item_t** barcodes, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_result_get_barcodes_size(scanbotsdk_barcode_scanner_result_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_result_get_success(scanbotsdk_barcode_scanner_result_t* self, bool* success);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_BARCODESCANNERTYPES_H */