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/ScSymbologySettings.h>
#include <Scandit/ScArucoDictionary.h>

#if defined(__cplusplus)
extern "C" {
#endif


typedef enum  {
    SC_PRESET_NONE = 0x00,
    SC_PRESET_ENABLE_RETAIL_SYMBOLOGIES = 0x01,
    SC_PRESET_ENABLE_VIN_DECODING = 0x02,
    SC_PRESET_ENABLE_SSCC_DECODING = 0x04,
    SC_PRESET_ENABLE_SINGLE_FRAME_MODE = 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(const char* 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 int32_t
sc_barcode_scanner_settings_get_property(const ScBarcodeScannerSettings *settings,
                                         const char* key);
SC_EXPORT void
sc_barcode_scanner_settings_set_property(ScBarcodeScannerSettings *settings,
                                         const char* key, int32_t value);

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(const ScBarcodeScannerSettings *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(const ScBarcodeScannerSettings *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(const ScBarcodeScannerSettings *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(const ScBarcodeScannerSettings *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(const ScBarcodeScannerSettings *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(const ScBarcodeScannerSettings *settings);

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

SC_EXPORT void sc_barcode_scanner_settings_get_circle_of_interest(
        const ScBarcodeScannerSettings *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 ScCameraFocusMode
sc_barcode_scanner_settings_get_focus_mode(const ScBarcodeScannerSettings *settings);

SC_EXPORT void
sc_barcode_scanner_settings_set_focus_mode(ScBarcodeScannerSettings *settings,
                                           ScCameraFocusMode focus_mode);

SC_EXPORT ScCodeDirection
sc_barcode_scanner_settings_get_code_direction_hint(const ScBarcodeScannerSettings *settings);

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


SC_EXPORT int32_t
sc_barcode_scanner_settings_get_code_duplicate_filter(const ScBarcodeScannerSettings *settings);

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

SC_EXPORT int32_t
sc_barcode_scanner_settings_get_code_caching_duration(const ScBarcodeScannerSettings *settings);

SC_EXPORT void
sc_barcode_scanner_settings_set_code_caching_duration(ScBarcodeScannerSettings *settings,
                                                      int32_t duration);

SC_EXPORT char*
sc_barcode_scanner_settings_as_json(const ScBarcodeScannerSettings *settings);

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

#if (SC_PLATFORM_IOS && defined(__OBJC__) && __OBJC__) || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)

#include <UIKit/UIKit.h>
SC_EXPORT void
sc_barcode_scanner_settings_setup_for_ui_image(ScBarcodeScannerSettings *settings, UIImage *image);

#endif

#if defined(__cplusplus)
}
#endif


#endif //SC_BARCODE_SCANNER_SETTINGS_H_