ScanbotSDKVinScannerTypes.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/VINScannerTypes.yaml
 
#pragma once
#ifndef SCANBOTSDK_VINSCANNERTYPES_H
#define SCANBOTSDK_VINSCANNERTYPES_H
 
 
#include <ScanbotSDKTypes.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <string.h>
#include <text_pattern/ScanbotSDKTextPatternScannerTypes.h>
#include <ScanbotSDKErrorCode.h>
#include <ScanbotSDKDefs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 

typedef enum scanbotsdk_vin_barcode_extraction_status_t {

    SCANBOTSDK_VIN_BARCODE_EXTRACTION_STATUS_SUCCESS = 0,

    SCANBOTSDK_VIN_BARCODE_EXTRACTION_STATUS_BARCODE_WITHOUT_VIN = 1,

    SCANBOTSDK_VIN_BARCODE_EXTRACTION_STATUS_NO_BARCODE_FOUND = 2,

    SCANBOTSDK_VIN_BARCODE_EXTRACTION_STATUS_BARCODE_EXTRACTION_DISABLED = 3,
 
} scanbotsdk_vin_barcode_extraction_status_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_barcode_extraction_status_t_to_string(scanbotsdk_vin_barcode_extraction_status_t value, const char** result);

typedef struct scanbotsdk_vin_barcode_result_t scanbotsdk_vin_barcode_result_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_barcode_result_free(scanbotsdk_vin_barcode_result_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_barcode_result_get_extracted_vin(scanbotsdk_vin_barcode_result_t* self, scanbotsdk_u8string_ref_t* extracted_vin);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_barcode_result_get_rectangle(scanbotsdk_vin_barcode_result_t* self, scanbotsdk_point_t** rectangle);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_barcode_result_get_rectangle_size(scanbotsdk_vin_barcode_result_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_barcode_result_get_status(scanbotsdk_vin_barcode_result_t* self, scanbotsdk_vin_barcode_extraction_status_t* status);
 

typedef struct scanbotsdk_vin_scanner_result_t scanbotsdk_vin_scanner_result_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_result_free(scanbotsdk_vin_scanner_result_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_result_get_text_result(scanbotsdk_vin_scanner_result_t* self, scanbotsdk_text_pattern_scanner_result_t** text_result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_result_get_barcode_result(scanbotsdk_vin_scanner_result_t* self, scanbotsdk_vin_barcode_result_t** barcode_result);
 

typedef struct scanbotsdk_vin_scanner_configuration_t scanbotsdk_vin_scanner_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_create(
    int input_height_limit,
    bool optimize_single_line,
    bool extract_vin_from_barcode,
    int ocr_resolution_limit,
    int maximum_number_of_accumulated_frames,
    int minimum_number_of_required_frames_with_equal_scanning_result,
    scanbotsdk_vin_scanner_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_create_with_defaults(
    scanbotsdk_vin_scanner_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_free(scanbotsdk_vin_scanner_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_get_input_height_limit(scanbotsdk_vin_scanner_configuration_t* self, int* input_height_limit);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_set_input_height_limit(scanbotsdk_vin_scanner_configuration_t* self, int input_height_limit);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_get_optimize_single_line(scanbotsdk_vin_scanner_configuration_t* self, bool* optimize_single_line);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_set_optimize_single_line(scanbotsdk_vin_scanner_configuration_t* self, bool optimize_single_line);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_get_extract_vin_from_barcode(scanbotsdk_vin_scanner_configuration_t* self, bool* extract_vin_from_barcode);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_set_extract_vin_from_barcode(scanbotsdk_vin_scanner_configuration_t* self, bool extract_vin_from_barcode);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_get_ocr_resolution_limit(scanbotsdk_vin_scanner_configuration_t* self, int* ocr_resolution_limit);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_set_ocr_resolution_limit(scanbotsdk_vin_scanner_configuration_t* self, int ocr_resolution_limit);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_get_maximum_number_of_accumulated_frames(scanbotsdk_vin_scanner_configuration_t* self, int* maximum_number_of_accumulated_frames);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_set_maximum_number_of_accumulated_frames(scanbotsdk_vin_scanner_configuration_t* self, int maximum_number_of_accumulated_frames);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_get_minimum_number_of_required_frames_with_equal_scanning_result(scanbotsdk_vin_scanner_configuration_t* self, int* minimum_number_of_required_frames_with_equal_scanning_result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_set_minimum_number_of_required_frames_with_equal_scanning_result(scanbotsdk_vin_scanner_configuration_t* self, int minimum_number_of_required_frames_with_equal_scanning_result);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_VINSCANNERTYPES_H */