Typedefs
typedef struct scanbotsdk_text_pattern_scanner_t	scanbotsdk_text_pattern_scanner_t
	scanbotsdk_text_pattern_scanner_t class

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_text_pattern_scanner_create (scanbotsdk_text_pattern_scanner_configuration_t configuration, scanbotsdk_text_pattern_scanner_t *result)
	Creates a new instance of scanbotsdk_text_pattern_scanner with given params and stores it in the location specified by the last argument.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_text_pattern_scanner_free (scanbotsdk_text_pattern_scanner_t *self)
	Frees the memory allocated for the instance of scanbotsdk_text_pattern_scanner_t. If null is passed, the function does nothing.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_text_pattern_scanner_run (scanbotsdk_text_pattern_scanner_t self, scanbotsdk_image_t image, scanbotsdk_text_pattern_scanner_result_t **result)
	Recognize text line in the given image.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_text_pattern_scanner_clean_recognition_queue (scanbotsdk_text_pattern_scanner_t *self)
	Clean the queue of recognize text lines.

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, scanbotsdk_u8string_ref_t 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, scanbotsdk_u8string_ref_t 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, scanbotsdk_u8string_ref_t 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 (scanbotsdk_u8string_ref_t 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, scanbotsdk_u8string_ref_t 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, scanbotsdk_u8string_ref_t allowed_characters)
	Sets value of allowed_characters field of the given object.

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)
	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 (scanbotsdk_u8string_ref_t 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, scanbotsdk_u8string_ref_t 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, scanbotsdk_u8string_ref_t 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, scanbotsdk_u8string_ref_t 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, scanbotsdk_u8string_ref_t 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 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)
	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_input_height_limit (scanbotsdk_text_pattern_scanner_configuration_t self, int input_height_limit)
	Returns value of input_height_limit field of the given object.

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)
	Sets value of input_height_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_optimize_single_line (scanbotsdk_text_pattern_scanner_configuration_t self, bool optimize_single_line)
	Returns value of optimize_single_line field of the given object.

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)
	Sets value of optimize_single_line 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.

Detailed Description

Typedef Documentation

◆ scanbotsdk_content_validator_t

typedef struct scanbotsdk_content_validator_t scanbotsdk_content_validator_t

scanbotsdk_content_validator_t class

Base class for content validators.

◆ scanbotsdk_default_content_validator_t

typedef struct scanbotsdk_default_content_validator_t scanbotsdk_default_content_validator_t

scanbotsdk_default_content_validator_t class

Default content validator. Accepts only non-empty strings.

◆ scanbotsdk_pattern_content_validator_t

typedef struct scanbotsdk_pattern_content_validator_t scanbotsdk_pattern_content_validator_t

scanbotsdk_pattern_content_validator_t class

Pattern content validator.

◆ scanbotsdk_pattern_grammar_t

typedef enum scanbotsdk_pattern_grammar_t scanbotsdk_pattern_grammar_t

scanbotsdk_pattern_grammar_t enum

Grammar of pattern matching.

◆ scanbotsdk_symbol_box_t

typedef struct scanbotsdk_symbol_box_t scanbotsdk_symbol_box_t

scanbotsdk_symbol_box_t class

Structure containing recognized symbol text and bounds.

◆ scanbotsdk_text_pattern_scanner_configuration_t

typedef struct scanbotsdk_text_pattern_scanner_configuration_t scanbotsdk_text_pattern_scanner_configuration_t

scanbotsdk_text_pattern_scanner_configuration_t class

Configuration for the text pattern scanner.

◆ scanbotsdk_text_pattern_scanner_result_t

typedef struct scanbotsdk_text_pattern_scanner_result_t scanbotsdk_text_pattern_scanner_result_t

scanbotsdk_text_pattern_scanner_result_t class

The result of the text line recognition.

◆ scanbotsdk_text_pattern_scanner_t

typedef struct scanbotsdk_text_pattern_scanner_t scanbotsdk_text_pattern_scanner_t

scanbotsdk_text_pattern_scanner_t class

API for text pattern scanning.

Required licence feature(s): TextPatternScanner.

◆ scanbotsdk_word_box_t

