Click or drag to resize

Com.Datalogic.Decode.Configuration Namespace

Classes
Class Description
Public class Aztec
Public class BeamMode
Public class CameraWedge
CameraWedge is the class that allows to configure the scanner to act in place of the rear camera of the device. This means that, when the camera wedge is enabled and an app using the rear camera is opened, it will start the scanner instead of using the standard rear camera of the device. With the scanner active, the barcodes that are decoded will be shown back in the preview of the rear camera opened by the application. This allows for an integration of the scanner with application2 that normally take advantage of the rear camera for decoding.
Public class CameraWedgeBarcodeOrientation
The CameraWedgeBarcodeOrientation is an enumeration defining the orientation of the barcode generated by the camera wedge.
Public class CameraWedgeBarcodePosition
The CameraWedgeBarcodePosition is an enumeration defining the position of the barcode generated by the camera wedge.
Public class CameraWedgeBarcodeType
The CameraWedgeBarcodeType is an enumeration defining the symbology of the barcode generated by the camera wedge.
Public class CharacterSetMode
Public class Codabar
Public class Code128
Code128 is the class that configures the Code 128, GS1-128 and ISBT 128 Symbologies.
Public class Code128Aggressiveness
Public class Code128ExtendedAsciiMode
Code128ExtendedAsciiMode is an enumeration defining the Extended ASCII support for Code 128 barcodes. This enumeration specifies the allowed options. The type is one of:
DISABLED Extended ASCII support disabled.
BASIC Only single FNC4 code are evaluated.
FULL Fully implement FNC4 evaluation.
Public class Code39
Public class Code39Aggressiveness
Public class Code93
Public class Composite
Public class Datamatrix
Datamatrix is the class that configures the Data Matrix Symbology.
Public class DatamatrixAggressiveness
Public class DatamatrixMirror
Public class DatamatrixOpMode
Public class DecodeResultCrop
DecodeResultCrop is the class that allows to configure the decode result in order to include a crop of the decoded barcode or OCR.
Public class DecodingNotification
DecodingNotification is the class that configures the notification to produce on a successful read .
Public class Digimarc
Digimarc® is the class that configures the Digimarc barcode ™ reading capability. The technology requires specific devices equipped with certain Datalogic scan engines.
Public class DigimarcDataFormat
The DigimarcDataFormat is an enumeration defining the format used for Digimarc barcode. The type is one of:
COMPATIBLE This mode reports Digimarc Barcode data as if it came from a traditional data carrier (UPC or EAN, for example)
ENHANCED This mode is based on the COMPATIBLE and report more complex Digimarc Barcode payloads as if they came from a GS1 DataBar with relevant GS1 Application Identifier.
NATIVE This mode reports all Digimarc Barcode results as coming from its own, unique symbology
Public class Discrete25
Public class DisplayNotification
Public class DotCode
Public class ECIPolicy
The ECIPolicy is an enumeration defining the policy for the ECI protocoll. The type is one of:
TRANSMIT Transmit ECI escape sequence
REMOVE Remove ECI escape sequence
EVALUATE Evaluate ECI Identifier to encode barcode data
Public class Ean13
Ean13 is the class that configures the EAN-13 Symbology.
Public class Ean8
Public class ExtScannerSource
ExtScannerSource is the class that configures the possibility to receive barcode results from an external scanner.
Public class Formatting
Formatting is the class that configures the properties related to barcode text formatting.
Public class FrameCaptureConfiguration
FrameCaptureConfiguration is the class responsible for configuring the scanner to capture, store, and provide frames during barcode scanning operations. This configuration allows to specify how the scanner should handle frame capture, including the format, storage options, and the location where captured frames will be saved.

The frame capture can be monitored using two types of listeners:

  • FrameCaptureListener: This listener is used to receive frames captured by the scanner in real time. It is added using the addFrameCaptureListener method of the BarcodeManager.
  • FrameSaveListener: This listener is used to monitor when frames are saved to the file system. It is added using the addFrameSaveListener method of the BarcodeManager.

