to top
Datalogic APIs
public class

ScanningPreview

extends PropertyGroup
java.lang.Object
   ↳ com.datalogic.device.configuration.PropertyGroup
     ↳ com.datalogic.decode.configuration.ScanningPreview

Class Overview

ScanningPreview is the class that allows to configure a preview source to be activated in several different conditions:

  • While decoding.
  • Using an SDK method to start or stop the preview.
  • Using an intent to start or stop the preview.
  • Using the proximity sensor (if available) by specifying the range (in mm) in which the preview will be active.

Summary

Fields
public BooleanProperty activationByDecoding activationByDecoding represents if the preview will be turned on during decoding.
public BooleanProperty activationByIntent activationByIntent represents if the preview will be turned on using the specific intent actions in a broadcast intent (ACTION_START_SCANNING_PREVIEW and ACTION_STOP_SCANNING_PREVIEW).
public BooleanProperty activationByProximity activationByProximity represents if the preview will be turned on using a ToF range.
public NumericProperty activationByProximityHighThreshold activationByProximityHighThreshold represents the high threshold of the ToF range (in mm) when the preview can be turned on by the ToF.
public NumericProperty activationByProximityLowThreshold activationByProximityLowThreshold represents the low threshold of the ToF range (in mm) when the preview can be turned on by the ToF.
public BooleanProperty activationBySdk activationBySdk represents if the preview will be turned on using the specific SDK methods (startScanningPreview() and stopScanningPreview()).
public EnumProperty<ScanningPreviewDisplayMode> displayMode displayMode indicates the display mode in which to show the scanning preview.
public NumericProperty displayModeManualLandscapeHeight displayModeManualLandscapeHeight indicates the height of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in landscape.
public NumericProperty displayModeManualLandscapeWidth displayModeManualLandscapeWidth indicates the width of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in landscape.
public NumericProperty displayModeManualLandscapeX displayModeManualLandscapeX indicates the X coordinate of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in landscape.
public NumericProperty displayModeManualLandscapeY displayModeManualLandscapeY indicates the X coordinate of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in landscape.
public NumericProperty displayModeManualPortraitHeight displayModeManualPortraitHeight indicates the height of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in portrait.
public NumericProperty displayModeManualPortraitWidth displayModeManualPortraitWidth indicates the width of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in portrait.
public NumericProperty displayModeManualPortraitX displayModeManualPortraitX indicates the X coordinate of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in portrait.
public NumericProperty displayModeManualPortraitY displayModeManualPortraitY indicates the Y coordinate of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in portrait.
public NumericProperty hideDelay hideDelay represents the amount of time (in ms) the preview will be shown after a barcode has been successfully decoded.
public EnumProperty<ScanningPreviewIlluminationSource> illuminationSource illuminationSource indicates the illumination source used in the scanning preview.
public EnumProperty<ScanningPreviewSource> source source represents the source of the preview (where the frames come from).
Public Constructors
ScanningPreview(PropertyGetter editor)
This is the constructor of ScanningPreview.
[Expand]
Inherited Methods
From class com.datalogic.device.configuration.PropertyGroup
From class java.lang.Object

Fields

public BooleanProperty activationByDecoding

Added in revision 47

activationByDecoding represents if the preview will be turned on during decoding.

public BooleanProperty activationByIntent

Added in revision 47

activationByIntent represents if the preview will be turned on using the specific intent actions in a broadcast intent (ACTION_START_SCANNING_PREVIEW and ACTION_STOP_SCANNING_PREVIEW).

public BooleanProperty activationByProximity

Added in revision 47

activationByProximity represents if the preview will be turned on using a ToF range.

public NumericProperty activationByProximityHighThreshold

Added in revision 47

activationByProximityHighThreshold represents the high threshold of the ToF range (in mm) when the preview can be turned on by the ToF.

public NumericProperty activationByProximityLowThreshold

Added in revision 47

activationByProximityLowThreshold represents the low threshold of the ToF range (in mm) when the preview can be turned on by the ToF.

public BooleanProperty activationBySdk

Added in revision 47

activationBySdk represents if the preview will be turned on using the specific SDK methods (startScanningPreview() and stopScanningPreview()).

public EnumProperty<ScanningPreviewDisplayMode> displayMode

Added in revision 49

displayMode indicates the display mode in which to show the scanning preview.

public NumericProperty displayModeManualLandscapeHeight

Added in revision 49

displayModeManualLandscapeHeight indicates the height of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in landscape. The camera frames will retain their original aspect ratio but they will resize in order to fit inside the preview box specified by the width and height parameters.

public NumericProperty displayModeManualLandscapeWidth

Added in revision 49

displayModeManualLandscapeWidth indicates the width of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in landscape. The camera frames will retain their original aspect ratio but they will resize in order to fit inside the preview box specified by the width and height parameters.

public NumericProperty displayModeManualLandscapeX

Added in revision 49

displayModeManualLandscapeX indicates the X coordinate of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in landscape.

public NumericProperty displayModeManualLandscapeY

Added in revision 49

displayModeManualLandscapeY indicates the X coordinate of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in landscape.

public NumericProperty displayModeManualPortraitHeight

Added in revision 49

displayModeManualPortraitHeight indicates the height of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in portrait. The camera frames will retain their original aspect ratio but they will resize in order to fit inside the preview box specified by the width and height parameters.

public NumericProperty displayModeManualPortraitWidth

Added in revision 49

displayModeManualPortraitWidth indicates the width of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in portrait. The camera frames will retain their original aspect ratio but they will resize in order to fit inside the preview box specified by the width and height parameters.

public NumericProperty displayModeManualPortraitX

Added in revision 49

displayModeManualPortraitX indicates the X coordinate of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in portrait.

public NumericProperty displayModeManualPortraitY

Added in revision 49

displayModeManualPortraitY indicates the Y coordinate of the preview shown in case of manual display mode for the scanning preview, when the device is positioned in portrait.

public NumericProperty hideDelay

Added in revision 47

hideDelay represents the amount of time (in ms) the preview will be shown after a barcode has been successfully decoded.

public EnumProperty<ScanningPreviewIlluminationSource> illuminationSource

Added in revision 49

illuminationSource indicates the illumination source used in the scanning preview. The source selected will be turned on only when the scanning preview is activated during decoding and only if the ILLUMINATION_ENABLE parameter is enabled.

public EnumProperty<ScanningPreviewSource> source

Added in revision 47

source represents the source of the preview (where the frames come from).

Public Constructors

public ScanningPreview (PropertyGetter editor)

Added in revision 47

This is the constructor of ScanningPreview. All options are initialized by editor.

Parameters
editor A PropertyGetter used to load the current configuration.