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 {
53 
58 
59 
65 typedef enum {
86 
98 
107 typedef enum {
121 
196 typedef struct ScOpaqueBarcodeScannerSettings ScBarcodeScannerSettings;
199 
200 
214 
226 SC_EXPORT ScBarcodeScannerSettings *
227 sc_barcode_scanner_settings_new_with_preset(ScBarcodeScannerSettingsPresetFlags preset);
228 
229 
249 SC_EXPORT ScBarcodeScannerSettings *
250 sc_barcode_scanner_settings_new_from_json(const char* json_data, ScError *error);
251 
260 SC_EXPORT void
262 
273 SC_EXPORT void
275 
276 
289 SC_EXPORT ScBarcodeScannerSettings*
291 
292 
316 SC_EXPORT int32_t
318  const char* key);
330 SC_EXPORT void
332  const char* key, int32_t value);
333 
369 SC_EXPORT void
371  ScSymbology symbology, ScBool enabled);
386 SC_EXPORT ScSymbologySettings *
388  ScSymbology symbology);
389 
407 SC_EXPORT uint32_t
409 
420 SC_EXPORT void
422  uint32_t max_codes);
423 
445 SC_EXPORT ScRectangleF
447 
459 SC_EXPORT void
461  ScRectangleF scan_area);
462 
479 SC_EXPORT ScRectangleF
481 
491 SC_EXPORT void
493  ScRectangleF rect);
494 
504 SC_EXPORT ScCodeLocationConstraint
506 
516 SC_EXPORT void
518  ScCodeLocationConstraint constraint);
519 
529 SC_EXPORT ScRectangleF
531 
541 SC_EXPORT void
543  ScRectangleF rect);
544 
554 SC_EXPORT ScCodeLocationConstraint
556 
566 SC_EXPORT void
568  ScCodeLocationConstraint constraint);
569 
586 SC_EXPORT ScCameraFocusMode
588 
598 SC_EXPORT void
600  ScCameraFocusMode focus_mode);
601 
619 SC_EXPORT ScCodeDirection
621 
641 SC_EXPORT void
643  ScCodeDirection direction);
644 
645 
673 SC_EXPORT int32_t
675 
687 SC_EXPORT void
689  int32_t filter);
690 
708 SC_EXPORT int32_t
710 
721 SC_EXPORT void
723  int32_t duration);
724 
738 SC_EXPORT char*
740 
741 
742 
743 #if (SC_PLATFORM_IOS && defined(__OBJC__) && __OBJC__) || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
744 
745 #include <UIKit/UIKit.h>
760 SC_EXPORT void
762 
763 #endif
764 
765 #if defined(__cplusplus)
766 }
767 #endif
768 
769 
770 #endif //SC_BARCODE_SCANNER_SETTINGS_H_
771 
772 
Definition: ScBarcodeScannerSettings.h:85
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.
Restrict decoding to the specified area.
Definition: ScBarcodeScannerSettings.h:113
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:65
void sc_barcode_scanner_settings_set_code_caching_duration(ScBarcodeScannerSettings *settings, int32_t duration)
Determines how long codes are kept in the session.
ScBarcodeScannerSettings * sc_barcode_scanner_settings_new()
Create a new barcode scanner settings object.
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:69
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:91
Definition: ScBarcodeScannerSettings.h:81
Definition: ScBarcodeScannerSettings.h:73
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:227
ScCodeLocationConstraint
Code location constraint.
Definition: ScBarcodeScannerSettings.h:107
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:57
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.
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:96
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:161
The area indicates the most likely code position.
Definition: ScBarcodeScannerSettings.h:119
ScCameraFocusMode
Describes the focus mode of a camera.
Definition: ScCommon.h:207
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:77
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:123