typedef struct scanbotsdk_word_box_t scanbotsdk_word_box_t

scanbotsdk_word_box_t class

Structure containing recognized word text and bounds.

Enumeration Type Documentation

◆ scanbotsdk_pattern_grammar_t

enum scanbotsdk_pattern_grammar_t

scanbotsdk_pattern_grammar_t enum

Grammar of pattern matching.

Enumerator
SCANBOTSDK_PATTERN_GRAMMAR_WILDCARD	Simple pattern matching where # stands for any digit and ? stands for any character. All other characters represent themselves.
SCANBOTSDK_PATTERN_GRAMMAR_REGEX	Regular expression pattern matching. Uses ECMAScript grammar.

Function Documentation

◆ scanbotsdk_content_validator_as_scanbotsdk_default_content_validator()

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.

Parameters

object	Pointer to the instance of scanbotsdk_content_validator_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_default_content_validator_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_content_validator_as_scanbotsdk_pattern_content_validator()

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.

Parameters

object	Pointer to the instance of scanbotsdk_content_validator_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_pattern_content_validator_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_content_validator_free()

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.

Parameters

object Pointer to the instance of scanbotsdk_content_validator_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_content_validator_is_scanbotsdk_default_content_validator()

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.

Parameters

object	Pointer to the instance of scanbotsdk_content_validator_t to be checked
result	Pointer to a variable that will store the result of the check

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_content_validator_is_scanbotsdk_pattern_content_validator()

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.

Parameters

object	Pointer to the instance of scanbotsdk_content_validator_t to be checked
result	Pointer to a variable that will store the result of the check

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_default_content_validator_as_scanbotsdk_content_validator()

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.

Parameters

object	Pointer to the instance of scanbotsdk_content_validator_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_default_content_validator_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_default_content_validator_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_default_content_validator_create	(	scanbotsdk_u8string_ref_t	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.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

allowed_characters OCR whitelist. Empty string means no restriction. Only characters that are present in the allowedCharacters string will be accepted. For example, if allowedCharacters is set to "ab", the result may only contain characters 'a' and 'b'.

Default is "" The value must not be null.

Parameters

result Pointer to a variable that will store the created instance of scanbotsdk_default_content_validator_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_default_content_validator_create_with_defaults()

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.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

result Pointer to a variable that will store the created instance of scanbotsdk_default_content_validator_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_default_content_validator_free()

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.

Parameters

object Pointer to the instance of scanbotsdk_default_content_validator_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_default_content_validator_get_allowed_characters()

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 )

Returns value of allowed_characters field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

OCR whitelist. Empty string means no restriction. Only characters that are present in the allowedCharacters string will be accepted. For example, if allowedCharacters is set to "ab", the result may only contain characters 'a' and 'b'.

Default is ""

Parameters

self	Pointer to the instance of scanbotsdk_default_content_validator_t
allowed_characters	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_default_content_validator_set_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 )

Sets value of allowed_characters field of the given object.

OCR whitelist. Empty string means no restriction. Only characters that are present in the allowedCharacters string will be accepted. For example, if allowedCharacters is set to "ab", the result may only contain characters 'a' and 'b'.

Default is ""

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_default_content_validator_t, the field of which will be set
allowed_characters	The value to be set. Must not be null.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_pattern_content_validator_as_scanbotsdk_content_validator()

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.

Parameters

object	Pointer to the instance of scanbotsdk_content_validator_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_pattern_content_validator_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_pattern_content_validator_create()

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 )

Creates a new instance of scanbotsdk_pattern_content_validator with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

allowed_characters OCR whitelist. Empty string means no restriction. Only characters that are present in the allowedCharacters string will be accepted. For example, if allowedCharacters is set to "ab", the result may only contain characters 'a' and 'b'.

Default is "" The value must not be null.

Parameters

pattern	Pattern to match. It can be a simple pattern or a regular expression. The value must not be null.
match_substring	Whether the pattern should match the whole string or just a substring.

Default is false.

Parameters

pattern_grammar Grammar of pattern matching.

Default is WILDCARD.

Parameters

