ScanbotSDKDocumentDataExtractorConfigurationTypes.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/DocumentDataExtractorConfigurationTypes.yaml
 
#pragma once
#ifndef SCANBOTSDK_DOCUMENTDATAEXTRACTORCONFIGURATIONTYPES_H
#define SCANBOTSDK_DOCUMENTDATAEXTRACTORCONFIGURATIONTYPES_H
 
 
#include <ScanbotSDKTypes.h>
#include <mrz/ScanbotSDKMrzTypes.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_document_data_extractor_configuration_element_t scanbotsdk_document_data_extractor_configuration_element_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_free(scanbotsdk_document_data_extractor_configuration_element_t* object);
 

typedef struct scanbotsdk_date_validation_configuration_t scanbotsdk_date_validation_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_create(
    int min_year,
    int max_year,
    scanbotsdk_u8string_ref_t field_type_name,
    scanbotsdk_date_validation_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_create_with_defaults(
    scanbotsdk_u8string_ref_t field_type_name,
    scanbotsdk_date_validation_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_free(scanbotsdk_date_validation_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_date_validation_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_date_validation_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, scanbotsdk_date_validation_configuration_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_as_scanbotsdk_document_data_extractor_configuration_element(scanbotsdk_date_validation_configuration_t* object, scanbotsdk_document_data_extractor_configuration_element_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_get_min_year(scanbotsdk_date_validation_configuration_t* self, int* min_year);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_set_min_year(scanbotsdk_date_validation_configuration_t* self, int min_year);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_get_max_year(scanbotsdk_date_validation_configuration_t* self, int* max_year);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_set_max_year(scanbotsdk_date_validation_configuration_t* self, int max_year);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_get_field_type_name(scanbotsdk_date_validation_configuration_t* self, scanbotsdk_u8string_ref_t* field_type_name);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_set_field_type_name(scanbotsdk_date_validation_configuration_t* self, scanbotsdk_u8string_ref_t field_type_name);
 

typedef struct scanbotsdk_de_address_parser_configuration_t scanbotsdk_de_address_parser_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_create(
    scanbotsdk_u8string_ref_t* document_types,
    size_t document_types_size,
    scanbotsdk_u8string_ref_t binary_file_address_database,
    scanbotsdk_de_address_parser_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_create_with_defaults(
    scanbotsdk_u8string_ref_t* document_types,
    size_t document_types_size,
    scanbotsdk_de_address_parser_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_free(scanbotsdk_de_address_parser_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_de_address_parser_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_de_address_parser_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, scanbotsdk_de_address_parser_configuration_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_as_scanbotsdk_document_data_extractor_configuration_element(scanbotsdk_de_address_parser_configuration_t* object, scanbotsdk_document_data_extractor_configuration_element_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_get_document_types(scanbotsdk_de_address_parser_configuration_t* self, scanbotsdk_u8string_ref_t* document_types, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_get_document_types_size(scanbotsdk_de_address_parser_configuration_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_set_document_types(scanbotsdk_de_address_parser_configuration_t* self, scanbotsdk_u8string_ref_t* document_types, size_t document_types_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_get_binary_file_address_database(scanbotsdk_de_address_parser_configuration_t* self, scanbotsdk_u8string_ref_t* binary_file_address_database);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_set_binary_file_address_database(scanbotsdk_de_address_parser_configuration_t* self, scanbotsdk_u8string_ref_t binary_file_address_database);
 

typedef enum scanbotsdk_european_health_insurance_card_issuing_country_t {

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_AUSTRIA = 0,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_BELGIUM = 1,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_BULGARIA = 2,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_CROATIA = 3,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_CYPRUS = 4,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_CZECH_REPUBLIC = 5,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_DENMARK = 6,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_ESTONIA = 7,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_FINLAND = 8,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_FRANCE = 9,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_GERMANY = 10,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_GREECE = 11,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_HUNGARY = 12,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_IRELAND = 13,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_ITALY = 14,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_LATVIA = 15,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_LITHUANIA = 16,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_LUXEMBOURG = 17,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_MALTA = 18,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_NETHERLANDS = 19,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_POLAND = 20,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_PORTUGAL = 21,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_ROMANIA = 22,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SLOVAKIA = 23,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SLOVENIA = 24,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SPAIN = 25,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SWEDEN = 26,

    SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SWITZERLAND = 27,
 
} scanbotsdk_european_health_insurance_card_issuing_country_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_issuing_country_t_to_string(scanbotsdk_european_health_insurance_card_issuing_country_t value, const char** result);

typedef struct scanbotsdk_european_health_insurance_card_configuration_t scanbotsdk_european_health_insurance_card_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_configuration_create(
    scanbotsdk_european_health_insurance_card_issuing_country_t* expected_country,
    scanbotsdk_european_health_insurance_card_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_configuration_create_with_defaults(
    scanbotsdk_european_health_insurance_card_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_configuration_free(scanbotsdk_european_health_insurance_card_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_european_health_insurance_card_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_european_health_insurance_card_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, scanbotsdk_european_health_insurance_card_configuration_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_configuration_as_scanbotsdk_document_data_extractor_configuration_element(scanbotsdk_european_health_insurance_card_configuration_t* object, scanbotsdk_document_data_extractor_configuration_element_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_configuration_get_expected_country(scanbotsdk_european_health_insurance_card_configuration_t* self, scanbotsdk_european_health_insurance_card_issuing_country_t** expected_country);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_configuration_set_expected_country(scanbotsdk_european_health_insurance_card_configuration_t* self, scanbotsdk_european_health_insurance_card_issuing_country_t* expected_country);
 

typedef struct scanbotsdk_mrz_fallback_configuration_t scanbotsdk_mrz_fallback_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_create(
    scanbotsdk_u8string_ref_t* accepted_countries,
    size_t accepted_countries_size,
    scanbotsdk_mrz_document_type_t* accepted_mrz_types,
    size_t accepted_mrz_types_size,
    scanbotsdk_mrz_fallback_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_create_with_defaults(
    scanbotsdk_mrz_fallback_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_free(scanbotsdk_mrz_fallback_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_mrz_fallback_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_mrz_fallback_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, scanbotsdk_mrz_fallback_configuration_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_as_scanbotsdk_document_data_extractor_configuration_element(scanbotsdk_mrz_fallback_configuration_t* object, scanbotsdk_document_data_extractor_configuration_element_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_get_accepted_countries(scanbotsdk_mrz_fallback_configuration_t* self, scanbotsdk_u8string_ref_t* accepted_countries, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_get_accepted_countries_size(scanbotsdk_mrz_fallback_configuration_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_set_accepted_countries(scanbotsdk_mrz_fallback_configuration_t* self, scanbotsdk_u8string_ref_t* accepted_countries, size_t accepted_countries_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_get_accepted_mrz_types(scanbotsdk_mrz_fallback_configuration_t* self, scanbotsdk_mrz_document_type_t** accepted_mrz_types);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_get_accepted_mrz_types_size(scanbotsdk_mrz_fallback_configuration_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_set_accepted_mrz_types(scanbotsdk_mrz_fallback_configuration_t* self, scanbotsdk_mrz_document_type_t* accepted_mrz_types, size_t accepted_mrz_types_size);
 

typedef struct scanbotsdk_auto_focus_configuration_t scanbotsdk_auto_focus_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_auto_focus_configuration_create(
    double sensitivity_threshold,
    scanbotsdk_auto_focus_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_auto_focus_configuration_create_with_defaults(
    scanbotsdk_auto_focus_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_auto_focus_configuration_free(scanbotsdk_auto_focus_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_auto_focus_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_auto_focus_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, scanbotsdk_auto_focus_configuration_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_auto_focus_configuration_as_scanbotsdk_document_data_extractor_configuration_element(scanbotsdk_auto_focus_configuration_t* object, scanbotsdk_document_data_extractor_configuration_element_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_auto_focus_configuration_get_sensitivity_threshold(scanbotsdk_auto_focus_configuration_t* self, double* sensitivity_threshold);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_auto_focus_configuration_set_sensitivity_threshold(scanbotsdk_auto_focus_configuration_t* self, double sensitivity_threshold);
 

typedef struct scanbotsdk_glare_detection_configuration_t scanbotsdk_glare_detection_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_glare_detection_configuration_create(
    double glare_detection_threshold,
    scanbotsdk_glare_detection_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_glare_detection_configuration_create_with_defaults(
    scanbotsdk_glare_detection_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_glare_detection_configuration_free(scanbotsdk_glare_detection_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_glare_detection_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_glare_detection_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, scanbotsdk_glare_detection_configuration_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_glare_detection_configuration_as_scanbotsdk_document_data_extractor_configuration_element(scanbotsdk_glare_detection_configuration_t* object, scanbotsdk_document_data_extractor_configuration_element_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_glare_detection_configuration_get_glare_detection_threshold(scanbotsdk_glare_detection_configuration_t* self, double* glare_detection_threshold);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_glare_detection_configuration_set_glare_detection_threshold(scanbotsdk_glare_detection_configuration_t* self, double glare_detection_threshold);
 

typedef struct scanbotsdk_document_data_extractor_common_configuration_t scanbotsdk_document_data_extractor_common_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_create(
    scanbotsdk_u8string_ref_t* accepted_document_types,
    size_t accepted_document_types_size,
    scanbotsdk_document_data_extractor_common_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_create_with_defaults(
    scanbotsdk_document_data_extractor_common_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_free(scanbotsdk_document_data_extractor_common_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_document_data_extractor_common_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_document_data_extractor_common_configuration(scanbotsdk_document_data_extractor_configuration_element_t* object, scanbotsdk_document_data_extractor_common_configuration_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_as_scanbotsdk_document_data_extractor_configuration_element(scanbotsdk_document_data_extractor_common_configuration_t* object, scanbotsdk_document_data_extractor_configuration_element_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_get_accepted_document_types(scanbotsdk_document_data_extractor_common_configuration_t* self, scanbotsdk_u8string_ref_t* accepted_document_types, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_get_accepted_document_types_size(scanbotsdk_document_data_extractor_common_configuration_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_set_accepted_document_types(scanbotsdk_document_data_extractor_common_configuration_t* self, scanbotsdk_u8string_ref_t* accepted_document_types, size_t accepted_document_types_size);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_DOCUMENTDATAEXTRACTORCONFIGURATIONTYPES_H */