ScanbotSDKMrzTypes.h File Reference

Go to the source code of this file.

Typedefs
typedef enum scanbotsdk_mrz_document_type_t	scanbotsdk_mrz_document_type_t
	scanbotsdk_mrz_document_type_t enum
typedef struct scanbotsdk_mrz_scanner_result_t	scanbotsdk_mrz_scanner_result_t
	scanbotsdk_mrz_scanner_result_t class
typedef enum scanbotsdk_mrz_incomplete_result_handling_t	scanbotsdk_mrz_incomplete_result_handling_t
	scanbotsdk_mrz_incomplete_result_handling_t enum
typedef struct scanbotsdk_mrz_scanner_configuration_t	scanbotsdk_mrz_scanner_configuration_t
	scanbotsdk_mrz_scanner_configuration_t class
typedef struct scanbotsdk_mrz_parser_configuration_t	scanbotsdk_mrz_parser_configuration_t
	scanbotsdk_mrz_parser_configuration_t class

Enumerations
enum	scanbotsdk_mrz_document_type_t {   SCANBOTSDK_MRZ_DOCUMENT_TYPE_UNKNOWN = 0 ,   SCANBOTSDK_MRZ_DOCUMENT_TYPE_CREW_MEMBER_CERTIFICATE = 1 ,   SCANBOTSDK_MRZ_DOCUMENT_TYPE_ID_CARD = 2 ,   SCANBOTSDK_MRZ_DOCUMENT_TYPE_PASSPORT = 3 ,   SCANBOTSDK_MRZ_DOCUMENT_TYPE_VISA = 4 ,   SCANBOTSDK_MRZ_DOCUMENT_TYPE_CH_DRIVING_LICENSE = 5 }
	scanbotsdk_mrz_document_type_t enum More...
enum	scanbotsdk_mrz_incomplete_result_handling_t {   SCANBOTSDK_MRZ_INCOMPLETE_RESULT_HANDLING_ACCEPT = 0 ,   SCANBOTSDK_MRZ_INCOMPLETE_RESULT_HANDLING_REJECT = 1 }
	scanbotsdk_mrz_incomplete_result_handling_t enum More...

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_document_type_t_to_string (scanbotsdk_mrz_document_type_t value, const char **result)
	Returns the string representation of the given scanbotsdk_mrz_document_type_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_scanner_result_free (scanbotsdk_mrz_scanner_result_t *object)
	Frees the memory allocated for the instance of scanbotsdk_mrz_scanner_result_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_scanner_result_get_success (scanbotsdk_mrz_scanner_result_t *self, bool *success)
	Returns value of success field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_scanner_result_get_raw_mrz (scanbotsdk_mrz_scanner_result_t *self, const char **raw_mrz)
	Returns value of raw_mrz 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_mrz_scanner_result_get_document (scanbotsdk_mrz_scanner_result_t *self, scanbotsdk_generic_document_t **document)
	Returns value of document 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_mrz_incomplete_result_handling_t_to_string (scanbotsdk_mrz_incomplete_result_handling_t value, const char **result)
	Returns the string representation of the given scanbotsdk_mrz_incomplete_result_handling_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_scanner_configuration_create (scanbotsdk_accumulated_results_verifier_configuration_t *frame_accumulation_configuration, bool enable_detection, scanbotsdk_mrz_incomplete_result_handling_t incomplete_result_handling, bool return_crops, scanbotsdk_mrz_scanner_configuration_t **result)
	Creates a new instance of scanbotsdk_mrz_scanner_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_scanner_configuration_create_with_defaults (scanbotsdk_mrz_scanner_configuration_t **result)
	Creates a new instance of scanbotsdk_mrz_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_mrz_scanner_configuration_free (scanbotsdk_mrz_scanner_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_mrz_scanner_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_scanner_configuration_get_frame_accumulation_configuration (scanbotsdk_mrz_scanner_configuration_t *self, scanbotsdk_accumulated_results_verifier_configuration_t **frame_accumulation_configuration)
	Returns value of frame_accumulation_configuration 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_mrz_scanner_configuration_set_frame_accumulation_configuration (scanbotsdk_mrz_scanner_configuration_t *self, scanbotsdk_accumulated_results_verifier_configuration_t *frame_accumulation_configuration)
	Sets value of frame_accumulation_configuration field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_scanner_configuration_get_enable_detection (scanbotsdk_mrz_scanner_configuration_t *self, bool *enable_detection)
	Returns value of enable_detection field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_scanner_configuration_set_enable_detection (scanbotsdk_mrz_scanner_configuration_t *self, bool enable_detection)
	Sets value of enable_detection field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_scanner_configuration_get_incomplete_result_handling (scanbotsdk_mrz_scanner_configuration_t *self, scanbotsdk_mrz_incomplete_result_handling_t *incomplete_result_handling)
	Returns value of incomplete_result_handling field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_scanner_configuration_set_incomplete_result_handling (scanbotsdk_mrz_scanner_configuration_t *self, scanbotsdk_mrz_incomplete_result_handling_t incomplete_result_handling)
	Sets value of incomplete_result_handling field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_scanner_configuration_get_return_crops (scanbotsdk_mrz_scanner_configuration_t *self, bool *return_crops)
	Returns value of return_crops field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_scanner_configuration_set_return_crops (scanbotsdk_mrz_scanner_configuration_t *self, bool return_crops)
	Sets value of return_crops field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_parser_configuration_create (scanbotsdk_mrz_incomplete_result_handling_t incomplete_result_handling, scanbotsdk_mrz_parser_configuration_t **result)
	Creates a new instance of scanbotsdk_mrz_parser_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_parser_configuration_create_with_defaults (scanbotsdk_mrz_parser_configuration_t **result)
	Creates a new instance of scanbotsdk_mrz_parser_configuration_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_parser_configuration_free (scanbotsdk_mrz_parser_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_mrz_parser_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_parser_configuration_get_incomplete_result_handling (scanbotsdk_mrz_parser_configuration_t *self, scanbotsdk_mrz_incomplete_result_handling_t *incomplete_result_handling)
	Returns value of incomplete_result_handling field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_parser_configuration_set_incomplete_result_handling (scanbotsdk_mrz_parser_configuration_t *self, scanbotsdk_mrz_incomplete_result_handling_t incomplete_result_handling)
	Sets value of incomplete_result_handling field of the given object.