public class ScannerOptions extends PropertyGroup
ScannerOptions is the class that configures the scanner target
beam and other scanner functionalities.| Modifier and Type | Field and Description |
|---|---|
BooleanProperty |
aimEnable
aimEnable enables aim projection when capturing frames. |
NumericProperty |
customImageCaptureProfile
customImageCaptureProfile allows to define a custom profile. |
NumericProperty |
decodeTimeout
decodeTimeout is the maximum time the scanner remains on
without reading a barcode. |
BooleanProperty |
displayModeEnable
displayModeEnable barcode illumination management for capturing frames from displys or reflective surfaces. |
NumericProperty |
doubleReadTimeout
doubleReadTimeout is the minimum time allowed between
reads of the same barcode label. |
BooleanProperty |
illuminationEnable
illuminationEnable enables barcode illumination when capturing frames. |
EnumProperty<IlluminationType> |
illuminationType
illuminationType selects the scanner illuminator to be used for decoding. |
EnumProperty<ImageCaptureProfile> |
imageCaptureProfile
imageCaptureProfile selects the scanner image capture profile. |
BooleanProperty |
picklistEnable
picklistEnable limits reading to targeted selection. |
EnumProperty<ScanMode> |
scanMode
scanMode selects the scan mode. |
EnumProperty<BeamMode> |
targetMode
targetMode selects the scanner target beam mode. |
BooleanProperty |
targetModeEnable
targetModeEnable enables the use of a target beam mode. |
NumericProperty |
targetReleaseTimeout
targetReleaseTimeout is the maximum time the scanner is on after
trigger release when using Release Scan target beam mode. |
NumericProperty |
targetTimeout
targetTimeout is time the target beam is on before scanner
attempts to read. |
| Constructor and Description |
|---|
ScannerOptions(PropertyGetter editor)
This is the constructor of ScannerOptions.
|
getGroups, getId, getName, getProperties, getPropertyById, getPropertyByName, getPropertyGroupById, getPropertyGroupByName, isFullySupported, isSupported, load, setToDefault, storepublic BooleanProperty displayModeEnable
displayModeEnable barcode illumination management for capturing frames from displys or reflective surfaces.
The possibile configurations are:
- feature disabled. Illuminator alwayas enabled;
- feature enabled. Illuminator adjusted according to reflection in the previous acquired frames.public BooleanProperty illuminationEnable
illuminationEnable enables barcode illumination when capturing frames.public BooleanProperty aimEnable
aimEnable enables aim projection when capturing frames.public EnumProperty<BeamMode> targetMode
targetMode selects the scanner target beam mode.public BooleanProperty picklistEnable
picklistEnable limits reading to targeted selection.public BooleanProperty targetModeEnable
targetModeEnable enables the use of a target beam mode.public NumericProperty targetTimeout
targetTimeout is time the target beam is on before scanner
attempts to read. 0=0.25 seconds, 1 to 4= 0.5 to 2 seconds. If the value
exceeds the range, the value is set at full scale.public NumericProperty targetReleaseTimeout
targetReleaseTimeout is the maximum time the scanner is on after
trigger release when using Release Scan target beam mode. If the value
exceeds the range, the value is set at full scale.public NumericProperty decodeTimeout
decodeTimeout is the maximum time the scanner remains on
without reading a barcode. If the value exceeds the range, the value is
set at full scale. The amount of time is represented in milliseconds.public EnumProperty<ImageCaptureProfile> imageCaptureProfile
imageCaptureProfile selects the scanner image capture profile.public NumericProperty customImageCaptureProfile
customImageCaptureProfile allows to define a custom profile.
It could be set with a number between 0-255.public EnumProperty<IlluminationType> illuminationType
illuminationType selects the scanner illuminator to be used for decoding.public EnumProperty<ScanMode> scanMode
scanMode selects the scan mode.public NumericProperty doubleReadTimeout
doubleReadTimeout is the minimum time allowed between
reads of the same barcode label. When the device decodes a label and
sees the same one before this timeout is expired, the second result
will be ignored. This timeout works when scanMode is
set to HOLD_MULTIPLE, PULSE_MULTIPLE or ALWAYS_ON. The amount of time
is represented in milliseconds.public ScannerOptions(PropertyGetter editor)
editor - A PropertyGetter used to load the current barcode family.