ScanbotSDKTextPatternScannerTypes.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/TextPatternScannerTypes.yaml
 
#pragma once
#ifndef SCANBOTSDK_TEXTPATTERNSCANNERTYPES_H
#define SCANBOTSDK_TEXTPATTERNSCANNERTYPES_H
 
 
#include <ScanbotSDKTypes.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_pattern_grammar_t {

    SCANBOTSDK_PATTERN_GRAMMAR_WILDCARD = 0,

    SCANBOTSDK_PATTERN_GRAMMAR_REGEX = 1,
 
} scanbotsdk_pattern_grammar_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_grammar_t_to_string(scanbotsdk_pattern_grammar_t value, const char** result);

typedef struct scanbotsdk_word_box_t scanbotsdk_word_box_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_word_box_free(scanbotsdk_word_box_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_word_box_get_text(scanbotsdk_word_box_t* self, scanbotsdk_u8string_ref_t* text);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_word_box_get_bounding_rect(scanbotsdk_word_box_t* self, scanbotsdk_rect_t* bounding_rect);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_word_box_get_recognition_confidence(scanbotsdk_word_box_t* self, double* recognition_confidence);
 

typedef struct scanbotsdk_symbol_box_t scanbotsdk_symbol_box_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_symbol_box_free(scanbotsdk_symbol_box_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_symbol_box_get_symbol(scanbotsdk_symbol_box_t* self, scanbotsdk_u8string_ref_t* symbol);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_symbol_box_get_bounding_rect(scanbotsdk_symbol_box_t* self, scanbotsdk_rect_t* bounding_rect);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_symbol_box_get_recognition_confidence(scanbotsdk_symbol_box_t* self, double* recognition_confidence);
 

typedef struct scanbotsdk_text_pattern_scanner_result_t scanbotsdk_text_pattern_scanner_result_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_result_free(scanbotsdk_text_pattern_scanner_result_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_result_get_raw_text(scanbotsdk_text_pattern_scanner_result_t* self, scanbotsdk_u8string_ref_t* raw_text);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_result_get_word_boxes(scanbotsdk_text_pattern_scanner_result_t* self, scanbotsdk_word_box_t** word_boxes, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_result_get_word_boxes_size(scanbotsdk_text_pattern_scanner_result_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_result_get_symbol_boxes(scanbotsdk_text_pattern_scanner_result_t* self, scanbotsdk_symbol_box_t** symbol_boxes, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_result_get_symbol_boxes_size(scanbotsdk_text_pattern_scanner_result_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_result_get_confidence(scanbotsdk_text_pattern_scanner_result_t* self, double* confidence);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_result_get_validation_successful(scanbotsdk_text_pattern_scanner_result_t* self, bool* validation_successful);
 

typedef struct scanbotsdk_content_validator_t scanbotsdk_content_validator_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_content_validator_free(scanbotsdk_content_validator_t* object);
 

typedef struct scanbotsdk_default_content_validator_t scanbotsdk_default_content_validator_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_default_content_validator_create(
    scanbotsdk_u8string_ref_t allowed_characters,
    scanbotsdk_default_content_validator_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_default_content_validator_create_with_defaults(
    scanbotsdk_default_content_validator_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_default_content_validator_free(scanbotsdk_default_content_validator_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_content_validator_is_scanbotsdk_default_content_validator(scanbotsdk_content_validator_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_content_validator_as_scanbotsdk_default_content_validator(scanbotsdk_content_validator_t* object, scanbotsdk_default_content_validator_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_default_content_validator_as_scanbotsdk_content_validator(scanbotsdk_default_content_validator_t* object, scanbotsdk_content_validator_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_default_content_validator_get_allowed_characters(scanbotsdk_default_content_validator_t* self, scanbotsdk_u8string_ref_t* allowed_characters);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_default_content_validator_set_allowed_characters(scanbotsdk_default_content_validator_t* self, scanbotsdk_u8string_ref_t allowed_characters);
 

typedef struct scanbotsdk_pattern_content_validator_t scanbotsdk_pattern_content_validator_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_create(
    scanbotsdk_u8string_ref_t allowed_characters,
    scanbotsdk_u8string_ref_t pattern,
    bool match_substring,
    scanbotsdk_pattern_grammar_t pattern_grammar,
    scanbotsdk_pattern_content_validator_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_create_with_defaults(
    scanbotsdk_u8string_ref_t pattern,
    scanbotsdk_pattern_content_validator_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_free(scanbotsdk_pattern_content_validator_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_content_validator_is_scanbotsdk_pattern_content_validator(scanbotsdk_content_validator_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_content_validator_as_scanbotsdk_pattern_content_validator(scanbotsdk_content_validator_t* object, scanbotsdk_pattern_content_validator_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_as_scanbotsdk_content_validator(scanbotsdk_pattern_content_validator_t* object, scanbotsdk_content_validator_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_get_allowed_characters(scanbotsdk_pattern_content_validator_t* self, scanbotsdk_u8string_ref_t* allowed_characters);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_set_allowed_characters(scanbotsdk_pattern_content_validator_t* self, scanbotsdk_u8string_ref_t allowed_characters);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_get_pattern(scanbotsdk_pattern_content_validator_t* self, scanbotsdk_u8string_ref_t* pattern);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_set_pattern(scanbotsdk_pattern_content_validator_t* self, scanbotsdk_u8string_ref_t pattern);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_get_match_substring(scanbotsdk_pattern_content_validator_t* self, bool* match_substring);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_set_match_substring(scanbotsdk_pattern_content_validator_t* self, bool match_substring);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_get_pattern_grammar(scanbotsdk_pattern_content_validator_t* self, scanbotsdk_pattern_grammar_t* pattern_grammar);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_set_pattern_grammar(scanbotsdk_pattern_content_validator_t* self, scanbotsdk_pattern_grammar_t pattern_grammar);
 

typedef struct scanbotsdk_text_pattern_scanner_configuration_t scanbotsdk_text_pattern_scanner_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_create(
    int ocr_resolution_limit,
    int input_height_limit,
    int maximum_number_of_accumulated_frames,
    int minimum_number_of_required_frames_with_equal_scanning_result,
    bool optimize_single_line,
    scanbotsdk_content_validator_t* validator,
    scanbotsdk_text_pattern_scanner_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_create_with_defaults(
    scanbotsdk_text_pattern_scanner_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_free(scanbotsdk_text_pattern_scanner_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_get_ocr_resolution_limit(scanbotsdk_text_pattern_scanner_configuration_t* self, int* ocr_resolution_limit);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_set_ocr_resolution_limit(scanbotsdk_text_pattern_scanner_configuration_t* self, int ocr_resolution_limit);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_get_input_height_limit(scanbotsdk_text_pattern_scanner_configuration_t* self, int* input_height_limit);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_set_input_height_limit(scanbotsdk_text_pattern_scanner_configuration_t* self, int input_height_limit);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_get_maximum_number_of_accumulated_frames(scanbotsdk_text_pattern_scanner_configuration_t* self, int* maximum_number_of_accumulated_frames);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_set_maximum_number_of_accumulated_frames(scanbotsdk_text_pattern_scanner_configuration_t* self, int maximum_number_of_accumulated_frames);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_get_minimum_number_of_required_frames_with_equal_scanning_result(scanbotsdk_text_pattern_scanner_configuration_t* self, int* minimum_number_of_required_frames_with_equal_scanning_result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_set_minimum_number_of_required_frames_with_equal_scanning_result(scanbotsdk_text_pattern_scanner_configuration_t* self, int minimum_number_of_required_frames_with_equal_scanning_result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_get_optimize_single_line(scanbotsdk_text_pattern_scanner_configuration_t* self, bool* optimize_single_line);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_set_optimize_single_line(scanbotsdk_text_pattern_scanner_configuration_t* self, bool optimize_single_line);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_get_validator(scanbotsdk_text_pattern_scanner_configuration_t* self, scanbotsdk_content_validator_t** validator);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_set_validator(scanbotsdk_text_pattern_scanner_configuration_t* self, scanbotsdk_content_validator_t* validator);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_TEXTPATTERNSCANNERTYPES_H */