ScannerConfig (app API)

java.lang.Object
- com.symbol.emdk.barcode.ScannerConfig

public class ScannerConfig
extends java.lang.Object

The ScannerConfig class provides access to scanner configuration settings.

 
 	Example Usage:
 	ScannerConfig scannerConfig = scanner.getConfig(scannerConfig);
 	scannerConfig.scanParams.decodeHapticFeedback = true;
 	scannerConfig.decoderParams.codabar.length1 = 6;
 	scanner.setConfig(scannerConfig);

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ScannerConfig.AdaptiveScanning` Enable or Disable Adaptive scanning.
`static class`	`ScannerConfig.AimingPattern` Describes the aiming pattern to be turned ON/OFF.
`static class`	`ScannerConfig.AimType` Describes the type of aiming to use.
`static class`	`ScannerConfig.AudioStreamType` Volume slider type for decode audio feedback.
`static class`	`ScannerConfig.AutoCharacterSetFailureOption` Failure option for auto character set selection.
`static class`	`ScannerConfig.AutoCharacterSetPreference` Selection of character sets available for automatic decoding.
`static class`	`ScannerConfig.BeamWidth` Controls the beam width of a laser scanner.
`static class`	`ScannerConfig.BooklandFormat` Lists the Bookland formats
`static class`	`ScannerConfig.CharacterSet` Selection of character set for decoding the barcode.
`static class`	`ScannerConfig.CheckDigit` The number of check digits to be verified.
`static class`	`ScannerConfig.CheckDigitScheme` Two algorithms are possible for the verification of the second MSI check digit.
`static class`	`ScannerConfig.CheckDigitType` Verify data integrity.
`static class`	`ScannerConfig.CodeIdType` A Code ID character identifies the code type of a scanned barcode.
`static class`	`ScannerConfig.CouponReport` Supported Coupon modes
`static class`	`ScannerConfig.DecodeAudioFeedbackMode` Describes the Audio Feedback Mode is given by the host device and remote scanner.
`static class`	`ScannerConfig.DecodeLEDFeedbackMode` Describes the LED Feedback mode is given by the host device and remote scanner.
`class`	`ScannerConfig.DecoderParams` The DecoderParams class contains decoder parameters that are used by multiple decoder symbologies.
`static class`	`ScannerConfig.DotCodeInverse` values for decoder parameter inverse
`static class`	`ScannerConfig.DotCodeMirror` values for decoder parameter Mirror
`static class`	`ScannerConfig.DpmIlluminationControl` Control the illumination for DPM barcode reading.
`static class`	`ScannerConfig.DpmModes` Select the DPM mode based on the type of barcode being scanned.
`static class`	`ScannerConfig.GridMatrixInverse` values for decoder parameter inverse
`static class`	`ScannerConfig.GridMatrixMirror` values for decoder parameter Mirror
`static class`	`ScannerConfig.GS1LimitedSecurityLevel` Security level addition of GS1 DataBar lim decoder.
`static class`	`ScannerConfig.HanXinInverse` This parameter allows the user to select decoding on inverse HanXin barcodes.
`static class`	`ScannerConfig.IlluminationMode` Enable/disable illumination depending on ambient light conditions.
`static class`	`ScannerConfig.Inverse1DMode` This parameter allows the user to select decoding on inverse 1D barcodes.
`static class`	`ScannerConfig.InverseOcr` Selects normal, inverse or both OCR scanning.
`static class`	`ScannerConfig.Isbt128ContactMode` Option for concatenating pairs of ISBT128 code types.
`static class`	`ScannerConfig.LcdMode` Enable or disable LCD mode (for Blockbuster imager devices only).
`static class`	`ScannerConfig.LinearSecurityLevel` Sets the number of times a barcode is read to confirm an accurate decode.
`class`	`ScannerConfig.MultiBarcodeParams` Deprecated. This class has been deprecated. We recommend using the new `ScannerConfig.NGSimulScanParams` class in your new applications. The MultiBarcodeParams class provides access to multi-barcode parameters that are available to configure. When doing multi-barcode scanning consider the followings: Barcodes can be of multiple label types. If the required number of barcodes (from 2-100, as set using the barcodeCount parameter) is not in view of the scanner, the scanner will not decode any data. If the scanner's field of view contains a number of barcodes greater than the value set by barcodeCount, the scanner will randomly decode any barcode(s) until the count is reached. For example, if the count is set to two and eight barcodes are in the field of view, the scanner returns data for the first two barcodes it sees, and returns the data in random order. There is no guarantee that the order of returned data will be the same on any two scans; order of individual barcode data can vary with each scan. In multi-barcode scanning mode, when a picklist reader parameter is set to a value other than “Disabled," the user is expected to move the crosshair to the specified number of barcodes to be scanned. Set this value (from 2-100) using the barcodeCount parameter. Data is returned only after the specified number of barcodes is read.
`static class`	`ScannerConfig.NGSimulScanMode` Available NGSimulScan scanning modes.
`class`	`ScannerConfig.NGSimulScanParams` The NGSimulScanParams class provides access to NGSimulScanParams parameters that are available to configure.
`static class`	`ScannerConfig.OcrAVariant` Selects different OCR-A variants.
`static class`	`ScannerConfig.OcrBVariant` Selects different OCR-B variants.
`static class`	`ScannerConfig.OcrCheckDigitValidation` Selects Check Digit Validation Scheme.
`static class`	`ScannerConfig.OcrLines` Select number of lines to scan during OCR reading.
`static class`	`ScannerConfig.OcrOrientation` Specify the orientation of an OCR String to be read.
`class`	`ScannerConfig.OcrParams` The OcrParams class provides access to OCR parameters that are available to configure.
`static class`	`ScannerConfig.OneDQuietZoneLevel` Describes the effort at which the decoder will attempt to decode margin-less barcodes.
`static class`	`ScannerConfig.PairAfterScannerReboot` Enable/disable automatic reconnection after scanner reboot.
`static class`	`ScannerConfig.PickList` Deprecated. This enum is deprecated and the recommendation is to use new enum `ScannerConfig.PicklistEx`. Allows the imager to decode only the barcode that is directly under the cross-hair/reticle (+) part of the pattern. This feature is useful in applications where multiple barcodes may appear in the field of view during a decode session and only one of them is targeted for decode. Note: Selecting the picklist may adversely affect overall decoding performance. `Example Usage: PickList.DISABLED;`
`static class`	`ScannerConfig.PicklistEx` Allows the imager or camera to decode only the barcode that is directly under the cross-hair (+)/center of the reticle part of the pattern.
`static class`	`ScannerConfig.PoorQualityDecodeEffortLevel` Describes the selection of enhancement modes for decoding barcodes of poor or degraded quality.
`static class`	`ScannerConfig.PowerMode` Set laser scanner power mode
`static class`	`ScannerConfig.Preamble` Controls the preamble applied to the barcode Preamble characters are part of the UPC symbol consisting of Country Code and System Character.
`static class`	`ScannerConfig.PresentationModeSensitivity` Controls the sensitivity of scene detection in presentation mode.
`class`	`ScannerConfig.ReaderParams` The ReaderParams class holds the parameters for a scanner.
`static class`	`ScannerConfig.ScanMode` Deprecated. This enum has been deprecated. We recommend using the new enum `ScannerConfig.NGSimulScanMode` in your new applications. Available scanning modes. This allows to select one type at a time. `Example Usage: ScanMode.SINGLE_BARCODE;`
`class`	`ScannerConfig.ScanParams` The ScanParams class provides access to scanning parameters that are available for all decoders.
`static class`	`ScannerConfig.SceneDetectionQualifier` Qualifier for starting scene detection when presentation is selected as Aim Type.
`static class`	`ScannerConfig.SecurityLevel` The scanner offers four levels of decode security for UPC/EAN barcodes.
`static class`	`ScannerConfig.SignatureImageBitsPerPixel` Selection of bits per pixel for signature image
`static class`	`ScannerConfig.SignatureImageFormat` Selection of format for signature image.
`static class`	`ScannerConfig.SkipOnUnSupported` Describes what to do when the scanner config fields are not supported for the specified scanner.
`static class`	`ScannerConfig.SupplementalMode` Supplemental modes
`static class`	`ScannerConfig.UccLinkMode` Describes the UCC link mode state.
`class`	`ScannerConfig.UdiParams` Deprecated. This feature is supported only on devices prior to those running Android 10 Q. The UdiParams class provides access to UDI parameters that are available to configure.
`static class`	`ScannerConfig.VerifyCheckDigit` Check the integrity of all Code 11 symbols to verify that the data complies with the specified check digit algorithm.
`static class`	`ScannerConfig.ViewFinderMode` Configures the Viewfinder modes supported for camera scanning.

Field Summary

Fields
Modifier and Type	Field and Description
`ScannerConfig.DecoderParams`	`decoderParams` The DecoderParams class contains decoder parameters that are used by multiple decoder symbologies.
`ScannerConfig.MultiBarcodeParams`	`multiBarcodeParams` Deprecated. We recommend using the new fields introduced in the `ScannerConfig.NGSimulScanParams` class in your new applications. The MultiBarcodeParams class holds the parameters for Multi-Barcodes.
`ScannerConfig.NGSimulScanParams`	`ngSimulScanParams` The NGSimulScanParams class holds the parameters for NGSimulScan feature.
`ScannerConfig.OcrParams`	`ocrParams` The OcrParams class holds the parameters for OCR.
`ScannerConfig.ReaderParams`	`readerParams` The ReaderParams class holds the parameters for a scanner.
`ScannerConfig.ScanParams`	`scanParams` The ScanParams property provides access to scanning parameters that are available for all decoders.
`ScannerConfig.SkipOnUnSupported`	`skipOnUnsupported` This flag to tells whether to skip the unsupported parameter/values and continue or stop setting the configuration.
`ScannerConfig.UdiParams`	`udiParams` Deprecated. This feature is supported only on devices prior to those running Android 10 Q. The UdiParams class holds the parameters for UDI.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isParamSupported(java.lang.String param)` This method helps to check scanner config parameters supported Returns true if specified parameter is supported.
`void`	`resetToDefault(Scanner scanner)` Resets the scanner parameters to defaults values for the specified scanner.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - skipOnUnsupported
```
public ScannerConfig.SkipOnUnSupported skipOnUnsupported
```
    This flag to tells whether to skip the unsupported parameter/values and continue or stop setting the configuration. Its set to UNSUPPORTED_PARAM by default which skips the unsupported params and continues.
  - scanParams
