ScanbotSDKDocumentClassifierTypes.h File Reference

Go to the source code of this file.

Typedefs
typedef struct scanbotsdk_document_classifier_configuration_t	scanbotsdk_document_classifier_configuration_t
	scanbotsdk_document_classifier_configuration_t class
typedef enum scanbotsdk_document_classifier_status_t	scanbotsdk_document_classifier_status_t
	scanbotsdk_document_classifier_status_t enum
typedef enum scanbotsdk_document_type_t	scanbotsdk_document_type_t
	scanbotsdk_document_type_t enum
typedef struct scanbotsdk_document_classifier_result_t	scanbotsdk_document_classifier_result_t
	scanbotsdk_document_classifier_result_t class

Enumerations
enum	scanbotsdk_document_classifier_status_t {   SCANBOTSDK_DOCUMENT_CLASSIFIER_STATUS_SUCCESS = 0 ,   SCANBOTSDK_DOCUMENT_CLASSIFIER_STATUS_FAILURE_SCANNING = 1 }
	scanbotsdk_document_classifier_status_t enum More...
enum	scanbotsdk_document_type_t {   SCANBOTSDK_DOCUMENT_TYPE_UNKNOWN = 0 ,   SCANBOTSDK_DOCUMENT_TYPE_BILL_OF_LADING = 1 ,   SCANBOTSDK_DOCUMENT_TYPE_PAY_SHEET = 2 ,   SCANBOTSDK_DOCUMENT_TYPE_SCALE_TICKET = 3 ,   SCANBOTSDK_DOCUMENT_TYPE_TOLL_RECEIPT = 4 ,   SCANBOTSDK_DOCUMENT_TYPE_WASH_RECEIPT = 5 }
	scanbotsdk_document_type_t enum More...

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_classifier_configuration_create (bool crop, scanbotsdk_document_classifier_configuration_t **result)
	Creates a new instance of scanbotsdk_document_classifier_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_classifier_configuration_create_with_defaults (scanbotsdk_document_classifier_configuration_t **result)
	Creates a new instance of scanbotsdk_document_classifier_configuration_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_classifier_configuration_free (scanbotsdk_document_classifier_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_document_classifier_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_classifier_configuration_get_crop (scanbotsdk_document_classifier_configuration_t *self, bool *crop)
	Returns value of crop field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_classifier_status_t_to_string (scanbotsdk_document_classifier_status_t value, const char **result)
	Returns the string representation of the given scanbotsdk_document_classifier_status_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_type_t_to_string (scanbotsdk_document_type_t value, const char **result)
	Returns the string representation of the given scanbotsdk_document_type_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_classifier_result_free (scanbotsdk_document_classifier_result_t *object)
	Frees the memory allocated for the instance of scanbotsdk_document_classifier_result_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_classifier_result_get_document_type (scanbotsdk_document_classifier_result_t *self, scanbotsdk_document_type_t *document_type)
	Returns value of document_type field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_classifier_result_get_confidence (scanbotsdk_document_classifier_result_t *self, double *confidence)
	Returns value of confidence field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_classifier_result_get_status (scanbotsdk_document_classifier_result_t *self, scanbotsdk_document_classifier_status_t *status)
	Returns value of status field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_classifier_result_get_document_scanning_result (scanbotsdk_document_classifier_result_t *self, scanbotsdk_document_scanning_result_t **document_scanning_result)
	Returns value of document_scanning_result field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.