Public class FrameCaptureFormat
The FrameCaptureFileType is an enumeration defining the file type for the frames captured by the Scanner.
Public class FrameCaptureMode
The FrameCaptureMode is an enumeration defining the operating frame capture mode.
Public class GoodRead
The GoodRead class configures various types of notifications that are triggered upon a successful read. It includes options for enabling or disabling different notification methods, such as LED indicators, vibration, and an overlay on the screen.

The class provides properties for customizing each type of notification, allowing developers to fine-tune the user experience based on their specific requirements.

The GoodRead class also includes an advanced notification mechanism called the "Good Read Overlay". This overlay appears on the screen upon a successful read and can be customized in terms of color, shape, size, and position. The overlay is adaptable to both portrait and landscape modes, allowing for flexible configuration based on the device's orientation. The portrait and landscape properties are not mutually exclusive; both sets of properties should be configured. Depending on the device's orientation, the appropriate properties will be applied (portrait settings for portrait mode and landscape settings for landscape mode). The class GoodReadOverlayManager provides methods to manage custom images to be used as overlay.

Public class GoodReadOverlayDisplayPolicy
The GoodReadOverlayDisplayPolicy is an enumeration defining how to display the Good Read Overlay.
Public class GoodReadOverlayPositionPolicy
The GoodReadOverlayPositionPolicy is an enumeration defining which position to use for the Good Read Overlay
Public class GoodReadOverlayShapePolicy
The GoodReadOverlayShapePolicy is an enumeration defining which shape to use for the Good Read Overlay
Public class Gs1Conversion2d
Gs1Conversion2d is an enumeration defining the conversion used for GS1 2D barcodes. The type is one of:
DISABLED No conversion.
GS1_128 Convert the barcode to GS1-128 format.
GTIN Take only the GTIN portion of the barcode and convert it to GTIN format.
UPCA_EAN13_COMPATIBILITY Take only the GTIN portion of the barcode and convert it to the shortest option between GTIN, EAN13 and UPCA.
SHORTEST_UPC_EAN_COMPATIBILITY Take only the GTIN portion of the barcode and convert it to the shortest option between GTIN, EAN13, UPCA, EAN8 and UPCE.
Public class Gs1DataBar_14
Public class Gs1DataBar_Expanded
Public class Gs1DataBar_Limited
Public class Gs1LabelSetTransmitMode
Gs1LabelSetTransmitMode is an enumeration defining the mode used to transmit GS1 label sets. A label set consists of all the GS1 barcodes that have the same GTIN value. The type is one of:
DISABLED Disabled.
FIRST_LABEL Send only the first GS1 label found with a given GTIN. The same label can be sent if the double read timeout has expired without decoding it. This is known as software Mode 1 by the GS1 specification.
ALL_LABELS Send all the labels found with a given GTIN, adding a prefix to identify the same label set. The same label set can be sent if the double read timeout has expired without decoding it. This is known as software Mode 3 by the GS1 specification.
PRIORITIZE_2D_LABEL Send 2D label with a given GTIN if decoded, otherwise send the 1D label if found and if the double read timeout has expired. This is known as software Mode 2 by the GS1 specification.
Public class GtinFormat
GtinFormat is an enumeration defining the format used when converting a barcode to its GTIN representation. The type is one of:
GS1_DATABAR_14 GS1 DataBar 14 format.
GS1_128 GS1-128 format.
Public class HanXin
Public class IlluminationTime
Public class IlluminationType
Public class ImageCaptureProfile
Public class InputType
The InputType is an enumeration defining the input device to use for capturing frames. The type is one of:
SCANENGINE Scan Engine
CAMERA_REAR Rear Camera
CAMERA_FRONT Front Camera
Public class IntentDeliveryMode
Public class IntentWedge
IntentWedge is the class that configures the Decode Wedge capability with the intent mode. This means that the label is sent to the foreground application in the form of an implicit intent. In order to retrieve the label type string, "com.datalogic.decodewedge.label_type" is the name argument to be used with Intent.getStringExtra(). In order to retrieve the output data as string, "com.datalogic.decodewedge.data_string" is the name argument to be used with Intent.getStringExtra() . In case of concatenated barcodes, the decode data is concatenated and sent out as a single string. In order to retrieve the output data as a list of byte arrays, "com.datalogic.decodewedge.decode_data" is the name argument to be used with Intent.getSerializableExtra(). For barcode symbologies that support concatenation, the decode data is stored in multiple byte arrays (one byte array per bar code). Clients can get data in each byte array by passing an index.
Public class Interleaved25
Public class Interleaved25Aggressiveness
Public class Inverse
Public class InverseMode
Public class Isbt128Mode
Public class KeyWedgeMode
Public class KeyboardWedge
KeyboardWedge is the class that configures the Decode Wedge capability with the keystroke mode.
Public class LengthControlMode
Public class LinearQuietZones
Public class Matrix25
Public class Maxicode
Public class MicroQR
Public class Micropdf417
Public class Msi
Public class MsiAggressiveness
Public class MultiScan
Public class OCR
OCR is the class that configure the MRZ reader.
Public class PartialResultMode
Public class Pdf417
Public class PostalAustralian
Public class PostalJapan
Public class PostalKix
Public class PostalRoyalMail
Public class PostalUsPlanet
Public class PostalUsPostnet
Public class PostalUsps4State
Public class PresentationMode
PresentationMode is the class that configures the presentation mode functionalities.
Public class PreviewDisplayMode
The PreviewDisplayMode is an enumeration defining the mode used while showing the camera preview if the selected input device is a camera (front or rear). The type is one of:
FIT_SCREEN The preview will fit the screen in the smallest dimension
MANUAL The preview will be positioned manually
Public class QRCode
QRCode is the class that configures the QR Code Symbology.
Public class QRMirror
Public class ScanMode
Public class ScannerOptions
ScannerOptions is the class that configures the scanner target beam and other scanner functionalities.
Public class ScannerProperties
ScannerProperties is the scanner property container class.
Public class SendCodeID
Public class SnapOcr
SnapOcr is the class that configures the Snap OCR feature, used to capture and provide OCR text found in the scanner/camera frames.
Public class SnapOcrFirstSelectionMode
The SnapOcrFirstSelectionMode is an enumeration defining the first selection mode for the Snap OCR. The type is one of:
ALWAYS_SELECT Always asks the user to select the text.
ROI_PROPOSE Proposes all the text found in defined ROIs.
PICKLIST_PROPOSE Searches for the closest bounding box result near the center of the image. Result is proposed and require user confirmation.
ROI_SEND Automatically sends all the text found in defined ROIs.
PICKLIST_SEND Searches for the closest bounding box result near the center of the image. Result automatically is sent.
Public class SnapOcrResultSettings
SnapOcrResultSettings is the class that configures the Snap OCR settings related to the OCR results.
Public class SnapOcrResultsCombination
The SnapOcrResultsCombination is an enumeration defining the way in which the OCR results are combined. The type is one of:
CONCATENATED Concatenates the OCR texts into a single result, with the separator specified.
DIVIDED Each selected OCR text is sent as a separate result.
Public class SnapOcrRoiSettings
Class defining the ROI settings used in Snap OCR when the first selection mode is set to ROI_PROPOSE or ROI_SEND.
Public class SnapOcrRoiSettings+InternalRoi
Public class SnapOcrRoiSettings+ReferenceRoi
Public class SnapOcrScanningPolicy
The SnapOcrScanningPolicy is an enumeration defining the scanning policy used when the Snap OCR is enabled. The type is one of:
OCR_AND_BARCODE Scans both OCR and barcodes found in the frames.
OCR_ONLY Only scans for OCR.
OCR_TRIGGER Only scans for barcodes when using the BARCODE keycode. Only scans for OCR when using the OCR_DECODE keycode.
Public class SnapOcrUiCustomization
SnapOcrUiCustomization is the class that configures the Snap OCR settings related to the UI customization.
Public class SymbologyBase
Public class SymbologyLengths
Public class Tlc39
Tlc39 is the class that configures the TLC 39 Symbology.
Public class ToneNotificationChannel
Public class ToneNotificationMode
ToneNotificationMode is an enumeration defining the audio notification mode, subject to Good read rules.
Public class UpcA
Public class UpcE
Public class UpcEanAggressiveness
Public class UpcEanCompositeMode
Public class UpcEanExtensions
Public class WebWedge