```
public ScannerConfig.ScanParams scanParams
```
    The ScanParams property provides access to scanning parameters that are available for all decoders. NOTE: When calling enable() after disable(), all the latest configuration parameter values (Config.DecoderParams, Config.ScannerParams, Config.ReaderParamss) will be set automatically.
  - decoderParams
```
public ScannerConfig.DecoderParams decoderParams
```
    The DecoderParams class contains decoder parameters that are used by multiple decoder symbologies. The property provides access to such decoder parameters as Enabled and isSupported, among others. NOTE: When calling enable() after disable(), all the latest configuration parameter values (Config.DecoderParams, Config.ScannerParams, Config.ReaderParams) will be set automatically.
  - readerParams
```
public ScannerConfig.ReaderParams readerParams
```
    The ReaderParams class holds the parameters for a scanner. Reader parameters are global to all reads on all open handles on the same scanner. NOTE: When calling enable() after disable(), all the latest configuration parameter values (Config.DecoderParams, Config.ScannerParams, Config.ReaderParams) will be set automatically.
  - ngSimulScanParams
```
public ScannerConfig.NGSimulScanParams ngSimulScanParams
```
    The NGSimulScanParams class holds the parameters for NGSimulScan feature.
    For some devices, this feature requires the purchase of a Mobility DNA Enterprise License. Follow this for more info: More info.
  - udiParams
