| java.lang.Object | ||
| ↳ | com.datalogic.device.configuration.PropertyGroup | |
| ↳ | com.datalogic.decode.configuration.ScanningPreview | |
ScanningPreview is the class that allows to configure a preview source to
be activated in several different conditions:
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| activationByDecoding | activationByDecoding represents if the preview will be turned on during decoding. |
||||||||||
| 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). |
||||||||||
| activationByProximity | activationByProximity represents if the preview will be turned on using a ToF range. |
||||||||||
| activationByProximityHighThreshold | activationByProximityHighThreshold represents the high threshold of the ToF range (in mm) when the preview
can be turned on by the ToF. |
||||||||||
| activationByProximityLowThreshold | activationByProximityLowThreshold represents the low threshold of the ToF range (in mm) when the preview
can be turned on by the ToF. |
||||||||||
| activationBySdk | activationBySdk represents if the preview will be turned on using the specific SDK methods
(startScanningPreview() and stopScanningPreview()). |
||||||||||
| displayMode | displayMode indicates the display mode in which to show the scanning preview. |
||||||||||
| 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. |
||||||||||
| 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. |
||||||||||
| 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. |
||||||||||
| 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. |
||||||||||
| 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. |
||||||||||
| 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. |
||||||||||
| 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. |
||||||||||
| 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. |
||||||||||
| gs1EvaluationEnable | gs1EvaluationEnable enables the evaluation of GS1 barcodes found in the scanning preview. |
||||||||||
| gs1EvaluationLabels | gs1EvaluationLabels defines the labels expected while evaluating a GS1 barcode. |
||||||||||
| gs1EvaluationRemoteAddressFormat | gs1EvaluationRemoteAddressFormat defines the format used for the final URI used to collect data from the remote server. |
||||||||||
| gs1EvaluationRemoteAddressName | gs1EvaluationRemoteAddressName defines the address of the server that will be queries if the label values are
not found inside the barcode. |
||||||||||
| gs1EvaluationUiColorBlock | gs1EvaluationUiColorBlock defines the background color of the dialog shown after GS1 evaluation succeeds. |
||||||||||
| gs1EvaluationUiColorText | gs1EvaluationUiColorText defines the text color of the dialog shown after GS1 evaluation succeeds. |
||||||||||
| hideDelay | hideDelay represents the amount of time (in ms) the preview will be shown after
a barcode has been successfully decoded. |
||||||||||
| illuminationSource | illuminationSource indicates the illumination source used in the scanning preview. |
||||||||||
| source | source represents the source of the preview (where the frames come from). |
||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
This is the constructor of ScanningPreview.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.datalogic.device.configuration.PropertyGroup
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
activationByDecoding represents if the preview will be turned on during decoding.
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).
activationByProximity represents if the preview will be turned on using a ToF range.
activationByProximityHighThreshold represents the high threshold of the ToF range (in mm) when the preview
can be turned on by the ToF.
activationByProximityLowThreshold represents the low threshold of the ToF range (in mm) when the preview
can be turned on by the ToF.
activationBySdk represents if the preview will be turned on using the specific SDK methods
(startScanningPreview() and stopScanningPreview()).
displayMode indicates the display mode in which to show the scanning preview.
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.
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.
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.
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.
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.
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.
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.
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.
gs1EvaluationEnable enables the evaluation of GS1 barcodes found in the scanning preview.
gs1EvaluationLabels defines the labels expected while evaluating a GS1 barcode.
If at least a label is found in the barcode, a dialog will be shown with the existing labels, allowing
to confirm if the barcode is the expected or not.
This property can only contain an object of class ScanningPreviewGs1EvaluationLabels.
gs1EvaluationRemoteAddressFormat defines the format used for the final URI used to collect data from the remote server.
The URI will contain the GTIN value coming from the GS1 barcode and it will add it to the remote
address using the specified format.
gs1EvaluationRemoteAddressName defines the address of the server that will be queries if the label values are
not found inside the barcode.
gs1EvaluationUiColorBlock defines the background color of the dialog shown after GS1 evaluation succeeds.
gs1EvaluationUiColorText defines the text color of the dialog shown after GS1 evaluation succeeds.
hideDelay represents the amount of time (in ms) the preview will be shown after
a barcode has been successfully decoded.
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.
source represents the source of the preview (where the frames come from).
This is the constructor of ScanningPreview. All options are initialized by editor.
| editor | A PropertyGetter used to load the current configuration.
|
|---|