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

Go to the source code of this file.

Typedefs

typedef enum scanbotsdk_credit_card_scanning_status_t scanbotsdk_credit_card_scanning_status_t
 scanbotsdk_credit_card_scanning_status_t enum
 
typedef struct scanbotsdk_credit_card_scanning_result_t scanbotsdk_credit_card_scanning_result_t
 scanbotsdk_credit_card_scanning_result_t class
 
typedef struct scanbotsdk_credit_card_scanner_configuration_t scanbotsdk_credit_card_scanner_configuration_t
 scanbotsdk_credit_card_scanner_configuration_t class
 

Enumerations

enum  scanbotsdk_credit_card_scanning_status_t {
  SCANBOTSDK_CREDIT_CARD_SCANNING_STATUS_SUCCESS = 0 ,
  SCANBOTSDK_CREDIT_CARD_SCANNING_STATUS_ERROR_NOTHING_FOUND = 1 ,
  SCANBOTSDK_CREDIT_CARD_SCANNING_STATUS_INCOMPLETE = 2
}
 scanbotsdk_credit_card_scanning_status_t enum More...
 

Functions

SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanning_status_t_to_string (scanbotsdk_credit_card_scanning_status_t value, const char **result)
 Returns the string representation of the given scanbotsdk_credit_card_scanning_status_t value.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanning_result_free (scanbotsdk_credit_card_scanning_result_t *object)
 Frees the memory allocated for the instance of scanbotsdk_credit_card_scanning_result_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanning_result_get_detection_status (scanbotsdk_credit_card_scanning_result_t *self, scanbotsdk_document_detection_status_t *detection_status)
 Returns value of detection_status field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanning_result_get_scanning_status (scanbotsdk_credit_card_scanning_result_t *self, scanbotsdk_credit_card_scanning_status_t *scanning_status)
 Returns value of scanning_status field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanning_result_get_credit_card (scanbotsdk_credit_card_scanning_result_t *self, scanbotsdk_generic_document_t **credit_card)
 Returns value of credit_card 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_credit_card_scanning_result_get_quad (scanbotsdk_credit_card_scanning_result_t *self, scanbotsdk_point_t **quad)
 Returns value of quad field of the given object. The returned value is direct view into memory, no pre-allocations needed.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanning_result_get_quad_size (scanbotsdk_credit_card_scanning_result_t *self, size_t *size)
 Returns size of quad array.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanning_result_get_quad_normalized (scanbotsdk_credit_card_scanning_result_t *self, scanbotsdk_pointf_t **quad_normalized)
 Returns value of quad_normalized field of the given object. The returned value is direct view into memory, no pre-allocations needed.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanning_result_get_quad_normalized_size (scanbotsdk_credit_card_scanning_result_t *self, size_t *size)
 Returns size of quad_normalized array.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanner_configuration_create (bool use_document_detector, bool require_expiry_date, bool require_cardholder_name, scanbotsdk_result_accumulation_configuration_t *result_accumulation_config, bool return_credit_card_image, scanbotsdk_processing_mode_t processing_mode, scanbotsdk_credit_card_scanner_configuration_t **result)
 Creates a new instance of scanbotsdk_credit_card_scanner_configuration with given params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanner_configuration_create_with_defaults (scanbotsdk_credit_card_scanner_configuration_t **result)
 Creates a new instance of scanbotsdk_credit_card_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_credit_card_scanner_configuration_free (scanbotsdk_credit_card_scanner_configuration_t *object)
 Frees the memory allocated for the instance of scanbotsdk_credit_card_scanner_configuration_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanner_configuration_get_use_document_detector (scanbotsdk_credit_card_scanner_configuration_t *self, bool *use_document_detector)
 Returns value of use_document_detector field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanner_configuration_set_use_document_detector (scanbotsdk_credit_card_scanner_configuration_t *self, bool use_document_detector)
 Sets value of use_document_detector field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanner_configuration_get_require_expiry_date (scanbotsdk_credit_card_scanner_configuration_t *self, bool *require_expiry_date)
 Returns value of require_expiry_date field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanner_configuration_set_require_expiry_date (scanbotsdk_credit_card_scanner_configuration_t *self, bool require_expiry_date)
 Sets value of require_expiry_date field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanner_configuration_get_require_cardholder_name (scanbotsdk_credit_card_scanner_configuration_t *self, bool *require_cardholder_name)
 Returns value of require_cardholder_name field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanner_configuration_set_require_cardholder_name (scanbotsdk_credit_card_scanner_configuration_t *self, bool require_cardholder_name)
 Sets value of require_cardholder_name field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanner_configuration_get_result_accumulation_config (scanbotsdk_credit_card_scanner_configuration_t *self, scanbotsdk_result_accumulation_configuration_t **result_accumulation_config)
 Returns value of result_accumulation_config 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_credit_card_scanner_configuration_set_result_accumulation_config (scanbotsdk_credit_card_scanner_configuration_t *self, scanbotsdk_result_accumulation_configuration_t *result_accumulation_config)
 Sets value of result_accumulation_config field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanner_configuration_get_return_credit_card_image (scanbotsdk_credit_card_scanner_configuration_t *self, bool *return_credit_card_image)
 Returns value of return_credit_card_image field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanner_configuration_set_return_credit_card_image (scanbotsdk_credit_card_scanner_configuration_t *self, bool return_credit_card_image)
 Sets value of return_credit_card_image field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanner_configuration_get_processing_mode (scanbotsdk_credit_card_scanner_configuration_t *self, scanbotsdk_processing_mode_t *processing_mode)
 Returns value of processing_mode field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_credit_card_scanner_configuration_set_processing_mode (scanbotsdk_credit_card_scanner_configuration_t *self, scanbotsdk_processing_mode_t processing_mode)
 Sets value of processing_mode field of the given object.