Scanbot SDK
Loading...
Searching...
No Matches
ScanbotSDKTextPatternScannerTypes.h File Reference

Go to the source code of this file.

Typedefs

typedef enum scanbotsdk_pattern_grammar_t scanbotsdk_pattern_grammar_t
 scanbotsdk_pattern_grammar_t enum
 
typedef struct scanbotsdk_word_box_t scanbotsdk_word_box_t
 scanbotsdk_word_box_t class
 
typedef struct scanbotsdk_symbol_box_t scanbotsdk_symbol_box_t
 scanbotsdk_symbol_box_t class
 
typedef struct scanbotsdk_text_pattern_scanner_result_t scanbotsdk_text_pattern_scanner_result_t
 scanbotsdk_text_pattern_scanner_result_t class
 
typedef struct scanbotsdk_content_validator_t scanbotsdk_content_validator_t
 scanbotsdk_content_validator_t class
 
typedef struct scanbotsdk_default_content_validator_t scanbotsdk_default_content_validator_t
 scanbotsdk_default_content_validator_t class
 
typedef struct scanbotsdk_pattern_content_validator_t scanbotsdk_pattern_content_validator_t
 scanbotsdk_pattern_content_validator_t class
 
typedef struct scanbotsdk_text_pattern_scanner_configuration_t scanbotsdk_text_pattern_scanner_configuration_t
 scanbotsdk_text_pattern_scanner_configuration_t class
 

Enumerations

enum  scanbotsdk_pattern_grammar_t {
  SCANBOTSDK_PATTERN_GRAMMAR_WILDCARD = 0 ,
  SCANBOTSDK_PATTERN_GRAMMAR_REGEX = 1
}
 scanbotsdk_pattern_grammar_t enum More...
 

