ScBarcodeScannerSettings.h

Go to the documentation of this file.

#ifndef SC_BARCODE_SCANNER_SETTINGS_H_
#define SC_BARCODE_SCANNER_SETTINGS_H_

#include <Scandit/ScConfig.h>
#include <Scandit/ScCommon.h>
#include <Scandit/ScBarcode.h>
#include <Scandit/ScPropertyCollection.h>
#include <Scandit/ScSymbologySettings.h>
#include <Scandit/ScArucoDictionary.h>

SC_EXTERN_C_BEGIN

typedef enum {
    SC_PRESET_NONE = 0x00,
    SC_PRESET_HIGH_EFFORT = 0x02,
    SC_PRESET_SINGLE_CODE_HAND_HELD = 0x08
} ScBarcodeScannerSettingsPreset;

typedef int32_t ScBarcodeScannerSettingsPresetFlags;

typedef enum {
    SC_CODE_DIRECTION_NONE = 0x00,
    SC_CODE_DIRECTION_LEFT_TO_RIGHT = 0x01,
    SC_CODE_DIRECTION_RIGHT_TO_LEFT = 0x02,
    SC_CODE_DIRECTION_TOP_TO_BOTTOM = 0x04,
    SC_CODE_DIRECTION_BOTTOM_TO_TOP = 0x08,

    SC_CODE_DIRECTION_VERTICAL = SC_CODE_DIRECTION_TOP_TO_BOTTOM | SC_CODE_DIRECTION_BOTTOM_TO_TOP,
    SC_CODE_DIRECTION_HORIZONTAL = SC_CODE_DIRECTION_LEFT_TO_RIGHT | SC_CODE_DIRECTION_RIGHT_TO_LEFT
} ScCodeDirection;

typedef enum {
    SC_CODE_LOCATION_RESTRICT = 0x01,
    SC_CODE_LOCATION_HINT = 0x02,
    SC_CODE_LOCATION_IGNORE = 0x03
} ScCodeLocationConstraint;

typedef struct ScOpaqueBarcodeScannerSettings ScBarcodeScannerSettings;

SC_EXPORT
ScBarcodeScannerSettings *sc_barcode_scanner_settings_new(void);

SC_EXPORT
ScBarcodeScannerSettings *sc_barcode_scanner_settings_new_with_preset(
        ScBarcodeScannerSettingsPresetFlags preset);

SC_EXPORT
ScBarcodeScannerSettings *sc_barcode_scanner_settings_new_from_json(char const *json_data,
                                                                    ScError *error);

SC_EXPORT
void sc_barcode_scanner_settings_retain(ScBarcodeScannerSettings *settings);

SC_EXPORT
void sc_barcode_scanner_settings_release(ScBarcodeScannerSettings *settings);

SC_EXPORT
ScBarcodeScannerSettings *sc_barcode_scanner_settings_clone(ScBarcodeScannerSettings *settings);

SC_EXPORT
ScPropertyCollection const *sc_barcode_scanner_settings_get_properties_const(
        ScBarcodeScannerSettings const *settings);

SC_EXPORT
ScPropertyCollection *sc_barcode_scanner_settings_get_properties(
        ScBarcodeScannerSettings *settings);

SC_EXPORT
void sc_barcode_scanner_settings_set_symbology_enabled(ScBarcodeScannerSettings *settings,
                                                       ScSymbology symbology,
                                                       ScBool enabled);
SC_EXPORT
ScSymbologySettings *sc_barcode_scanner_settings_get_symbology_settings(
        ScBarcodeScannerSettings *settings, ScSymbology symbology);

SC_EXPORT
uint32_t sc_barcode_scanner_settings_get_max_number_of_codes_per_frame(
        ScBarcodeScannerSettings const *settings);

SC_EXPORT
void sc_barcode_scanner_settings_set_max_number_of_codes_per_frame(
        ScBarcodeScannerSettings *settings, uint32_t max_codes);

