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

Go to the source code of this file.

Typedefs

typedef struct scanbotsdk_barcode_item_t scanbotsdk_barcode_item_t
 scanbotsdk_barcode_item_t class
 
typedef enum scanbotsdk_barcode_scanner_engine_mode_t scanbotsdk_barcode_scanner_engine_mode_t
 scanbotsdk_barcode_scanner_engine_mode_t enum
 
typedef enum scanbotsdk_barcode_accumulation_method_t scanbotsdk_barcode_accumulation_method_t
 scanbotsdk_barcode_accumulation_method_t enum
 
typedef struct scanbotsdk_barcode_accumulation_configuration_t scanbotsdk_barcode_accumulation_configuration_t
 scanbotsdk_barcode_accumulation_configuration_t class
 
typedef struct scanbotsdk_barcode_scanner_configuration_t scanbotsdk_barcode_scanner_configuration_t
 scanbotsdk_barcode_scanner_configuration_t class
 
typedef struct scanbotsdk_barcode_scanner_result_t scanbotsdk_barcode_scanner_result_t
 scanbotsdk_barcode_scanner_result_t class
 

Enumerations

enum  scanbotsdk_barcode_scanner_engine_mode_t {
  SCANBOTSDK_BARCODE_SCANNER_ENGINE_MODE_LEGACY = 0 ,
  SCANBOTSDK_BARCODE_SCANNER_ENGINE_MODE_NEXT_GEN_LOW_POWER = 1 ,
  SCANBOTSDK_BARCODE_SCANNER_ENGINE_MODE_NEXT_GEN = 2 ,
  SCANBOTSDK_BARCODE_SCANNER_ENGINE_MODE_NEXT_GEN_LOW_POWER_FAR_DISTANCE = 3 ,
  SCANBOTSDK_BARCODE_SCANNER_ENGINE_MODE_NEXT_GEN_FAR_DISTANCE = 4 ,
  SCANBOTSDK_BARCODE_SCANNER_ENGINE_MODE_NEXT_GEN_MAX_DISTANCE = 5
}
 scanbotsdk_barcode_scanner_engine_mode_t enum More...
 
enum  scanbotsdk_barcode_accumulation_method_t {
  SCANBOTSDK_BARCODE_ACCUMULATION_METHOD_LAST_VISIBLE = 0 ,
  SCANBOTSDK_BARCODE_ACCUMULATION_METHOD_INTERPOLATE_BY_CAMERA = 1
}
 scanbotsdk_barcode_accumulation_method_t enum More...
 

Functions

SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_free (scanbotsdk_barcode_item_t *object)
 Frees the memory allocated for the instance of scanbotsdk_barcode_item_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_format (scanbotsdk_barcode_item_t *self, scanbotsdk_barcode_format_t *format)
 Returns value of format field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_text (scanbotsdk_barcode_item_t *self, const char **text)
 Returns value of text 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_barcode_item_get_raw_bytes (scanbotsdk_barcode_item_t *self, uint8_t **raw_bytes)
 Returns value of raw_bytes field of the given object. The returned value is direct view into memory, no pre-allocations needed.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_raw_bytes_size (scanbotsdk_barcode_item_t *self, size_t *size)
 Returns size of raw_bytes array.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_raw_bytes_encodings (scanbotsdk_barcode_item_t *self, scanbotsdk_range_encoding_t **raw_bytes_encodings, size_t size)
 Returns value of raw_bytes_encodings 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_barcode_item_get_raw_bytes_encodings_size (scanbotsdk_barcode_item_t *self, size_t *size)
 Returns size of raw_bytes_encodings array.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_structured_append_info (scanbotsdk_barcode_item_t *self, scanbotsdk_structured_append_info_t **structured_append_info)
 Returns value of structured_append_info 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_barcode_item_get_quad (scanbotsdk_barcode_item_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_barcode_item_get_quad_size (scanbotsdk_barcode_item_t *self, size_t *size)
 Returns size of quad array.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_quad_normalized (scanbotsdk_barcode_item_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_barcode_item_get_quad_normalized_size (scanbotsdk_barcode_item_t *self, size_t *size)
 Returns size of quad_normalized array.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_extended_quad (scanbotsdk_barcode_item_t *self, scanbotsdk_point_t **extended_quad)
 Returns value of extended_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_barcode_item_get_extended_quad_size (scanbotsdk_barcode_item_t *self, size_t *size)
 Returns size of extended_quad array.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_extended_quad_normalized (scanbotsdk_barcode_item_t *self, scanbotsdk_pointf_t **extended_quad_normalized)
 Returns value of extended_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_barcode_item_get_extended_quad_normalized_size (scanbotsdk_barcode_item_t *self, size_t *size)
 Returns size of extended_quad_normalized array.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_is_upside_down (scanbotsdk_barcode_item_t *self, bool *is_upside_down)
 Returns value of is_upside_down field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_source_image (scanbotsdk_barcode_item_t *self, scanbotsdk_image_t **source_image)
 Returns value of source_image 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_barcode_item_get_upc_ean_extension (scanbotsdk_barcode_item_t *self, const char **upc_ean_extension)
 Returns value of upc_ean_extension 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_barcode_item_get_is_gs_1_message (scanbotsdk_barcode_item_t *self, bool *is_gs_1_message)
 Returns value of is_gs_1_message field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_is_gs_1_composite_part (scanbotsdk_barcode_item_t *self, bool *is_gs_1_composite_part)
 Returns value of is_gs_1_composite_part field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_data_bar_stack_size (scanbotsdk_barcode_item_t *self, int *data_bar_stack_size)
 Returns value of data_bar_stack_size field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_size_score (scanbotsdk_barcode_item_t *self, double *size_score)
 Returns value of size_score field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_item_get_extracted_document (scanbotsdk_barcode_item_t *self, scanbotsdk_generic_document_t **extracted_document)
 Returns value of extracted_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_barcode_item_get_global_index (scanbotsdk_barcode_item_t *self, int *global_index)
 Returns value of global_index field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_engine_mode_t_to_string (scanbotsdk_barcode_scanner_engine_mode_t value, const char **result)
 Returns the string representation of the given scanbotsdk_barcode_scanner_engine_mode_t value.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_method_t_to_string (scanbotsdk_barcode_accumulation_method_t value, const char **result)
 Returns the string representation of the given scanbotsdk_barcode_accumulation_method_t value.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_create (int accumulation_time, bool remove_unconnected_results, scanbotsdk_barcode_accumulation_method_t method, scanbotsdk_barcode_accumulation_configuration_t **result)
 Creates a new instance of scanbotsdk_barcode_accumulation_configuration with given params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_create_with_defaults (scanbotsdk_barcode_accumulation_configuration_t **result)
 Creates a new instance of scanbotsdk_barcode_accumulation_configuration_t with given required params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_free (scanbotsdk_barcode_accumulation_configuration_t *object)
 Frees the memory allocated for the instance of scanbotsdk_barcode_accumulation_configuration_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_get_accumulation_time (scanbotsdk_barcode_accumulation_configuration_t *self, int *accumulation_time)
 Returns value of accumulation_time field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_set_accumulation_time (scanbotsdk_barcode_accumulation_configuration_t *self, int accumulation_time)
 Sets value of accumulation_time field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_get_remove_unconnected_results (scanbotsdk_barcode_accumulation_configuration_t *self, bool *remove_unconnected_results)
 Returns value of remove_unconnected_results field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_set_remove_unconnected_results (scanbotsdk_barcode_accumulation_configuration_t *self, bool remove_unconnected_results)
 Sets value of remove_unconnected_results field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_get_method (scanbotsdk_barcode_accumulation_configuration_t *self, scanbotsdk_barcode_accumulation_method_t *method)
 Returns value of method field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_accumulation_configuration_set_method (scanbotsdk_barcode_accumulation_configuration_t *self, scanbotsdk_barcode_accumulation_method_t method)
 Sets value of method field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_create (scanbotsdk_barcode_format_configuration_base_t **barcode_format_configurations, size_t barcode_format_configurations_size, scanbotsdk_barcode_document_format_t *extracted_document_formats, size_t extracted_document_formats_size, bool only_accept_documents, bool return_barcode_image, scanbotsdk_accelerator_t *accelerator, scanbotsdk_barcode_scanner_engine_mode_t engine_mode, scanbotsdk_barcode_accumulation_configuration_t *accumulation_config, bool optimized_for_overlays, scanbotsdk_processing_mode_t processing_mode, scanbotsdk_barcode_scanner_configuration_t **result)
 Creates a new instance of scanbotsdk_barcode_scanner_configuration with given params and stores it in the location specified by the last argument.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_create_with_defaults (scanbotsdk_barcode_scanner_configuration_t **result)
 Creates a new instance of scanbotsdk_barcode_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_barcode_scanner_configuration_free (scanbotsdk_barcode_scanner_configuration_t *object)
 Frees the memory allocated for the instance of scanbotsdk_barcode_scanner_configuration_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_barcode_format_configurations (scanbotsdk_barcode_scanner_configuration_t *self, scanbotsdk_barcode_format_configuration_base_t **barcode_format_configurations, size_t size)
 Returns value of barcode_format_configurations 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_barcode_scanner_configuration_get_barcode_format_configurations_size (scanbotsdk_barcode_scanner_configuration_t *self, size_t *size)
 Returns size of barcode_format_configurations array.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_barcode_format_configurations (scanbotsdk_barcode_scanner_configuration_t *self, scanbotsdk_barcode_format_configuration_base_t **barcode_format_configurations, size_t barcode_format_configurations_size)
 Sets value of barcode_format_configurations field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_extracted_document_formats (scanbotsdk_barcode_scanner_configuration_t *self, scanbotsdk_barcode_document_format_t **extracted_document_formats)
 Returns value of extracted_document_formats field of the given object. The returned value is direct view into memory, no pre-allocations needed.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_extracted_document_formats_size (scanbotsdk_barcode_scanner_configuration_t *self, size_t *size)
 Returns size of extracted_document_formats array.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_extracted_document_formats (scanbotsdk_barcode_scanner_configuration_t *self, scanbotsdk_barcode_document_format_t *extracted_document_formats, size_t extracted_document_formats_size)
 Sets value of extracted_document_formats field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_only_accept_documents (scanbotsdk_barcode_scanner_configuration_t *self, bool *only_accept_documents)
 Returns value of only_accept_documents field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_only_accept_documents (scanbotsdk_barcode_scanner_configuration_t *self, bool only_accept_documents)
 Sets value of only_accept_documents field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_return_barcode_image (scanbotsdk_barcode_scanner_configuration_t *self, bool *return_barcode_image)
 Returns value of return_barcode_image field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_return_barcode_image (scanbotsdk_barcode_scanner_configuration_t *self, bool return_barcode_image)
 Sets value of return_barcode_image field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_accelerator (scanbotsdk_barcode_scanner_configuration_t *self, scanbotsdk_accelerator_t **accelerator)
 Returns value of accelerator 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_barcode_scanner_configuration_set_accelerator (scanbotsdk_barcode_scanner_configuration_t *self, scanbotsdk_accelerator_t *accelerator)
 Sets value of accelerator field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_engine_mode (scanbotsdk_barcode_scanner_configuration_t *self, scanbotsdk_barcode_scanner_engine_mode_t *engine_mode)
 Returns value of engine_mode field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_engine_mode (scanbotsdk_barcode_scanner_configuration_t *self, scanbotsdk_barcode_scanner_engine_mode_t engine_mode)
 Sets value of engine_mode field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_accumulation_config (scanbotsdk_barcode_scanner_configuration_t *self, scanbotsdk_barcode_accumulation_configuration_t **accumulation_config)
 Returns value of 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_barcode_scanner_configuration_set_accumulation_config (scanbotsdk_barcode_scanner_configuration_t *self, scanbotsdk_barcode_accumulation_configuration_t *accumulation_config)
 Sets value of accumulation_config field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_optimized_for_overlays (scanbotsdk_barcode_scanner_configuration_t *self, bool *optimized_for_overlays)
 Returns value of optimized_for_overlays field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_set_optimized_for_overlays (scanbotsdk_barcode_scanner_configuration_t *self, bool optimized_for_overlays)
 Sets value of optimized_for_overlays field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_configuration_get_processing_mode (scanbotsdk_barcode_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_barcode_scanner_configuration_set_processing_mode (scanbotsdk_barcode_scanner_configuration_t *self, scanbotsdk_processing_mode_t processing_mode)
 Sets value of processing_mode field of the given object.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_result_free (scanbotsdk_barcode_scanner_result_t *object)
 Frees the memory allocated for the instance of scanbotsdk_barcode_scanner_result_t. If null is passed, the function does nothing.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_result_get_barcodes (scanbotsdk_barcode_scanner_result_t *self, scanbotsdk_barcode_item_t **barcodes, size_t size)
 Returns value of barcodes 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_barcode_scanner_result_get_barcodes_size (scanbotsdk_barcode_scanner_result_t *self, size_t *size)
 Returns size of barcodes array.
 
SBSDK_API scanbotsdk_error_code_t scanbotsdk_barcode_scanner_result_get_success (scanbotsdk_barcode_scanner_result_t *self, bool *success)
 Returns value of success field of the given object.