Functions

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_grammar_t_to_string (scanbotsdk_pattern_grammar_t value, const char **result)
 Returns the string representation of the given scanbotsdk_pattern_grammar_t value.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_word_box_free (scanbotsdk_word_box_t *object)
 Frees the memory allocated for the instance of scanbotsdk_word_box_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_word_box_get_text (scanbotsdk_word_box_t *self, const char **text)
 Returns value of text field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_word_box_get_bounding_rect (scanbotsdk_word_box_t *self, scanbotsdk_rect_t *bounding_rect)
 Returns value of bounding_rect field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_word_box_get_recognition_confidence (scanbotsdk_word_box_t *self, double *recognition_confidence)
 Returns value of recognition_confidence field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_symbol_box_free (scanbotsdk_symbol_box_t *object)
 Frees the memory allocated for the instance of scanbotsdk_symbol_box_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_symbol_box_get_symbol (scanbotsdk_symbol_box_t *self, const char **symbol)
 Returns value of symbol field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_symbol_box_get_bounding_rect (scanbotsdk_symbol_box_t *self, scanbotsdk_rect_t *bounding_rect)
 Returns value of bounding_rect field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_symbol_box_get_recognition_confidence (scanbotsdk_symbol_box_t *self, double *recognition_confidence)
 Returns value of recognition_confidence field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_result_free (scanbotsdk_text_pattern_scanner_result_t *object)
 Frees the memory allocated for the instance of scanbotsdk_text_pattern_scanner_result_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_result_get_raw_text (scanbotsdk_text_pattern_scanner_result_t *self, const char **raw_text)
 Returns value of raw_text field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
 
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)
 Returns value of word_boxes field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
 
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)
 Returns size of word_boxes array.
 
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)
 Returns value of symbol_boxes field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
 
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)
 Returns size of symbol_boxes array.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_result_get_confidence (scanbotsdk_text_pattern_scanner_result_t *self, double *confidence)
 Returns value of confidence field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_result_get_validation_successful (scanbotsdk_text_pattern_scanner_result_t *self, bool *validation_successful)
 Returns value of validation_successful field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_content_validator_free (scanbotsdk_content_validator_t *object)
 Frees the memory allocated for the instance of scanbotsdk_content_validator_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_default_content_validator_create (const char *allowed_characters, scanbotsdk_default_content_validator_t **result)
 Creates a new instance of scanbotsdk_default_content_validator with given params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_default_content_validator_create_with_defaults (scanbotsdk_default_content_validator_t **result)
 Creates a new instance of scanbotsdk_default_content_validator_t with given required params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_default_content_validator_free (scanbotsdk_default_content_validator_t *object)
 Frees the memory allocated for the instance of scanbotsdk_default_content_validator_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_content_validator_is_scanbotsdk_default_content_validator (scanbotsdk_content_validator_t *object, bool *result)
 Checks if the given instance of scanbotsdk_content_validator_t is an instance of its subtype scanbotsdk_default_content_validator_t.
 
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)
 Casts the given instance of scanbotsdk_content_validator_t to its subtype scanbotsdk_default_content_validator_t. If the given instance is not an instance of the subtype, result will be null.
 
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)
 Casts the given instance of scanbotsdk_default_content_validator_t to its parent type scanbotsdk_content_validator_t.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_default_content_validator_get_allowed_characters (scanbotsdk_default_content_validator_t *self, const char **allowed_characters)
 Returns value of allowed_characters field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_default_content_validator_set_allowed_characters (scanbotsdk_default_content_validator_t *self, const char *allowed_characters)
 Sets value of allowed_characters field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_create (const char *allowed_characters, const char *pattern, bool match_substring, scanbotsdk_pattern_grammar_t pattern_grammar, scanbotsdk_pattern_content_validator_t **result)
 Creates a new instance of scanbotsdk_pattern_content_validator with given params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_create_with_defaults (const char *pattern, scanbotsdk_pattern_content_validator_t **result)
 Creates a new instance of scanbotsdk_pattern_content_validator_t with given required params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_free (scanbotsdk_pattern_content_validator_t *object)
 Frees the memory allocated for the instance of scanbotsdk_pattern_content_validator_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_content_validator_is_scanbotsdk_pattern_content_validator (scanbotsdk_content_validator_t *object, bool *result)
 Checks if the given instance of scanbotsdk_content_validator_t is an instance of its subtype scanbotsdk_pattern_content_validator_t.
 
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)
 Casts the given instance of scanbotsdk_content_validator_t to its subtype scanbotsdk_pattern_content_validator_t. If the given instance is not an instance of the subtype, result will be null.
 
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)
 Casts the given instance of scanbotsdk_pattern_content_validator_t to its parent type scanbotsdk_content_validator_t.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_get_allowed_characters (scanbotsdk_pattern_content_validator_t *self, const char **allowed_characters)
 Returns value of allowed_characters field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_set_allowed_characters (scanbotsdk_pattern_content_validator_t *self, const char *allowed_characters)
 Sets value of allowed_characters field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_get_pattern (scanbotsdk_pattern_content_validator_t *self, const char **pattern)
 Returns value of pattern field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_set_pattern (scanbotsdk_pattern_content_validator_t *self, const char *pattern)
 Sets value of pattern field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_get_match_substring (scanbotsdk_pattern_content_validator_t *self, bool *match_substring)
 Returns value of match_substring field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_set_match_substring (scanbotsdk_pattern_content_validator_t *self, bool match_substring)
 Sets value of match_substring field of the given object.
 
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)
 Returns value of pattern_grammar field of the given object.
 
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)
 Sets value of pattern_grammar field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_create (int ocr_resolution_limit, int maximum_number_of_accumulated_frames, int minimum_number_of_required_frames_with_equal_scanning_result, scanbotsdk_content_validator_t *validator, scanbotsdk_text_pattern_scanner_configuration_t **result)
 Creates a new instance of scanbotsdk_text_pattern_scanner_configuration with given params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_create_with_defaults (scanbotsdk_text_pattern_scanner_configuration_t **result)
 Creates a new instance of scanbotsdk_text_pattern_scanner_configuration_t with given required params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_configuration_free (scanbotsdk_text_pattern_scanner_configuration_t *object)
 Frees the memory allocated for the instance of scanbotsdk_text_pattern_scanner_configuration_t. If null is passed, the function does nothing.
 
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)
 Returns value of ocr_resolution_limit field of the given object.
 
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)
 Sets value of ocr_resolution_limit field of the given object.
 
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)
 Returns value of maximum_number_of_accumulated_frames field of the given object.
 
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)
 Sets value of maximum_number_of_accumulated_frames field of the given object.
 
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)
 Returns value of minimum_number_of_required_frames_with_equal_scanning_result field of the given object.
 
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)
 Sets value of minimum_number_of_required_frames_with_equal_scanning_result field of the given object.
 
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)
 Returns value of validator field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
 
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)
 Sets value of validator field of the given object.