Typedefs
typedef struct scanbotsdk_vin_scanner_t	scanbotsdk_vin_scanner_t
	scanbotsdk_vin_scanner_t class

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

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

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_vin_scanner_run (scanbotsdk_vin_scanner_t self, scanbotsdk_image_t image, scanbotsdk_vin_scanner_result_t **result)
	Recognize VIN in the given image.

SBSDK_API scanbotsdk_error_code_t	scanbotsdk_vin_scanner_clean_recognition_queue (scanbotsdk_vin_scanner_t *self)
	Clean the queue of recognized VIN.

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.

Detailed Description

Typedef Documentation

◆ scanbotsdk_vin_barcode_extraction_status_t

typedef enum scanbotsdk_vin_barcode_extraction_status_t scanbotsdk_vin_barcode_extraction_status_t

scanbotsdk_vin_barcode_extraction_status_t enum

Status of the barcode extraction.

◆ scanbotsdk_vin_barcode_result_t

typedef struct scanbotsdk_vin_barcode_result_t scanbotsdk_vin_barcode_result_t

scanbotsdk_vin_barcode_result_t class

Result of the barcode scanner.

◆ scanbotsdk_vin_scanner_configuration_t

typedef struct scanbotsdk_vin_scanner_configuration_t scanbotsdk_vin_scanner_configuration_t

scanbotsdk_vin_scanner_configuration_t class

Configuration for the VIN scanner.

◆ scanbotsdk_vin_scanner_result_t

typedef struct scanbotsdk_vin_scanner_result_t scanbotsdk_vin_scanner_result_t

scanbotsdk_vin_scanner_result_t class

Result of the VIN scanner.

◆ scanbotsdk_vin_scanner_t

typedef struct scanbotsdk_vin_scanner_t scanbotsdk_vin_scanner_t

scanbotsdk_vin_scanner_t class

API for VIN scanning.

Enumeration Type Documentation

◆ scanbotsdk_vin_barcode_extraction_status_t

enum scanbotsdk_vin_barcode_extraction_status_t

scanbotsdk_vin_barcode_extraction_status_t enum

Status of the barcode extraction.

Enumerator
SCANBOTSDK_VIN_BARCODE_EXTRACTION_STATUS_SUCCESS	Barcode containing a VIN was successfully extracted.
SCANBOTSDK_VIN_BARCODE_EXTRACTION_STATUS_BARCODE_WITHOUT_VIN	Barcode was found but it does not contain a VIN.
SCANBOTSDK_VIN_BARCODE_EXTRACTION_STATUS_NO_BARCODE_FOUND	No barcode was found in the image.
SCANBOTSDK_VIN_BARCODE_EXTRACTION_STATUS_BARCODE_EXTRACTION_DISABLED	Barcode extraction is disabled in the configuration.

Function Documentation

◆ scanbotsdk_vin_barcode_extraction_status_t_to_string()

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.

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_vin_barcode_result_free()

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.

Parameters

object Pointer to the instance of scanbotsdk_vin_barcode_result_t to be freed

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

◆ scanbotsdk_vin_barcode_result_get_extracted_vin()

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.

Text result of the barcode scanner.

Parameters

self	Pointer to the instance of scanbotsdk_vin_barcode_result_t
extracted_vin	Pointer to a variable that will store the value of the field.

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

◆ scanbotsdk_vin_barcode_result_get_rectangle()

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.

Rectangle of the barcode in the image.

Parameters

self	Pointer to the instance of scanbotsdk_vin_barcode_result_t
rectangle	Pointer to a variable that will store the value of the field.

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

◆ scanbotsdk_vin_barcode_result_get_rectangle_size()

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.

Parameters

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

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

◆ scanbotsdk_vin_barcode_result_get_status()

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.

Status of the barcode extraction.

Parameters

self	Pointer to the instance of scanbotsdk_vin_barcode_result_t
status	Pointer to a variable that will store the value of the field.

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

◆ scanbotsdk_vin_scanner_clean_recognition_queue()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_clean_recognition_queue ( scanbotsdk_vin_scanner_t * self )

Clean the queue of recognized VIN.

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_vin_scanner_t method to be called on

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

◆ scanbotsdk_vin_scanner_configuration_create()

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.

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

extract_vin_from_barcode If true, the VIN scanner will also extract VINs from barcodes. Requires a license that allows barcode scanning in addition to VIN scanning.

Default is false

Parameters

ocr_resolution_limit Maximum image size (height or width) for OCR process. 0 - do not rescale.

Default is 0

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

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

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

◆ scanbotsdk_vin_scanner_configuration_create_with_defaults()

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.

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_vin_scanner_configuration_t

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

◆ scanbotsdk_vin_scanner_configuration_free()

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.

Parameters

object Pointer to the instance of scanbotsdk_vin_scanner_configuration_t to be freed

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

◆ scanbotsdk_vin_scanner_configuration_get_extract_vin_from_barcode()

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.

If true, the VIN scanner will also extract VINs from barcodes. Requires a license that allows barcode scanning in addition to VIN scanning.

Default is false

Parameters

self	Pointer to the instance of scanbotsdk_vin_scanner_configuration_t
extract_vin_from_barcode	Pointer to a variable that will store the value of the field.

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

