ScBarcodeScannerSettings.h File Reference

Go to the source code of this file.

Typedefs
typedef int32_t	ScBarcodeScannerSettingsPresetFlags
typedef struct ScOpaqueBarcodeScannerSettings	ScBarcodeScannerSettings

Enumerations
enum	ScBarcodeScannerSettingsPreset {   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 }
enum	ScCodeDirection {   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 }
enum	ScCodeLocationConstraint { SC_CODE_LOCATION_RESTRICT = 0x01, SC_CODE_LOCATION_HINT = 0x02, SC_CODE_LOCATION_IGNORE = 0x03 }

Functions
ScBool	sc_barcode_scanner_settings_set_aruco_dictionary (ScBarcodeScannerSettings *settings, ScArucoDictionary const *dictionary)

Code Location
#define	SC_CIRCLE_RADIUS_INFINITE   -1.0f
void	sc_barcode_scanner_settings_get_circle_of_interest (ScBarcodeScannerSettings const *settings, ScPointF *relative_center, float *relative_radius)
void	sc_barcode_scanner_settings_set_circle_of_interest (ScBarcodeScannerSettings *settings, ScPointF relative_center, float relative_radius)

Detailed Description

barcode scanner configuration

Copyright

Copyright (c) 2015 Scandit AG. All rights reserved.

Macro Definition Documentation

#define SC_CIRCLE_RADIUS_INFINITE   -1.0f

Value to indicate a circle with "infinite radius".

Pass this value as the radius to sc_barcode_scanner_settings_set_circle_of_interest() to indicate that the circle of interest acts as a hint to the scanner where to focus the attention of recognition. Unlike with a radius of >= 0, results from the whole image are returned.

Enumeration Type Documentation

enum ScBarcodeScannerSettingsPreset

List of barcode scanner settings presets.

Since

4.6.0

Enumerator
SC_PRESET_NONE	Preset with all symbologies disabled.
SC_PRESET_ENABLE_RETAIL_SYMBOLOGIES	Preset to enable decoding of all retail symbologies. By using this preset, the decoding of the following symbologies is enabled: EAN13, UPCA, EAN8, UPCE
SC_PRESET_ENABLE_VIN_DECODING	Preset to enable decoding VIN codes. This preset will enable scanning of the CODE39 symbology.
SC_PRESET_ENABLE_SSCC_DECODING	Preset to enable decoding SSCC18 codes. This preset will enable scanning of CODE128 symbology.
SC_PRESET_ENABLE_SINGLE_FRAME_MODE	Preset that switches the scanner from real-time video stream processing to a single frame mode. This preset should only be used on fast devices. Execution time per frame can be up to a 100 times slower. Since 5.4.0

enum ScCodeDirection

Enum for different code directions.

Since

4.6.0

Enumerator
SC_CODE_DIRECTION_NONE	Code orientation is unknown
SC_CODE_DIRECTION_LEFT_TO_RIGHT	Code is oriented from left to right in the image
SC_CODE_DIRECTION_RIGHT_TO_LEFT	Code is oriented from right to left in the image
SC_CODE_DIRECTION_TOP_TO_BOTTOM	Code is oriented from top to bottom in the image
SC_CODE_DIRECTION_BOTTOM_TO_TOP	Code is oriented from bottom to top in the image
SC_CODE_DIRECTION_VERTICAL	The code is oriented vertically in the image (top to bottom, or bottom to top).
SC_CODE_DIRECTION_HORIZONTAL	The code is oriented horizontally in the image (left to right, or right to left)

enum ScCodeLocationConstraint

Code location constraint.

The code location constraint influences how the 1d and 2d code location areas are interpreted.

Since

4.6.0

Enumerator
SC_CODE_LOCATION_RESTRICT	Restrict decoding to the specified area. Decoding of codes is restricted to this area.
SC_CODE_LOCATION_HINT	The area indicates the most likely code position. The area is a hint to the barcode scanner as to where codes can be found.
SC_CODE_LOCATION_IGNORE	The area can be defined but will not be used by the barcode scanner.

Function Documentation

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

Returns the circle of interest.

Parameters

settings	The barcode scanner settings object. Must not be null.
relative_center	returns the position in relative coordinates. Must not be null.
relative_radius	returns the radius relative to the frame width. Must not be null.

Since

5.25.0

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

Sets the circle of interest.

Use this API to define a circle that results must touch in order to be returned or to give a hint to the barcode scanner where to focus most of the effort for the recognition on.

If the radius is >= 0, only locations and barcode results that are touching the circle of interest are returned. The selection is limited by the maximum number of codes. Results that are closer to the center of the circle are preferred.

Since 6.24: If the radius is SC_CIRCLE_RADIUS_INFINITE or negative, then center is used as hint for the barcode scanner where to focus the attention of recognition. Results continue to be returned in the full image.

This function does not affect the code location areas. The circle of interest is disabled by default.

Parameters

settings	The barcode scanner settings object. Must not be null.
relative_center	position in relative coordinates. Use negative values to disable the feature.
relative_radius	radius relative to the frame width. Since 6.24 negative values are allowed.

Since

5.25.0

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 default ARUCO dictionary in the settings is the preset from OpenCV, which consists of 1000 5x5-markers.

Parameters

settings	the settings object. Must not be null
dictionary	the dictionary object, it will be copied. Must not be null

Returns

true if a dictionary was added without error, otherwise false

Since

5.30.0