ScBarcodeScannerSettings.h File Reference

Go to the source code of this file.

Macros
Code Location
#define	SC_CIRCLE_RADIUS_INFINITE   -1.0f
Session Settings
The session settings do not affect the object tracker (MatrixScan).
#define	SC_DUPLICATE_FILTER_OFF   (0)
#define	SC_DUPLICATE_FILTER_INFINITE   (-1)

Typedefs
typedef int32_t	ScBarcodeScannerSettingsPresetFlags
typedef struct ScOpaqueBarcodeScannerSettings	ScBarcodeScannerSettings

Enumerations
enum	ScBarcodeScannerSettingsPreset { SC_PRESET_NONE = 0x00, SC_PRESET_HIGH_EFFORT = 0x02, SC_PRESET_SINGLE_CODE_HAND_HELD = 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 }

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.

#define SC_DUPLICATE_FILTER_OFF   (0)

Duplicate filter is disabled.

Since

7.1.0

#define SC_DUPLICATE_FILTER_INFINITE   (-1)

Duplicate filter has no time limit.

Since

7.1.0

Enumeration Type Documentation

enum ScBarcodeScannerSettingsPreset

List of barcode scanner settings presets.

Presets allow you to configure the barcode scanner for specific use-cases. The settings can be further refined trough the settings API.

The settings preset can not be combined. The preset with the lowest value is used if multiple bits are set.

Enumerator
SC_PRESET_NONE	No (default) preset. This preset is the default behavior. It offers a balance speed to accuracy performance on frame sequences for single and multi-scan use-cases. The recommended input resolution is FullHD (1080p). Since 4.6.0
SC_PRESET_HIGH_EFFORT	High effort preset. This preset tries to achieve the best accuracy by spending more time per frame than the default preset. It is optimized for high power devices or non real-time requirements. It supports single or multi-code scanning and is recommended for single image or cloud processing use-cases. The recommended input resolution is FullHD (1080p) or 4KUHD (2160p). Since 7.1.0
SC_PRESET_SINGLE_CODE_HAND_HELD	Preset for hand held devices that need to scan one code at a time. This profile is intended for devices that are hand-held and a single code needs to be scanned in a static scene. Smart scan intention is active, which prevents scans in the background or during fast movement. The recommended input resolution is FullHD (1080p) or 4KUHD (2160p) for extra range. This preset always returns at most one code or group of codes per frame. Since 7.1.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.