ScanbotSDKCheckScannerTypes.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/CheckScannerTypes.yaml
 
#pragma once
#ifndef SCANBOTSDK_CHECKSCANNERTYPES_H
#define SCANBOTSDK_CHECKSCANNERTYPES_H
 
 
#include <ScanbotSDKImage.h>
#include <common/ScanbotSDKCommonTypes.h>
#include <document_scanner/ScanbotSDKDocumentScannerTypes.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_check_document_detection_mode_t {

    SCANBOTSDK_CHECK_DOCUMENT_DETECTION_MODE_DISABLED = 0,

    SCANBOTSDK_CHECK_DOCUMENT_DETECTION_MODE_DETECT_DOCUMENT = 1,

    SCANBOTSDK_CHECK_DOCUMENT_DETECTION_MODE_DETECT_AND_CROP_DOCUMENT = 2,
 
} scanbotsdk_check_document_detection_mode_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_document_detection_mode_t_to_string(scanbotsdk_check_document_detection_mode_t value, const char** result);

typedef enum scanbotsdk_check_magnetic_ink_strip_scanning_status_t {

    SCANBOTSDK_CHECK_MAGNETIC_INK_STRIP_SCANNING_STATUS_SUCCESS = 0,

    SCANBOTSDK_CHECK_MAGNETIC_INK_STRIP_SCANNING_STATUS_SUCCESS_BUT_LOW_CONFIDENCE_RESULT = 1,

    SCANBOTSDK_CHECK_MAGNETIC_INK_STRIP_SCANNING_STATUS_SCANNING_IN_PROGRESS = 2,

    SCANBOTSDK_CHECK_MAGNETIC_INK_STRIP_SCANNING_STATUS_INCOMPLETE_VALIDATION = 3,

    SCANBOTSDK_CHECK_MAGNETIC_INK_STRIP_SCANNING_STATUS_ERROR_NOTHING_FOUND = 4,
 
} scanbotsdk_check_magnetic_ink_strip_scanning_status_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_magnetic_ink_strip_scanning_status_t_to_string(scanbotsdk_check_magnetic_ink_strip_scanning_status_t value, const char** result);

typedef struct scanbotsdk_check_scanning_result_t scanbotsdk_check_scanning_result_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanning_result_free(scanbotsdk_check_scanning_result_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanning_result_get_status(scanbotsdk_check_scanning_result_t* self, scanbotsdk_check_magnetic_ink_strip_scanning_status_t* status);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanning_result_get_check(scanbotsdk_check_scanning_result_t* self, scanbotsdk_generic_document_t** check);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanning_result_get_document_detection_result(scanbotsdk_check_scanning_result_t* self, scanbotsdk_document_detection_result_t** document_detection_result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanning_result_get_cropped_image(scanbotsdk_check_scanning_result_t* self, scanbotsdk_image_t** cropped_image);
 

typedef enum scanbotsdk_check_standard_t {

    SCANBOTSDK_CHECK_STANDARD_USA = 0,

    SCANBOTSDK_CHECK_STANDARD_FRA = 1,

    SCANBOTSDK_CHECK_STANDARD_KWT = 2,

    SCANBOTSDK_CHECK_STANDARD_AUS = 3,

    SCANBOTSDK_CHECK_STANDARD_IND = 4,

    SCANBOTSDK_CHECK_STANDARD_ISR = 5,

    SCANBOTSDK_CHECK_STANDARD_UAE = 6,

    SCANBOTSDK_CHECK_STANDARD_CAN = 7,
 
} scanbotsdk_check_standard_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_standard_t_to_string(scanbotsdk_check_standard_t value, const char** result);

typedef struct scanbotsdk_check_scanner_configuration_t scanbotsdk_check_scanner_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_configuration_create(
    scanbotsdk_check_document_detection_mode_t document_detection_mode,
    scanbotsdk_check_standard_t* accepted_check_standards,
    size_t accepted_check_standards_size,
    scanbotsdk_result_accumulation_configuration_t* result_accumulation_config,
    scanbotsdk_processing_mode_t processing_mode,
    scanbotsdk_check_scanner_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_configuration_create_with_defaults(
    scanbotsdk_check_scanner_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_configuration_free(scanbotsdk_check_scanner_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_configuration_get_document_detection_mode(scanbotsdk_check_scanner_configuration_t* self, scanbotsdk_check_document_detection_mode_t* document_detection_mode);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_configuration_set_document_detection_mode(scanbotsdk_check_scanner_configuration_t* self, scanbotsdk_check_document_detection_mode_t document_detection_mode);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_configuration_get_accepted_check_standards(scanbotsdk_check_scanner_configuration_t* self, scanbotsdk_check_standard_t** accepted_check_standards);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_configuration_get_accepted_check_standards_size(scanbotsdk_check_scanner_configuration_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_configuration_set_accepted_check_standards(scanbotsdk_check_scanner_configuration_t* self, scanbotsdk_check_standard_t* accepted_check_standards, size_t accepted_check_standards_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_configuration_get_result_accumulation_config(scanbotsdk_check_scanner_configuration_t* self, scanbotsdk_result_accumulation_configuration_t** result_accumulation_config);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_configuration_set_result_accumulation_config(scanbotsdk_check_scanner_configuration_t* self, scanbotsdk_result_accumulation_configuration_t* result_accumulation_config);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_configuration_get_processing_mode(scanbotsdk_check_scanner_configuration_t* self, scanbotsdk_processing_mode_t* processing_mode);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_check_scanner_configuration_set_processing_mode(scanbotsdk_check_scanner_configuration_t* self, scanbotsdk_processing_mode_t processing_mode);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_CHECKSCANNERTYPES_H */