SC_EXPORT
ScRectangleF sc_barcode_scanner_settings_get_search_area(ScBarcodeScannerSettings const *settings);

SC_EXPORT
void sc_barcode_scanner_settings_set_search_area(ScBarcodeScannerSettings *settings,
                                                 ScRectangleF scan_area);

SC_EXPORT
ScRectangleF sc_barcode_scanner_settings_get_code_location_area_1d(
        ScBarcodeScannerSettings const *settings);

SC_EXPORT
void sc_barcode_scanner_settings_set_code_location_area_1d(ScBarcodeScannerSettings *settings,
                                                           ScRectangleF rect);

SC_EXPORT
ScCodeLocationConstraint sc_barcode_scanner_settings_get_code_location_constraint_1d(
        ScBarcodeScannerSettings const *settings);

SC_EXPORT
void sc_barcode_scanner_settings_set_code_location_constraint_1d(
        ScBarcodeScannerSettings *settings, ScCodeLocationConstraint constraint);

SC_EXPORT
ScRectangleF sc_barcode_scanner_settings_get_code_location_area_2d(
        ScBarcodeScannerSettings const *settings);

SC_EXPORT
void sc_barcode_scanner_settings_set_code_location_area_2d(ScBarcodeScannerSettings *settings,
                                                           ScRectangleF rect);

SC_EXPORT
ScCodeLocationConstraint sc_barcode_scanner_settings_get_code_location_constraint_2d(
        ScBarcodeScannerSettings const *settings);

SC_EXPORT
void sc_barcode_scanner_settings_set_code_location_constraint_2d(
        ScBarcodeScannerSettings *settings, ScCodeLocationConstraint constraint);

#define SC_CIRCLE_RADIUS_INFINITE -1.0f

SC_EXPORT
void sc_barcode_scanner_settings_get_circle_of_interest(ScBarcodeScannerSettings const *settings,
                                                        ScPointF *relative_center,
                                                        float *relative_radius);

SC_EXPORT
void sc_barcode_scanner_settings_set_circle_of_interest(ScBarcodeScannerSettings *settings,
                                                        ScPointF relative_center,
                                                        float relative_radius);

SC_EXPORT
SC_DEPRECATED("function was removed without replacement in 7.6.0.")
ScCameraFocusMode sc_barcode_scanner_settings_get_focus_mode(
        ScBarcodeScannerSettings const *settings);

SC_EXPORT
SC_DEPRECATED(
        "Deprecated in 7.6.0. Set the code direction hint to `SC_CODE_DIRECTION_NONE` for devices "
        "without auto-focus.")
void sc_barcode_scanner_settings_set_focus_mode(ScBarcodeScannerSettings *settings,
                                                ScCameraFocusMode focus_mode);

SC_EXPORT
ScCodeDirection sc_barcode_scanner_settings_get_code_direction_hint(
        ScBarcodeScannerSettings const *settings);

SC_EXPORT
void sc_barcode_scanner_settings_set_code_direction_hint(ScBarcodeScannerSettings *settings,
                                                         ScCodeDirection direction);

#define SC_DUPLICATE_FILTER_OFF (0)

#define SC_DUPLICATE_FILTER_INFINITE (-1)

SC_EXPORT
int32_t sc_barcode_scanner_settings_get_code_duplicate_filter(
        ScBarcodeScannerSettings const *settings);

SC_EXPORT
void sc_barcode_scanner_settings_set_code_duplicate_filter(ScBarcodeScannerSettings *settings,
                                                           int32_t filter);

SC_EXPORT
char *sc_barcode_scanner_settings_as_json(ScBarcodeScannerSettings const *settings);

SC_EXPORT
ScBool sc_barcode_scanner_settings_set_aruco_dictionary(ScBarcodeScannerSettings *settings,
                                                        ScArucoDictionary const *dictionary);

SC_EXTERN_C_END

#endif // SC_BARCODE_SCANNER_SETTINGS_H_