result Pointer to a variable that will store the created instance of scanbotsdk_pattern_content_validator_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_pattern_content_validator_create_with_defaults()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_create_with_defaults	(	scanbotsdk_u8string_ref_t	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.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

pattern	Pattern to match. It can be a simple pattern or a regular expression. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_pattern_content_validator_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_pattern_content_validator_free()

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.

Parameters

object Pointer to the instance of scanbotsdk_pattern_content_validator_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_pattern_content_validator_get_allowed_characters()

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 )

Returns value of allowed_characters field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

OCR whitelist. Empty string means no restriction. Only characters that are present in the allowedCharacters string will be accepted. For example, if allowedCharacters is set to "ab", the result may only contain characters 'a' and 'b'.

Default is ""

Parameters

self	Pointer to the instance of scanbotsdk_pattern_content_validator_t
allowed_characters	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_pattern_content_validator_get_match_substring()

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.

Whether the pattern should match the whole string or just a substring.

Default is false.

Parameters

self	Pointer to the instance of scanbotsdk_pattern_content_validator_t
match_substring	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_pattern_content_validator_get_pattern()

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

Returns value of pattern field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Pattern to match. It can be a simple pattern or a regular expression.

Parameters

self	Pointer to the instance of scanbotsdk_pattern_content_validator_t
pattern	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_pattern_content_validator_get_pattern_grammar()

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.

Grammar of pattern matching.

Default is WILDCARD.

Parameters

self	Pointer to the instance of scanbotsdk_pattern_content_validator_t
pattern_grammar	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_pattern_content_validator_set_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 )

Sets value of allowed_characters field of the given object.

OCR whitelist. Empty string means no restriction. Only characters that are present in the allowedCharacters string will be accepted. For example, if allowedCharacters is set to "ab", the result may only contain characters 'a' and 'b'.

Default is ""

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_pattern_content_validator_t, the field of which will be set
allowed_characters	The value to be set. Must not be null.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_pattern_content_validator_set_match_substring()

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.

Whether the pattern should match the whole string or just a substring.

Default is false.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_pattern_content_validator_t, the field of which will be set
match_substring	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_pattern_content_validator_set_pattern()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pattern_content_validator_set_pattern	(	scanbotsdk_pattern_content_validator_t *	self,
		scanbotsdk_u8string_ref_t	pattern )

Sets value of pattern field of the given object.

Pattern to match. It can be a simple pattern or a regular expression.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_pattern_content_validator_t, the field of which will be set
pattern	The value to be set. Must not be null.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_pattern_content_validator_set_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 )

Sets value of pattern_grammar field of the given object.

Grammar of pattern matching.

Default is WILDCARD.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_pattern_content_validator_t, the field of which will be set
pattern_grammar	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_pattern_grammar_t_to_string()

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.

The returned string doesn't need to be freed.

Parameters

value	The value to be converted to string.
result	Pointer to a variable that will store the string representation of the value.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_symbol_box_free()

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.

Parameters

object Pointer to the instance of scanbotsdk_symbol_box_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_symbol_box_get_bounding_rect()

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.

Bounding rectangle of the recognized symbol.

Parameters

self	Pointer to the instance of scanbotsdk_symbol_box_t
bounding_rect	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_symbol_box_get_recognition_confidence()

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.

Confidence of the recognition.

Parameters

self	Pointer to the instance of scanbotsdk_symbol_box_t
recognition_confidence	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_symbol_box_get_symbol()

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

Returns value of symbol field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Recognized symbol text.

Parameters

self	Pointer to the instance of scanbotsdk_symbol_box_t
symbol	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_text_pattern_scanner_clean_recognition_queue()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_clean_recognition_queue ( scanbotsdk_text_pattern_scanner_t * self )

Clean the queue of recognize text lines.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_t method to be called on

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_text_pattern_scanner_configuration_create()

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 )

Creates a new instance of scanbotsdk_text_pattern_scanner_configuration with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

ocr_resolution_limit The option will be ignored if inputHeightLimit is not 0. Maximum image size (height or width) for OCR process. 0 - do not rescale.

Default is 0. Deprecated. Replaced by scanbotsdk_text_pattern_scanner_configuration_get_input_height_limit or scanbotsdk_text_pattern_scanner_configuration_set_input_height_limit or the corresponding constructor argument.

