Enumerations | |
| enum | scanbotsdk_confirmation_method_t { SCANBOTSDK_CONFIRMATION_METHOD_EXACT = 0 , SCANBOTSDK_CONFIRMATION_METHOD_INTERPOLATE = 1 } |
| scanbotsdk_confirmation_method_t enum More... | |
Detailed Description
Typedef Documentation
◆ scanbotsdk_accumulated_results_verifier_configuration_t
| typedef struct scanbotsdk_accumulated_results_verifier_configuration_t scanbotsdk_accumulated_results_verifier_configuration_t |
scanbotsdk_accumulated_results_verifier_configuration_t class
Configure the frame accumulation process.
◆ scanbotsdk_confirmation_method_t
scanbotsdk_confirmation_method_t enum
Method used to confirm a result.
◆ scanbotsdk_result_accumulation_configuration_t
| typedef struct scanbotsdk_result_accumulation_configuration_t scanbotsdk_result_accumulation_configuration_t |
scanbotsdk_result_accumulation_configuration_t class
Configuration for how to accumulate results.
Enumeration Type Documentation
◆ scanbotsdk_confirmation_method_t
scanbotsdk_confirmation_method_t enum
Method used to confirm a result.
Function Documentation
◆ scanbotsdk_accumulated_results_verifier_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_accumulated_results_verifier_configuration_create | ( | int | maximum_number_of_accumulated_frames, |
| int | minimum_number_of_required_frames_with_equal_scanning_result, | ||
| scanbotsdk_accumulated_results_verifier_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_accumulated_results_verifier_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
-
maximum_number_of_accumulated_frames Maximum number of accumulated frames to inspect to verify a scan result.
Default is 3.
- Parameters
-
minimum_number_of_required_frames_with_equal_scanning_result Minimum number of accumulated frames that have an equal result in order for the result to be considered verified.
Default is 2.
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_accumulated_results_verifier_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_accumulated_results_verifier_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_accumulated_results_verifier_configuration_create_with_defaults | ( | scanbotsdk_accumulated_results_verifier_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_accumulated_results_verifier_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_accumulated_results_verifier_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_accumulated_results_verifier_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_accumulated_results_verifier_configuration_free | ( | scanbotsdk_accumulated_results_verifier_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_accumulated_results_verifier_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_accumulated_results_verifier_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_accumulated_results_verifier_configuration_get_maximum_number_of_accumulated_frames()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_accumulated_results_verifier_configuration_get_maximum_number_of_accumulated_frames | ( | scanbotsdk_accumulated_results_verifier_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 to verify a scan result.
Default is 3.
- Parameters
-
self Pointer to the instance of scanbotsdk_accumulated_results_verifier_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_accumulated_results_verifier_configuration_get_minimum_number_of_required_frames_with_equal_scanning_result()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_accumulated_results_verifier_configuration_get_minimum_number_of_required_frames_with_equal_scanning_result | ( | scanbotsdk_accumulated_results_verifier_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 an equal result in order for the result to be considered verified.
Default is 2.
- Parameters
-
self Pointer to the instance of scanbotsdk_accumulated_results_verifier_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_accumulated_results_verifier_configuration_set_maximum_number_of_accumulated_frames()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_accumulated_results_verifier_configuration_set_maximum_number_of_accumulated_frames | ( | scanbotsdk_accumulated_results_verifier_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 to verify a scan result.
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_accumulated_results_verifier_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_accumulated_results_verifier_configuration_set_minimum_number_of_required_frames_with_equal_scanning_result()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_accumulated_results_verifier_configuration_set_minimum_number_of_required_frames_with_equal_scanning_result | ( | scanbotsdk_accumulated_results_verifier_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 an equal result in order for the result to be considered verified.
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_accumulated_results_verifier_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_confirmation_method_t_to_string()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_confirmation_method_t_to_string | ( | scanbotsdk_confirmation_method_t | value, |
| const char ** | result ) |
Returns the string representation of the given scanbotsdk_confirmation_method_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_result_accumulation_configuration_create()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_result_accumulation_configuration_create | ( | scanbotsdk_confirmation_method_t | confirmation_method, |
| int | min_confirmations, | ||
| double | min_confidence_for_stable_field, | ||
| int | auto_clear_threshold, | ||
| scanbotsdk_result_accumulation_configuration_t ** | result ) |
Creates a new instance of scanbotsdk_result_accumulation_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
-
confirmation_method Method used to confirm a result.
Default is EXACT.
- Parameters
-
min_confirmations Number of confirmations required to consider a result confirmed (see ConfirmationMethod). Requiring more confirmations will increase the reliability of the result but also the time to gather enough confirmations. In live mode, this is the number of camera frames that must confirm a field value. In single-shot mode, this is the number of internal recognition attempts that must agree on a field value. If not enough attempts confirm a field, the status will be OK_BUT_LOW_CONFIDENCE_RESULT instead of OK.
Default is 3.
- Parameters
-
min_confidence_for_stable_field Minimum confidence required to consider a field confirmed.
Default is 0.8.
- Parameters
-
auto_clear_threshold Will auto-clear the cache if this number of frames have been a different document type or empty.
Default is 4.
- Parameters
-
result Pointer to a variable that will store the created instance of scanbotsdk_result_accumulation_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_result_accumulation_configuration_create_with_defaults()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_result_accumulation_configuration_create_with_defaults | ( | scanbotsdk_result_accumulation_configuration_t ** | result | ) |
Creates a new instance of scanbotsdk_result_accumulation_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_result_accumulation_configuration_t
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_result_accumulation_configuration_free()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_result_accumulation_configuration_free | ( | scanbotsdk_result_accumulation_configuration_t * | object | ) |
Frees the memory allocated for the instance of scanbotsdk_result_accumulation_configuration_t. If null is passed, the function does nothing.
- Parameters
-
object Pointer to the instance of scanbotsdk_result_accumulation_configuration_t to be freed
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_result_accumulation_configuration_get_auto_clear_threshold()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_result_accumulation_configuration_get_auto_clear_threshold | ( | scanbotsdk_result_accumulation_configuration_t * | self, |
| int * | auto_clear_threshold ) |
Returns value of auto_clear_threshold field of the given object.
Will auto-clear the cache if this number of frames have been a different document type or empty.
Default is 4.
- Parameters
-
self Pointer to the instance of scanbotsdk_result_accumulation_configuration_t auto_clear_threshold Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_result_accumulation_configuration_get_confirmation_method()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_result_accumulation_configuration_get_confirmation_method | ( | scanbotsdk_result_accumulation_configuration_t * | self, |
| scanbotsdk_confirmation_method_t * | confirmation_method ) |
Returns value of confirmation_method field of the given object.
Method used to confirm a result.
Default is EXACT.
- Parameters
-
self Pointer to the instance of scanbotsdk_result_accumulation_configuration_t confirmation_method Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_result_accumulation_configuration_get_min_confidence_for_stable_field()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_result_accumulation_configuration_get_min_confidence_for_stable_field | ( | scanbotsdk_result_accumulation_configuration_t * | self, |
| double * | min_confidence_for_stable_field ) |
Returns value of min_confidence_for_stable_field field of the given object.
Minimum confidence required to consider a field confirmed.
Default is 0.8.
- Parameters
-
self Pointer to the instance of scanbotsdk_result_accumulation_configuration_t min_confidence_for_stable_field Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_result_accumulation_configuration_get_min_confirmations()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_result_accumulation_configuration_get_min_confirmations | ( | scanbotsdk_result_accumulation_configuration_t * | self, |
| int * | min_confirmations ) |
Returns value of min_confirmations field of the given object.
Number of confirmations required to consider a result confirmed (see ConfirmationMethod). Requiring more confirmations will increase the reliability of the result but also the time to gather enough confirmations. In live mode, this is the number of camera frames that must confirm a field value. In single-shot mode, this is the number of internal recognition attempts that must agree on a field value. If not enough attempts confirm a field, the status will be OK_BUT_LOW_CONFIDENCE_RESULT instead of OK.
Default is 3.
- Parameters
-
self Pointer to the instance of scanbotsdk_result_accumulation_configuration_t min_confirmations Pointer to a variable that will store the value of the field.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered.
◆ scanbotsdk_result_accumulation_configuration_set_auto_clear_threshold()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_result_accumulation_configuration_set_auto_clear_threshold | ( | scanbotsdk_result_accumulation_configuration_t * | self, |
| int | auto_clear_threshold ) |
Sets value of auto_clear_threshold field of the given object.
Will auto-clear the cache if this number of frames have been a different document type or empty.
Default is 4.
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_result_accumulation_configuration_t, the field of which will be set auto_clear_threshold The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_result_accumulation_configuration_set_confirmation_method()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_result_accumulation_configuration_set_confirmation_method | ( | scanbotsdk_result_accumulation_configuration_t * | self, |
| scanbotsdk_confirmation_method_t | confirmation_method ) |
Sets value of confirmation_method field of the given object.
Method used to confirm a result.
Default is EXACT.
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_result_accumulation_configuration_t, the field of which will be set confirmation_method The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_result_accumulation_configuration_set_min_confidence_for_stable_field()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_result_accumulation_configuration_set_min_confidence_for_stable_field | ( | scanbotsdk_result_accumulation_configuration_t * | self, |
| double | min_confidence_for_stable_field ) |
Sets value of min_confidence_for_stable_field field of the given object.
Minimum confidence required to consider a field confirmed.
Default is 0.8.
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_result_accumulation_configuration_t, the field of which will be set min_confidence_for_stable_field The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
◆ scanbotsdk_result_accumulation_configuration_set_min_confirmations()
| SBSDK_API scanbotsdk_error_code_t scanbotsdk_result_accumulation_configuration_set_min_confirmations | ( | scanbotsdk_result_accumulation_configuration_t * | self, |
| int | min_confirmations ) |
Sets value of min_confirmations field of the given object.
Number of confirmations required to consider a result confirmed (see ConfirmationMethod). Requiring more confirmations will increase the reliability of the result but also the time to gather enough confirmations. In live mode, this is the number of camera frames that must confirm a field value. In single-shot mode, this is the number of internal recognition attempts that must agree on a field value. If not enough attempts confirm a field, the status will be OK_BUT_LOW_CONFIDENCE_RESULT instead of OK.
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_result_accumulation_configuration_t, the field of which will be set min_confirmations The value to be set.
- Returns
- : Error code, SCANBOTSDK_OK if no errors were encountered
Generated by
1.13.2