◆ scanbotsdk_vin_scanner_configuration_get_maximum_number_of_accumulated_frames()

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.

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

Default is 3

Parameters

self	Pointer to the instance of scanbotsdk_vin_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_vin_scanner_configuration_get_minimum_number_of_required_frames_with_equal_scanning_result()

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.

Minimum number of accumulated frames that have equal result.

Default is 2

Parameters

self	Pointer to the instance of scanbotsdk_vin_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_vin_scanner_configuration_get_ocr_resolution_limit()

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.

Maximum image size (height or width) for OCR process. 0 - do not rescale.

Default is 0

Parameters

self	Pointer to the instance of scanbotsdk_vin_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.

◆ scanbotsdk_vin_scanner_configuration_set_extract_vin_from_barcode()

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.

If true, the VIN scanner will also extract VINs from barcodes. Requires a license that allows barcode scanning in addition to VIN scanning.

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_vin_scanner_configuration_t, the field of which will be set
extract_vin_from_barcode	The value to be set.

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

◆ scanbotsdk_vin_scanner_configuration_set_maximum_number_of_accumulated_frames()

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.

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_vin_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_vin_scanner_configuration_set_minimum_number_of_required_frames_with_equal_scanning_result()

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.

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_vin_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_vin_scanner_configuration_set_ocr_resolution_limit()

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.

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_vin_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

◆ scanbotsdk_vin_scanner_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_create	(	scanbotsdk_vin_scanner_configuration_t *	configuration,
		scanbotsdk_vin_scanner_t **	result )

Creates a new instance of scanbotsdk_vin_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 VIN scanner. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_vin_scanner_t

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

◆ scanbotsdk_vin_scanner_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_free ( scanbotsdk_vin_scanner_t * self )

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

Parameters

self	Pointer to the instance of scanbotsdk_vin_scanner_t to be freed

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

◆ scanbotsdk_vin_scanner_result_free()

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.

Parameters

object Pointer to the instance of scanbotsdk_vin_scanner_result_t to be freed

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

◆ scanbotsdk_vin_scanner_result_get_barcode_result()

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.

Barcode result of the VIN scanner.

Parameters

self	Pointer to the instance of scanbotsdk_vin_scanner_result_t
barcode_result	Pointer to a variable that will store the value of the field.

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

◆ scanbotsdk_vin_scanner_result_get_text_result()

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.

Text result of the VIN scanner.

Parameters

self	Pointer to the instance of scanbotsdk_vin_scanner_result_t
text_result	Pointer to a variable that will store the value of the field.

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

◆ scanbotsdk_vin_scanner_run()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_vin_scanner_run	(	scanbotsdk_vin_scanner_t *	self,
		scanbotsdk_image_t *	image,
		scanbotsdk_vin_scanner_result_t **	result )

Recognize VIN 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_vin_scanner_t method to be called on
image	The image to recognize VIN in. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_vin_scanner_t

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

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ scanbotsdk_vin_barcode_extraction_status_t

◆ scanbotsdk_vin_barcode_result_t

◆ scanbotsdk_vin_scanner_configuration_t

◆ scanbotsdk_vin_scanner_result_t

◆ scanbotsdk_vin_scanner_t

Enumeration Type Documentation

◆ scanbotsdk_vin_barcode_extraction_status_t

Function Documentation

◆ scanbotsdk_vin_barcode_extraction_status_t_to_string()

◆ scanbotsdk_vin_barcode_result_free()

◆ scanbotsdk_vin_barcode_result_get_extracted_vin()

◆ scanbotsdk_vin_barcode_result_get_rectangle()

◆ scanbotsdk_vin_barcode_result_get_rectangle_size()

◆ scanbotsdk_vin_barcode_result_get_status()

◆ scanbotsdk_vin_scanner_clean_recognition_queue()

◆ scanbotsdk_vin_scanner_configuration_create()

◆ scanbotsdk_vin_scanner_configuration_create_with_defaults()

◆ scanbotsdk_vin_scanner_configuration_free()

◆ scanbotsdk_vin_scanner_configuration_get_extract_vin_from_barcode()

◆ scanbotsdk_vin_scanner_configuration_get_maximum_number_of_accumulated_frames()

◆ scanbotsdk_vin_scanner_configuration_get_minimum_number_of_required_frames_with_equal_scanning_result()

◆ scanbotsdk_vin_scanner_configuration_get_ocr_resolution_limit()

◆ scanbotsdk_vin_scanner_configuration_set_extract_vin_from_barcode()

◆ scanbotsdk_vin_scanner_configuration_set_maximum_number_of_accumulated_frames()

◆ scanbotsdk_vin_scanner_configuration_set_minimum_number_of_required_frames_with_equal_scanning_result()

◆ scanbotsdk_vin_scanner_configuration_set_ocr_resolution_limit()

◆ scanbotsdk_vin_scanner_create()

◆ scanbotsdk_vin_scanner_free()

◆ scanbotsdk_vin_scanner_result_free()

◆ scanbotsdk_vin_scanner_result_get_barcode_result()

◆ scanbotsdk_vin_scanner_result_get_text_result()

◆ scanbotsdk_vin_scanner_run()