Parameters

input_height_limit Maximum image height for OCR processing. 0 - do not rescale.

Default is 120.

Parameters

maximum_number_of_accumulated_frames Maximum number of accumulated frames to inspect before actual result is returned.

Default is 3.

Parameters

minimum_number_of_required_frames_with_equal_scanning_result Minimum number of accumulated frames that have equal result.

Default is 2.

Parameters

optimize_single_line Optimize for scanning a single line or a single word. Enable this option when scanning a single line or single word that are hard to scan reliably.

Default is false.

Parameters

validator	Content validator. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_text_pattern_scanner_configuration_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_text_pattern_scanner_configuration_create_with_defaults()

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.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

result Pointer to a variable that will store the created instance of scanbotsdk_text_pattern_scanner_configuration_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_text_pattern_scanner_configuration_free()

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.

Parameters

object Pointer to the instance of scanbotsdk_text_pattern_scanner_configuration_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_text_pattern_scanner_configuration_get_input_height_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 )

Returns value of input_height_limit field of the given object.

Maximum image height for OCR processing. 0 - do not rescale.

Default is 120.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_configuration_t
input_height_limit	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_text_pattern_scanner_configuration_get_maximum_number_of_accumulated_frames()

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.

Maximum number of accumulated frames to inspect before actual result is returned.

Default is 3.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_configuration_t
maximum_number_of_accumulated_frames	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_text_pattern_scanner_configuration_get_minimum_number_of_required_frames_with_equal_scanning_result()

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.

Minimum number of accumulated frames that have equal result.

Default is 2.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_configuration_t
minimum_number_of_required_frames_with_equal_scanning_result	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_text_pattern_scanner_configuration_get_ocr_resolution_limit()

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.

The option will be ignored if inputHeightLimit is not 0. Maximum image size (height or width) for OCR process. 0 - do not rescale.

Default is 0.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_configuration_t
ocr_resolution_limit	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

Deprecated: Replaced by scanbotsdk_text_pattern_scanner_configuration_get_input_height_limit or scanbotsdk_text_pattern_scanner_configuration_set_input_height_limit or the corresponding constructor argument.

◆ scanbotsdk_text_pattern_scanner_configuration_get_optimize_single_line()

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 )

Returns value of optimize_single_line field of the given object.

Optimize for scanning a single line or a single word. Enable this option when scanning a single line or single word that are hard to scan reliably.

Default is false.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_configuration_t
optimize_single_line	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_text_pattern_scanner_configuration_get_validator()

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.

Content validator.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_configuration_t
validator	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_text_pattern_scanner_configuration_set_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 )

Sets value of input_height_limit field of the given object.

Maximum image height for OCR processing. 0 - do not rescale.

Default is 120.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_configuration_t, the field of which will be set
input_height_limit	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_text_pattern_scanner_configuration_set_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 )

Sets value of maximum_number_of_accumulated_frames field of the given object.

Maximum number of accumulated frames to inspect before actual result is returned.

Default is 3.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_configuration_t, the field of which will be set
maximum_number_of_accumulated_frames	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_text_pattern_scanner_configuration_set_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 )

Sets value of minimum_number_of_required_frames_with_equal_scanning_result field of the given object.

Minimum number of accumulated frames that have equal result.

Default is 2.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_configuration_t, the field of which will be set
minimum_number_of_required_frames_with_equal_scanning_result	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_text_pattern_scanner_configuration_set_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 )

Sets value of ocr_resolution_limit field of the given object.

The option will be ignored if inputHeightLimit is not 0. Maximum image size (height or width) for OCR process. 0 - do not rescale.

Default is 0.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_configuration_t, the field of which will be set
ocr_resolution_limit	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

Deprecated: Replaced by scanbotsdk_text_pattern_scanner_configuration_get_input_height_limit or scanbotsdk_text_pattern_scanner_configuration_set_input_height_limit or the corresponding constructor argument.

◆ scanbotsdk_text_pattern_scanner_configuration_set_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 )

Sets value of optimize_single_line field of the given object.

Optimize for scanning a single line or a single word. Enable this option when scanning a single line or single word that are hard to scan reliably.

