Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Android

ScBarcodeScannerSettings.h
Go to the documentation of this file.
1 
10 #ifndef SC_BARCODE_SCANNER_SETTINGS_H_
11 #define SC_BARCODE_SCANNER_SETTINGS_H_
12 
13 #include <Scandit/ScConfig.h>
14 #include <Scandit/ScCommon.h>
15 #include <Scandit/ScBarcode.h>
17 
18 #if defined(__cplusplus)
19 extern "C" {
20 #endif
21 
22 
28 typedef enum {
60 
62 
67 
68 
74 typedef enum {
95 
107 
116 typedef enum {
134 
236 typedef struct ScOpaqueBarcodeScannerSettings ScBarcodeScannerSettings;
239 
240 
254 
266 SC_EXPORT ScBarcodeScannerSettings *
267 sc_barcode_scanner_settings_new_with_preset(ScBarcodeScannerSettingsPresetFlags preset);
268 
288 SC_EXPORT ScBarcodeScannerSettings *
289 sc_barcode_scanner_settings_new_from_json(const char* json_data, ScError *error);
290 
299 SC_EXPORT void
301 
312 SC_EXPORT void
314 
315 
328 SC_EXPORT ScBarcodeScannerSettings*
330 
331 
355 SC_EXPORT int32_t
357  const char* key);
369 SC_EXPORT void
371  const char* key, int32_t value);
372 
408 SC_EXPORT void
410  ScSymbology symbology, ScBool enabled);
425 SC_EXPORT ScSymbologySettings *
427  ScSymbology symbology);
428 
446 SC_EXPORT uint32_t
448 
459 SC_EXPORT void
461  uint32_t max_codes);
462 
484 SC_EXPORT ScRectangleF
486 
498 SC_EXPORT void
500  ScRectangleF scan_area);
501 
518 SC_EXPORT ScRectangleF
520 
530 SC_EXPORT void
532  ScRectangleF rect);
533 
543 SC_EXPORT ScCodeLocationConstraint
545 
555 SC_EXPORT void
557  ScCodeLocationConstraint constraint);
558 
568 SC_EXPORT ScRectangleF
570 
580 SC_EXPORT void
582  ScRectangleF rect);
583 
593 SC_EXPORT ScCodeLocationConstraint
595 
605 SC_EXPORT void
607  ScCodeLocationConstraint constraint);
608 
625 SC_EXPORT ScCameraFocusMode
627 
637 SC_EXPORT void
639  ScCameraFocusMode focus_mode);
640 
658 SC_EXPORT ScCodeDirection
660 
680 SC_EXPORT void
682  ScCodeDirection direction);
683 
684 
716 SC_EXPORT int32_t
718 
732 SC_EXPORT void
734  int32_t filter);
735 
753 SC_EXPORT int32_t
755 
768 SC_EXPORT void
770  int32_t duration);
771 
785 SC_EXPORT char*
787 
788 
789 
790 #if (SC_PLATFORM_IOS && defined(__OBJC__) && __OBJC__) || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
791 
792 #include <UIKit/UIKit.h>
807 SC_EXPORT void
809 
810 #endif
811 
812 #if defined(__cplusplus)
813 }
814 #endif
815 
816 
817 #endif //SC_BARCODE_SCANNER_SETTINGS_H_
818 
819 
Definition: ScBarcodeScannerSettings.h:94
uint32_t sc_barcode_scanner_settings_get_max_number_of_codes_per_frame(const ScBarcodeScannerSettings *settings)
Get the maximum number of barcode to be decoded every frame.
The area can be defined but will not be used by the barcode scanner.
Definition: ScBarcodeScannerSettings.h:132
Restrict decoding to the specified area.
Definition: ScBarcodeScannerSettings.h:122
int32_t sc_barcode_scanner_settings_get_property(const ScBarcodeScannerSettings *settings, const char *key)
Get custom properties.
ScBarcodeScannerSettings * sc_barcode_scanner_settings_new_with_preset(ScBarcodeScannerSettingsPresetFlags preset)
Create a new barcode scanner settings object.
ScRectangleF sc_barcode_scanner_settings_get_code_location_area_2d(const ScBarcodeScannerSettings *settings)
Get 2d code location area.
Preset to enable decoding of all retail symbologies.
Definition: ScBarcodeScannerSettings.h:39
ScBarcodeScannerSettings * sc_barcode_scanner_settings_clone(ScBarcodeScannerSettings *settings)
Creates and returns a deep copy of the barcode scanner settings object.
ScCodeDirection
Enum for different code directions.
Definition: ScBarcodeScannerSettings.h:74
void sc_barcode_scanner_settings_set_code_caching_duration(ScBarcodeScannerSettings *settings, int32_t duration)
Determines how long codes are kept in the session.
void sc_barcode_scanner_settings_set_code_direction_hint(ScBarcodeScannerSettings *settings, ScCodeDirection direction)
Set the code direction hint.
void sc_barcode_scanner_settings_set_code_duplicate_filter(ScBarcodeScannerSettings *settings, int32_t filter)
Specifies the duplicate filter to use for the session.
void sc_barcode_scanner_settings_set_code_location_constraint_2d(ScBarcodeScannerSettings *settings, ScCodeLocationConstraint constraint)
Set the 2d code location constraint.
Definition: ScBarcodeScannerSettings.h:78
void sc_barcode_scanner_settings_set_focus_mode(ScBarcodeScannerSettings *settings, ScCameraFocusMode focus_mode)
Set the camera's focus type.
void sc_barcode_scanner_settings_set_code_location_area_1d(ScBarcodeScannerSettings *settings, ScRectangleF rect)
Set code location area for 1d codes.
void sc_barcode_scanner_settings_retain(ScBarcodeScannerSettings *settings)
Increase reference count of barcode scanner settings.
void sc_barcode_scanner_settings_set_property(ScBarcodeScannerSettings *settings, const char *key, int32_t value)
Set custom properties.
An opaque data structure holding configuration options for the barcode scanner.
void sc_barcode_scanner_settings_set_search_area(ScBarcodeScannerSettings *settings, ScRectangleF scan_area)
Set the area of the image in which barcodes are searched.
char * sc_barcode_scanner_settings_as_json(const ScBarcodeScannerSettings *settings)
Returns the settings contained in the object as json.
Functions for retrieving barcode information.
ScBarcodeScannerSettingsPreset
List of barcode scanner settings presets.
Definition: ScBarcodeScannerSettings.h:28
ScRectangleF sc_barcode_scanner_settings_get_code_location_area_1d(const ScBarcodeScannerSettings *settings)
Get 1d code location area.
void sc_barcode_scanner_settings_set_code_location_area_2d(ScBarcodeScannerSettings *settings, ScRectangleF rect)
Set code location area for 2d codes.
void sc_barcode_scanner_settings_set_code_location_constraint_1d(ScBarcodeScannerSettings *settings, ScCodeLocationConstraint constraint)
Set the 1d code location constraint.
ScSymbology
Enumeration of all supported 1d and 2d barcode symbologies.
Definition: ScBarcode.h:29
ScCodeDirection sc_barcode_scanner_settings_get_code_direction_hint(const ScBarcodeScannerSettings *settings)
Get the code direction hint.
Definition: ScBarcodeScannerSettings.h:100
Definition: ScBarcodeScannerSettings.h:90
Definition: ScBarcodeScannerSettings.h:82
ScBarcodeScannerSettings * sc_barcode_scanner_settings_new(void)
Create a new barcode scanner settings object.
ScCameraFocusMode sc_barcode_scanner_settings_get_focus_mode(const ScBarcodeScannerSettings *settings)
Get the camera's focus type.
void sc_barcode_scanner_settings_release(ScBarcodeScannerSettings *settings)
Decrease reference count of barcode scanner settings object by one.
Preset to enable decoding SSCC18 codes.
Definition: ScBarcodeScannerSettings.h:51
Structure for holding error information.
Definition: ScCommon.h:226
ScCodeLocationConstraint
Code location constraint.
Definition: ScBarcodeScannerSettings.h:116
int32_t sc_barcode_scanner_settings_get_code_caching_duration(const ScBarcodeScannerSettings *settings)
Get the code caching duration of the scan session.
int32_t ScBarcodeScannerSettingsPresetFlags
A bit-field of ScBarcodeScannerSettingsPreset.
Definition: ScBarcodeScannerSettings.h:66
ScCodeLocationConstraint sc_barcode_scanner_settings_get_code_location_constraint_1d(const ScBarcodeScannerSettings *settings)
Get 1d code location constraint.
Preset to enable decoding VIN codes.
Definition: ScBarcodeScannerSettings.h:45
Common definitions used throughout the ScanditSDK API.
ScSymbologySettings * sc_barcode_scanner_settings_get_symbology_settings(ScBarcodeScannerSettings *settings, ScSymbology symbology)
Retrieve symbology-specific settings.
Preset that switches the scanner from real-time video stream processing to a single frame mode...
Definition: ScBarcodeScannerSettings.h:59
Common functions and data structures.
ScBarcodeScannerSettings * sc_barcode_scanner_settings_new_from_json(const char *json_data, ScError *error)
Create a new barcode scanner settings object from a json description.
Definition: ScBarcodeScannerSettings.h:105
ScRectangleF sc_barcode_scanner_settings_get_search_area(const ScBarcodeScannerSettings *settings)
Get the area of the image in which barcodes are searched.
A 2-dimensional rectangle with floating point precision.
Definition: ScCommon.h:163
The area indicates the most likely code position.
Definition: ScBarcodeScannerSettings.h:128
ScCameraFocusMode
Describes the focus mode of a camera.
Definition: ScCommon.h:206
Contains symbology-specific settings.
Barcode symbology configuration.
void sc_barcode_scanner_settings_set_symbology_enabled(ScBarcodeScannerSettings *settings, ScSymbology symbology, ScBool enabled)
Enable/disable decoding of a certain symbology.
Definition: ScBarcodeScannerSettings.h:86
void sc_barcode_scanner_settings_set_max_number_of_codes_per_frame(ScBarcodeScannerSettings *settings, uint32_t max_codes)
Set the maximum number of barcode to be decoded every frame.
int32_t sc_barcode_scanner_settings_get_code_duplicate_filter(const ScBarcodeScannerSettings *settings)
Get the code duplicate filter of the scan session.
Preset with all symbologies disabled.
Definition: ScBarcodeScannerSettings.h:32
void sc_barcode_scanner_settings_setup_for_ui_image(ScBarcodeScannerSettings *settings, UIImage *image)
Configure barcode scanner settings for recognizing barcodes in the provided UIImage.
ScCodeLocationConstraint sc_barcode_scanner_settings_get_code_location_constraint_2d(const ScBarcodeScannerSettings *settings)
Get 2d code location constraint.
int32_t ScBool
Boolean value, can be SC_TRUE or SC_FALSE.
Definition: ScConfig.h:127