Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Android

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 }
 

Detailed Description

barcode scanner configuration

Enumeration Type Documentation

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 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)

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.