Default is false.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_configuration_t, the field of which will be set
optimize_single_line	The value to be set.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_text_pattern_scanner_configuration_set_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 )

Sets value of validator field of the given object.

Content validator.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_configuration_t, the field of which will be set
validator	The value to be set. Must not be null.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_text_pattern_scanner_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_create	(	scanbotsdk_text_pattern_scanner_configuration_t *	configuration,
		scanbotsdk_text_pattern_scanner_t **	result )

Creates a new instance of scanbotsdk_text_pattern_scanner with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

configuration	The configuration to use for the generic text line scanner. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_text_pattern_scanner_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_text_pattern_scanner_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_free ( scanbotsdk_text_pattern_scanner_t * self )

Frees the memory allocated for the instance of scanbotsdk_text_pattern_scanner_t. If null is passed, the function does nothing.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_text_pattern_scanner_result_free()

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.

Parameters

object Pointer to the instance of scanbotsdk_text_pattern_scanner_result_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_text_pattern_scanner_result_get_confidence()

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.

Confidence of the recognition.

Default is 0.0.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_result_t
confidence	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_text_pattern_scanner_result_get_raw_text()

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 )

Returns value of raw_text field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Raw recognized string.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_result_t
raw_text	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_text_pattern_scanner_result_get_symbol_boxes()

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.

Boxes for each recognized symbol.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_result_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
symbol_boxes	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_text_pattern_scanner_result_get_symbol_boxes_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 )

Returns size of symbol_boxes array.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_result_t
size	Pointer to a variable that will store the size.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_text_pattern_scanner_result_get_validation_successful()

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.

True if both the configured validator (if any) and the configured frame accumulation criteria were satisfied.

Default is false.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_result_t
validation_successful	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_text_pattern_scanner_result_get_word_boxes()

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.

Boxes for each recognized word.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_result_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
word_boxes	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_text_pattern_scanner_result_get_word_boxes_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 )

Returns size of word_boxes array.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_result_t
size	Pointer to a variable that will store the size.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_text_pattern_scanner_run()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_text_pattern_scanner_run	(	scanbotsdk_text_pattern_scanner_t *	self,
		scanbotsdk_image_t *	image,
		scanbotsdk_text_pattern_scanner_result_t **	result )

Recognize text line in the given image.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_text_pattern_scanner_t method to be called on
image	The image to recognize text line in. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_text_pattern_scanner_t

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_word_box_free()

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.

Parameters

object Pointer to the instance of scanbotsdk_word_box_t to be freed

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered

◆ scanbotsdk_word_box_get_bounding_rect()

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.

Bounding rectangle of the recognized word.

Parameters

self	Pointer to the instance of scanbotsdk_word_box_t
bounding_rect	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_word_box_get_recognition_confidence()

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.

Confidence of the recognition.

Default is 0.0.

Parameters

self	Pointer to the instance of scanbotsdk_word_box_t
recognition_confidence	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

◆ scanbotsdk_word_box_get_text()

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

Returns value of text field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Recognized word text.

Parameters

self	Pointer to the instance of scanbotsdk_word_box_t
text	Pointer to a variable that will store the value of the field.

Returns: : Error code, SCANBOTSDK_OK if no errors were encountered.

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ scanbotsdk_content_validator_t

◆ scanbotsdk_default_content_validator_t

◆ scanbotsdk_pattern_content_validator_t

◆ scanbotsdk_pattern_grammar_t

◆ scanbotsdk_symbol_box_t

◆ scanbotsdk_text_pattern_scanner_configuration_t

◆ scanbotsdk_text_pattern_scanner_result_t

◆ scanbotsdk_text_pattern_scanner_t

◆ scanbotsdk_word_box_t

Enumeration Type Documentation

◆ scanbotsdk_pattern_grammar_t

Function Documentation

◆ scanbotsdk_content_validator_as_scanbotsdk_default_content_validator()

◆ scanbotsdk_content_validator_as_scanbotsdk_pattern_content_validator()

◆ scanbotsdk_content_validator_free()

◆ scanbotsdk_content_validator_is_scanbotsdk_default_content_validator()

◆ scanbotsdk_content_validator_is_scanbotsdk_pattern_content_validator()

