ScBarcodeScannerSettings.h
Go to the documentation of this file.
115 SC_CODE_DIRECTION_HORIZONTAL = SC_CODE_DIRECTION_LEFT_TO_RIGHT | SC_CODE_DIRECTION_RIGHT_TO_LEFT
355 ScBarcodeScannerSettings *sc_barcode_scanner_settings_clone(ScBarcodeScannerSettings *settings);
501 ScRectangleF sc_barcode_scanner_settings_get_search_area(ScBarcodeScannerSettings const *settings);
654 void sc_barcode_scanner_settings_get_circle_of_interest(ScBarcodeScannerSettings const *settings,
Definition: ScBarcodeScannerSettings.h:104
ScBarcodeScannerSettings * sc_barcode_scanner_settings_new_from_json(char const *json_data, ScError *error)
Create a new barcode scanner settings object from a json description.
ArUco Symbology Dictionary.
ScBool sc_barcode_scanner_settings_set_aruco_dictionary(ScBarcodeScannerSettings *settings, ScArucoDictionary const *dictionary)
Replaces the ARUCO Dictionary in the scanner settings, or adds one if none is given in the settings...
The area can be defined but will not be used by the barcode scanner.
Definition: ScBarcodeScannerSettings.h:142
Restrict decoding to the specified area.
Definition: ScBarcodeScannerSettings.h:132
ScCodeDirection sc_barcode_scanner_settings_get_code_direction_hint(ScBarcodeScannerSettings const *settings)
Get the code direction hint.
ScBarcodeScannerSettings * sc_barcode_scanner_settings_new_with_preset(ScBarcodeScannerSettingsPresetFlags preset)
Create a new barcode scanner settings object.
void sc_barcode_scanner_settings_set_circle_of_interest(ScBarcodeScannerSettings *settings, ScPointF relative_center, float relative_radius)
Sets the circle of interest.
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:84
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.
Property collection manipulation.
char * sc_barcode_scanner_settings_as_json(ScBarcodeScannerSettings const *settings)
Returns the settings contained in the object as json.
ScPropertyCollection * sc_barcode_scanner_settings_get_properties(ScBarcodeScannerSettings *settings)
Retrieves the barcode scanner settings properties handle.
int32_t sc_barcode_scanner_settings_get_code_duplicate_filter(ScBarcodeScannerSettings const *settings)
Get the code duplicate filter of the scan session.
Definition: ScBarcodeScannerSettings.h:88
Preset for hand held devices that need to scan one code at a time.
Definition: ScBarcodeScannerSettings.h:71
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.
ScCodeLocationConstraint sc_barcode_scanner_settings_get_code_location_constraint_1d(ScBarcodeScannerSettings const *settings)
Get 1d code location constraint.
An opaque data structure holding configuration options for the barcode scanner.
Handle to a collection of properties.
void sc_barcode_scanner_settings_set_search_area(ScBarcodeScannerSettings *settings, ScRectangleF scan_area)
Set the area of the image in which barcodes are searched.
ScRectangleF sc_barcode_scanner_settings_get_code_location_area_2d(ScBarcodeScannerSettings const *settings)
Get 2d code location area.
Functions for retrieving barcode information.
ScBarcodeScannerSettingsPreset
List of barcode scanner settings presets.
Definition: ScBarcodeScannerSettings.h:31
void sc_barcode_scanner_settings_set_code_location_area_2d(ScBarcodeScannerSettings *settings, ScRectangleF rect)
Set code location area for 2d codes.
ScCameraFocusMode sc_barcode_scanner_settings_get_focus_mode(ScBarcodeScannerSettings const *settings)
Get the camera's focus type.
ScRectangleF sc_barcode_scanner_settings_get_code_location_area_1d(ScBarcodeScannerSettings const *settings)
Get 1d code location area.
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:27
Definition: ScBarcodeScannerSettings.h:110
Definition: ScBarcodeScannerSettings.h:100
Definition: ScBarcodeScannerSettings.h:92
ScBarcodeScannerSettings * sc_barcode_scanner_settings_new(void)
Create a new barcode scanner settings object.
uint32_t sc_barcode_scanner_settings_get_max_number_of_codes_per_frame(ScBarcodeScannerSettings const *settings)
Get the maximum number of barcode to be decoded every frame.
void sc_barcode_scanner_settings_release(ScBarcodeScannerSettings *settings)
Decrease reference count of barcode scanner settings object by one.
ArUco symbology dictionary interface.
ScCodeLocationConstraint
Code location constraint.
Definition: ScBarcodeScannerSettings.h:126
int32_t ScBarcodeScannerSettingsPresetFlags
A bit-field of ScBarcodeScannerSettingsPreset.
Definition: ScBarcodeScannerSettings.h:77
Common definitions used throughout the ScanditSDK API.
ScSymbologySettings * sc_barcode_scanner_settings_get_symbology_settings(ScBarcodeScannerSettings *settings, ScSymbology symbology)
Retrieve symbology-specific settings.
ScPropertyCollection const * sc_barcode_scanner_settings_get_properties_const(ScBarcodeScannerSettings const *settings)
Retrieves the barcode scanner settings read-only properties handle.
Common functions and data structures.
ScCodeLocationConstraint sc_barcode_scanner_settings_get_code_location_constraint_2d(ScBarcodeScannerSettings const *settings)
Get 2d code location constraint.
Definition: ScBarcodeScannerSettings.h:115
ScRectangleF sc_barcode_scanner_settings_get_search_area(ScBarcodeScannerSettings const *settings)
Get the area of the image in which barcodes are searched.
The area indicates the most likely code position.
Definition: ScBarcodeScannerSettings.h:138
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.
void sc_barcode_scanner_settings_get_circle_of_interest(ScBarcodeScannerSettings const *settings, ScPointF *relative_center, float *relative_radius)
Returns the circle of interest.
Definition: ScBarcodeScannerSettings.h:96
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.
void sc_barcode_scanner_settings_setup_for_ui_image(ScBarcodeScannerSettings *settings, UIImage *image)
Configure barcode scanner settings for recognizing barcodes in the provided UIImage.