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

Go to the source code of this file.

Typedefs

typedef enum scanbotsdk_vin_barcode_extraction_status_t scanbotsdk_vin_barcode_extraction_status_t
 scanbotsdk_vin_barcode_extraction_status_t enum
 
typedef struct scanbotsdk_vin_barcode_result_t scanbotsdk_vin_barcode_result_t
 scanbotsdk_vin_barcode_result_t class
 
typedef struct scanbotsdk_vin_scanner_result_t scanbotsdk_vin_scanner_result_t
 scanbotsdk_vin_scanner_result_t class
 
typedef struct scanbotsdk_vin_scanner_configuration_t scanbotsdk_vin_scanner_configuration_t
 scanbotsdk_vin_scanner_configuration_t class
 

Enumerations

enum  scanbotsdk_vin_barcode_extraction_status_t {
  SCANBOTSDK_VIN_BARCODE_EXTRACTION_STATUS_SUCCESS = 0 ,
  SCANBOTSDK_VIN_BARCODE_EXTRACTION_STATUS_BARCODE_WITHOUT_VIN = 1 ,
  SCANBOTSDK_VIN_BARCODE_EXTRACTION_STATUS_NO_BARCODE_FOUND = 2 ,
  SCANBOTSDK_VIN_BARCODE_EXTRACTION_STATUS_BARCODE_EXTRACTION_DISABLED = 3
}
 scanbotsdk_vin_barcode_extraction_status_t enum More...
 

Functions

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_barcode_extraction_status_t_to_string (scanbotsdk_vin_barcode_extraction_status_t value, const char **result)
 Returns the string representation of the given scanbotsdk_vin_barcode_extraction_status_t value.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_barcode_result_free (scanbotsdk_vin_barcode_result_t *object)
 Frees the memory allocated for the instance of scanbotsdk_vin_barcode_result_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_barcode_result_get_extracted_vin (scanbotsdk_vin_barcode_result_t *self, const char **extracted_vin)
 Returns value of extracted_vin 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_vin_barcode_result_get_rectangle (scanbotsdk_vin_barcode_result_t *self, scanbotsdk_point_t **rectangle)
 Returns value of rectangle field of the given object. The returned value is direct view into memory, no pre-allocations needed.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_barcode_result_get_rectangle_size (scanbotsdk_vin_barcode_result_t *self, size_t *size)
 Returns size of rectangle array.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_barcode_result_get_status (scanbotsdk_vin_barcode_result_t *self, scanbotsdk_vin_barcode_extraction_status_t *status)
 Returns value of status field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_result_free (scanbotsdk_vin_scanner_result_t *object)
 Frees the memory allocated for the instance of scanbotsdk_vin_scanner_result_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_result_get_text_result (scanbotsdk_vin_scanner_result_t *self, scanbotsdk_text_pattern_scanner_result_t **text_result)
 Returns value of text_result 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_vin_scanner_result_get_barcode_result (scanbotsdk_vin_scanner_result_t *self, scanbotsdk_vin_barcode_result_t **barcode_result)
 Returns value of barcode_result 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_vin_scanner_configuration_create (bool extract_vin_from_barcode, int ocr_resolution_limit, int maximum_number_of_accumulated_frames, int minimum_number_of_required_frames_with_equal_scanning_result, scanbotsdk_vin_scanner_configuration_t **result)
 Creates a new instance of scanbotsdk_vin_scanner_configuration with given params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_create_with_defaults (scanbotsdk_vin_scanner_configuration_t **result)
 Creates a new instance of scanbotsdk_vin_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_vin_scanner_configuration_free (scanbotsdk_vin_scanner_configuration_t *object)
 Frees the memory allocated for the instance of scanbotsdk_vin_scanner_configuration_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_get_extract_vin_from_barcode (scanbotsdk_vin_scanner_configuration_t *self, bool *extract_vin_from_barcode)
 Returns value of extract_vin_from_barcode field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_set_extract_vin_from_barcode (scanbotsdk_vin_scanner_configuration_t *self, bool extract_vin_from_barcode)
 Sets value of extract_vin_from_barcode field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_configuration_get_ocr_resolution_limit (scanbotsdk_vin_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_vin_scanner_configuration_set_ocr_resolution_limit (scanbotsdk_vin_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_vin_scanner_configuration_get_maximum_number_of_accumulated_frames (scanbotsdk_vin_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_vin_scanner_configuration_set_maximum_number_of_accumulated_frames (scanbotsdk_vin_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_vin_scanner_configuration_get_minimum_number_of_required_frames_with_equal_scanning_result (scanbotsdk_vin_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_vin_scanner_configuration_set_minimum_number_of_required_frames_with_equal_scanning_result (scanbotsdk_vin_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.