◆ scanbotsdk_default_content_validator_as_scanbotsdk_content_validator()

◆ scanbotsdk_default_content_validator_create()

◆ scanbotsdk_default_content_validator_create_with_defaults()

◆ scanbotsdk_default_content_validator_free()

◆ scanbotsdk_default_content_validator_get_allowed_characters()

◆ scanbotsdk_default_content_validator_set_allowed_characters()

◆ scanbotsdk_pattern_content_validator_as_scanbotsdk_content_validator()

◆ scanbotsdk_pattern_content_validator_create()

◆ scanbotsdk_pattern_content_validator_create_with_defaults()

◆ scanbotsdk_pattern_content_validator_free()

◆ scanbotsdk_pattern_content_validator_get_allowed_characters()

◆ scanbotsdk_pattern_content_validator_get_match_substring()

◆ scanbotsdk_pattern_content_validator_get_pattern()

◆ scanbotsdk_pattern_content_validator_get_pattern_grammar()

◆ scanbotsdk_pattern_content_validator_set_allowed_characters()

◆ scanbotsdk_pattern_content_validator_set_match_substring()

◆ scanbotsdk_pattern_content_validator_set_pattern()

◆ scanbotsdk_pattern_content_validator_set_pattern_grammar()

◆ scanbotsdk_pattern_grammar_t_to_string()

◆ scanbotsdk_symbol_box_free()

◆ scanbotsdk_symbol_box_get_bounding_rect()

◆ scanbotsdk_symbol_box_get_recognition_confidence()

◆ scanbotsdk_symbol_box_get_symbol()

◆ scanbotsdk_text_pattern_scanner_clean_recognition_queue()

◆ scanbotsdk_text_pattern_scanner_configuration_create()

◆ scanbotsdk_text_pattern_scanner_configuration_create_with_defaults()

◆ scanbotsdk_text_pattern_scanner_configuration_free()

◆ scanbotsdk_text_pattern_scanner_configuration_get_input_height_limit()

◆ scanbotsdk_text_pattern_scanner_configuration_get_maximum_number_of_accumulated_frames()

◆ scanbotsdk_text_pattern_scanner_configuration_get_minimum_number_of_required_frames_with_equal_scanning_result()

◆ scanbotsdk_text_pattern_scanner_configuration_get_ocr_resolution_limit()

◆ scanbotsdk_text_pattern_scanner_configuration_get_optimize_single_line()

◆ scanbotsdk_text_pattern_scanner_configuration_get_validator()

◆ scanbotsdk_text_pattern_scanner_configuration_set_input_height_limit()

◆ scanbotsdk_text_pattern_scanner_configuration_set_maximum_number_of_accumulated_frames()

◆ scanbotsdk_text_pattern_scanner_configuration_set_minimum_number_of_required_frames_with_equal_scanning_result()

◆ scanbotsdk_text_pattern_scanner_configuration_set_ocr_resolution_limit()

◆ scanbotsdk_text_pattern_scanner_configuration_set_optimize_single_line()

◆ scanbotsdk_text_pattern_scanner_configuration_set_validator()

◆ scanbotsdk_text_pattern_scanner_create()

◆ scanbotsdk_text_pattern_scanner_free()

◆ scanbotsdk_text_pattern_scanner_result_free()

◆ scanbotsdk_text_pattern_scanner_result_get_confidence()

◆ scanbotsdk_text_pattern_scanner_result_get_raw_text()

◆ scanbotsdk_text_pattern_scanner_result_get_symbol_boxes()

◆ scanbotsdk_text_pattern_scanner_result_get_symbol_boxes_size()

◆ scanbotsdk_text_pattern_scanner_result_get_validation_successful()

◆ scanbotsdk_text_pattern_scanner_result_get_word_boxes()

◆ scanbotsdk_text_pattern_scanner_result_get_word_boxes_size()

◆ scanbotsdk_text_pattern_scanner_run()

◆ scanbotsdk_word_box_free()

◆ scanbotsdk_word_box_get_bounding_rect()

◆ scanbotsdk_word_box_get_recognition_confidence()

◆ scanbotsdk_word_box_get_text()