```
@Deprecated
public ScannerConfig.UdiParams udiParams
```
    Deprecated. This feature is supported only on devices prior to those running Android 10 Q.
    The UdiParams class holds the parameters for UDI.
  - multiBarcodeParams
```
@Deprecated
public ScannerConfig.MultiBarcodeParams multiBarcodeParams
```
    Deprecated. We recommend using the new fields introduced in the ScannerConfig.NGSimulScanParams class in your new applications.
    The MultiBarcodeParams class holds the parameters for Multi-Barcodes.
  - ocrParams
```
public ScannerConfig.OcrParams ocrParams
```
    The OcrParams class holds the parameters for OCR.
- Method Detail
  - isParamSupported
```
public boolean isParamSupported(java.lang.String param)
```
    This method helps to check scanner config parameters supported Returns true if specified parameter is supported. The field name should be specify complete access path till the field in the string format. The scanner config object name can be any name, but following field names should exactly match the fields defined by scanner config class.
    Example Usage: ScannerConfig config1 = scanner.getConfig(scannerConfig); if ( config1.isParamSupported("config1.scanParams.decodeHapticFeedback") ) { config1.scanParams.decodeHapticFeedback = true; } if ( config1.isParamSupported("config1.decoderParams.codabar.enabled") ) { config1.decoderParams.codabar.enabled = true; } scanner.setConfig(config1);
    Parameters:
    
    param -
    
    Returns:
  - resetToDefault
```
public void resetToDefault(Scanner scanner)
                    throws ScannerException
```
    Resets the scanner parameters to defaults values for the specified scanner. The unsupported parameters left as it is.
    
    Parameters:
    
    scanner -
    
    Throws:
    
    ScannerException

Class ScannerConfig

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

skipOnUnsupported

scanParams

decoderParams

readerParams

ngSimulScanParams

udiParams

multiBarcodeParams

ocrParams

Method Detail

isParamSupported

resetToDefault