ScBarcodeScannerSettings.h
Go to the documentation of this file.
105 SC_CODE_DIRECTION_HORIZONTAL = SC_CODE_DIRECTION_LEFT_TO_RIGHT | SC_CODE_DIRECTION_RIGHT_TO_LEFT
447 sc_barcode_scanner_settings_get_max_number_of_codes_per_frame(const ScBarcodeScannerSettings *settings);
460 sc_barcode_scanner_settings_set_max_number_of_codes_per_frame(ScBarcodeScannerSettings *settings,
519 sc_barcode_scanner_settings_get_code_location_area_1d(const ScBarcodeScannerSettings *settings);
544 sc_barcode_scanner_settings_get_code_location_constraint_1d(const ScBarcodeScannerSettings *settings);
569 sc_barcode_scanner_settings_get_code_location_area_2d(const ScBarcodeScannerSettings *settings);
594 sc_barcode_scanner_settings_get_code_location_constraint_2d(const ScBarcodeScannerSettings *settings);
717 sc_barcode_scanner_settings_get_code_duplicate_filter(const ScBarcodeScannerSettings *settings);
754 sc_barcode_scanner_settings_get_code_caching_duration(const ScBarcodeScannerSettings *settings);
790 #if (SC_PLATFORM_IOS && defined(__OBJC__) && __OBJC__) || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
808 sc_barcode_scanner_settings_setup_for_ui_image(ScBarcodeScannerSettings *settings, UIImage *image);
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
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.
The area indicates the most likely code position.
Definition: ScBarcodeScannerSettings.h:128
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.
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.