ScanbotSDKMrzTypes.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/MRZTypes.yaml
 
#pragma once
#ifndef SCANBOTSDK_MRZTYPES_H
#define SCANBOTSDK_MRZTYPES_H
 
 
#include <ScanbotSDKTypes.h>
#include <common/ScanbotSDKCommonTypes.h>
#include <frame_accumulation/ScanbotSDKFrameAccumulationTypes.h>
#include <generic_document/ScanbotSDKGenericDocument.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 enum scanbotsdk_mrz_document_type_t {

    SCANBOTSDK_MRZ_DOCUMENT_TYPE_UNKNOWN = 0,

    SCANBOTSDK_MRZ_DOCUMENT_TYPE_CREW_MEMBER_CERTIFICATE = 1,

    SCANBOTSDK_MRZ_DOCUMENT_TYPE_ID_CARD = 2,

    SCANBOTSDK_MRZ_DOCUMENT_TYPE_PASSPORT = 3,

    SCANBOTSDK_MRZ_DOCUMENT_TYPE_VISA = 4,

    SCANBOTSDK_MRZ_DOCUMENT_TYPE_CH_DRIVING_LICENSE = 5,
 
} scanbotsdk_mrz_document_type_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_document_type_t_to_string(scanbotsdk_mrz_document_type_t value, const char** result);

typedef struct scanbotsdk_mrz_scanner_result_t scanbotsdk_mrz_scanner_result_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_result_free(scanbotsdk_mrz_scanner_result_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_result_get_success(scanbotsdk_mrz_scanner_result_t* self, bool* success);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_result_get_raw_mrz(scanbotsdk_mrz_scanner_result_t* self, scanbotsdk_u8string_ref_t* raw_mrz);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_result_get_document(scanbotsdk_mrz_scanner_result_t* self, scanbotsdk_generic_document_t** document);
 

typedef enum scanbotsdk_mrz_incomplete_result_handling_t {

    SCANBOTSDK_MRZ_INCOMPLETE_RESULT_HANDLING_ACCEPT = 0,

    SCANBOTSDK_MRZ_INCOMPLETE_RESULT_HANDLING_REJECT = 1,
 
} scanbotsdk_mrz_incomplete_result_handling_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_incomplete_result_handling_t_to_string(scanbotsdk_mrz_incomplete_result_handling_t value, const char** result);

typedef struct scanbotsdk_mrz_scanner_configuration_t scanbotsdk_mrz_scanner_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_configuration_create(
    scanbotsdk_accumulated_results_verifier_configuration_t* frame_accumulation_configuration,
    bool enable_detection,
    scanbotsdk_mrz_incomplete_result_handling_t incomplete_result_handling,
    bool return_crops,
    scanbotsdk_processing_mode_t processing_mode,
    scanbotsdk_mrz_scanner_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_configuration_create_with_defaults(
    scanbotsdk_mrz_scanner_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_configuration_free(scanbotsdk_mrz_scanner_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_configuration_get_frame_accumulation_configuration(scanbotsdk_mrz_scanner_configuration_t* self, scanbotsdk_accumulated_results_verifier_configuration_t** frame_accumulation_configuration);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_configuration_set_frame_accumulation_configuration(scanbotsdk_mrz_scanner_configuration_t* self, scanbotsdk_accumulated_results_verifier_configuration_t* frame_accumulation_configuration);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_configuration_get_enable_detection(scanbotsdk_mrz_scanner_configuration_t* self, bool* enable_detection);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_configuration_set_enable_detection(scanbotsdk_mrz_scanner_configuration_t* self, bool enable_detection);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_configuration_get_incomplete_result_handling(scanbotsdk_mrz_scanner_configuration_t* self, scanbotsdk_mrz_incomplete_result_handling_t* incomplete_result_handling);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_configuration_set_incomplete_result_handling(scanbotsdk_mrz_scanner_configuration_t* self, scanbotsdk_mrz_incomplete_result_handling_t incomplete_result_handling);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_configuration_get_return_crops(scanbotsdk_mrz_scanner_configuration_t* self, bool* return_crops);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_configuration_set_return_crops(scanbotsdk_mrz_scanner_configuration_t* self, bool return_crops);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_configuration_get_processing_mode(scanbotsdk_mrz_scanner_configuration_t* self, scanbotsdk_processing_mode_t* processing_mode);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_scanner_configuration_set_processing_mode(scanbotsdk_mrz_scanner_configuration_t* self, scanbotsdk_processing_mode_t processing_mode);
 

typedef struct scanbotsdk_mrz_parser_configuration_t scanbotsdk_mrz_parser_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_parser_configuration_create(
    scanbotsdk_mrz_incomplete_result_handling_t incomplete_result_handling,
    scanbotsdk_mrz_parser_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_parser_configuration_create_with_defaults(
    scanbotsdk_mrz_parser_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_parser_configuration_free(scanbotsdk_mrz_parser_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_parser_configuration_get_incomplete_result_handling(scanbotsdk_mrz_parser_configuration_t* self, scanbotsdk_mrz_incomplete_result_handling_t* incomplete_result_handling);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_parser_configuration_set_incomplete_result_handling(scanbotsdk_mrz_parser_configuration_t* self, scanbotsdk_mrz_incomplete_result_handling_t incomplete_result_handling);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_MRZTYPES_H */