com.symbol.emdk.barcode

Class ScannerConfig.ReaderParams.ReaderSpecific.CameraSpecific

java.lang.Object

com.symbol.emdk.barcode.ScannerConfig.ReaderParams.ReaderSpecific.CameraSpecific

Enclosing class:

ScannerConfig.ReaderParams.ReaderSpecific

public class ScannerConfig.ReaderParams.ReaderSpecific.CameraSpecific
extends java.lang.Object

CameraSpecific class provides access to the camera scanner specific parameters.

Field Summary

Fields

Modifier and Type	Field and Description
int	aimTimer Duration in milliseconds for timed aim types ScannerConfig.AimType.TIMED_HOLD and ScannerConfig.AimType.TIMED_RELEASE.
ScannerConfig.AimType	aimType Describes the type of aiming to use.
ScannerConfig.AutoCharacterSetFailureOption	autoCharacterSetFailureOption If the system cannot find a character set from the preferred order that can correctly decode the data, this will be used as the character set.
ScannerConfig.AutoCharacterSetPreference[]	autoCharacterSetPreferredOrder Sets the preferred character set order to decode the barcode data when character set selection is set to "Auto".
int	beamTimer Sets the maximum amount of time that the reader remains on (0 - 60,000 ms in increments of 100 ms).
ScannerConfig.CharacterSet	characterSetSelection Sets the character set to be used to decode the returned barcode data.
ScannerConfig.ReaderParams.ReaderSpecific.ContinuousRead	continuousRead Deprecated. We recommend using the new fields aimType, sameSymbolTimeout, differentSymbolTimeout in your new applications. ContinuousRead class provides access to continuous scanning related parameters.
int	differentSymbolTimeout This setting is used to prevent the scanner from decoding another symbol within this time interval.
boolean	digimarcDecoding Enables or disables the Digimarc decoding.
ScannerConfig.IlluminationMode	illuminationMode Turns camera illumination on and off.
ScannerConfig.Inverse1DMode	inverse1DMode This parameter allows the user to select decoding on inverse 1D barcodes.
ScannerConfig.LinearSecurityLevel	linearSecurityLevel Sets the number of times a barcode is read to confirm an accurate decode.
ScannerConfig.OneDQuietZoneLevel	oneDQuietZoneLevel This parameter sets the effort at which the decoder will attempt to decode margin-less barcodes.
ScannerConfig.PicklistEx	picklistEx Allows the imager to decode only the barcode that is directly under the cross-hair/reticle (+) part of the pattern.
ScannerConfig.PoorQualityDecodeEffortLevel	poorQualityDecodeEffortLevel This parameter permits selection of enhancement modes for decoding barcodes of poor or degraded quality.
int	sameSymbolTimeout This setting is used to prevent the scanner driver from decoding the same symbol within this time interval.
ScannerConfig.ScanMode	scanMode Sets the scan mode.
ScannerConfig.ViewFinderMode	viewfinderMode Configures the Viewfinder modes supported for camera scanning.
int	viewfinderOffsetX Sets the X Axis position of the top left corner of the view finder.
int	viewfinderOffsetY Sets the Y Axis position of the top left corner of the view finder.
int	viewfinderSize Sets the size of the view finder window in camera scanner.
int	zoom This parameter controls the zoom level for camera.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

continuousRead

@Deprecated
public ScannerConfig.ReaderParams.ReaderSpecific.ContinuousRead continuousRead

Deprecated.

We recommend using the new fields aimType, sameSymbolTimeout, differentSymbolTimeout in your new applications.

ContinuousRead class provides access to continuous scanning related parameters.

beamTimer

public int beamTimer

Sets the maximum amount of time that the reader remains on (0 - 60,000 ms in increments of 100 ms). A value of 0 sets the reader to stay on indefinitely.

 
 	Example Usage:
 	readerParams.beamTimer = 1500;
 

viewfinderSize

public int viewfinderSize

Sets the size of the view finder window in camera scanner. Default is 100, meaning it will show in full screen. As an example, if it is set to 50 View finder of half the full width and half the full height is used to show the preview. The valid range is 0 to 100.

 
 	Example Usage:
 	readerParams.cameraSpecific.viewfinderSize = 50;
 

viewfinderOffsetX

public int viewfinderOffsetX

Sets the X Axis position of the top left corner of the view finder. The valid range is 0 to 100.

 
 	Example Usage:
 	readerParams.cameraSpecific.viewfinderOffsetX = 50;
 

viewfinderOffsetY

public int viewfinderOffsetY

Sets the Y Axis position of the top left corner of the view finder. The valid range is 0 to 100.

 
 	Example Usage:
 	readerParams.cameraSpecific.viewfinderOffsetY = 50;
 

linearSecurityLevel

public ScannerConfig.LinearSecurityLevel linearSecurityLevel

Sets the number of times a barcode is read to confirm an accurate decode. Use enum ScannerConfig.LinearSecurityLevel.

 
 	Example Usage:
 	readerParams.linearSecurityLevel = LinearSecurityLevel.ALL_THRICE;
 

illuminationMode

public ScannerConfig.IlluminationMode illuminationMode

Turns camera illumination on and off. This option is only available when camera is selected in the Barcode input Scanner selection option. Use enum ScannerConfig.IlluminationMode.

 
 	Example Usage:
 	readerParams.cameraSpecific.illuminationMode = IlluminationMode.ON;
 

inverse1DMode

public ScannerConfig.Inverse1DMode inverse1DMode

This parameter allows the user to select decoding on inverse 1D barcodes. Use enum ScannerConfig.Inverse1DMode.

 
 	Example Usage:
 	readerParams.cameraSpecific.inverse_1d_mode = Inverse1DMode.AUTO;
 

viewfinderMode

public ScannerConfig.ViewFinderMode viewfinderMode

Configures the Viewfinder modes supported for camera scanning. Use enum ScannerConfig.ViewFinderMode.

 
 	Example Usage:
 	readerParams.cameraSpecific.viewfinder_mode = ViewFinderMode.DISABLED;
 

oneDQuietZoneLevel

public ScannerConfig.OneDQuietZoneLevel oneDQuietZoneLevel

This parameter sets the effort at which the decoder will attempt to decode margin-less barcodes. Behavior of the level set to this parameter will vary based on the margin-less decoder selected. Note: Higher margin-less levels will increase decoding times and the risk of decoding errors. Zebra therefore recommends enabling only the symbologies that require a higher margin-less level, and leaving all other symbologies at the default level of 1. Use enum ScannerConfig.OneDQuietZoneLevel.

 
 	Example Usage:
 	readerParams.cameraSpecific.oneDQuietZoneLevel = OneDQuietZoneLevel.LEVEL_0;
 

poorQualityDecodeEffortLevel

public ScannerConfig.PoorQualityDecodeEffortLevel poorQualityDecodeEffortLevel

This parameter permits selection of enhancement modes for decoding barcodes of poor or degraded quality. Use enum ScannerConfig.PoorQualityDecodeEffortLevel.

 
 	Example Usage:
 	readerParams.cameraSpecific.poorQualityDecodeEffortLevel = PoorQualityDecodeEffortLevel.LEVEL_0;
 

picklistEx

public ScannerConfig.PicklistEx 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. Use enum ScannerConfig.PicklistEx.

 
 	Example Usage:
 	cameraSpecific.picklistEx = PicklistEx.DISABLED;
 

aimType

public ScannerConfig.AimType aimType

Describes the type of aiming to use.

Note: Setting aimType is recommended instead of ScannerConfig.ReaderParams.ReaderSpecific.ContinuousRead.isContinuousScan. If the application modifies ScannerConfig.ReaderParams.ReaderSpecific.ContinuousRead.isContinuousScan and aimType, the aimType settings will take precedence.

aimTimer

public int aimTimer

Duration in milliseconds for timed aim types ScannerConfig.AimType.TIMED_HOLD and ScannerConfig.AimType.TIMED_RELEASE. Note than this duration must be less than the beamTimer.

sameSymbolTimeout

public int sameSymbolTimeout

This setting is used to prevent the scanner driver from decoding the same symbol within this time interval. This is applicable only for the aim type ScannerConfig.AimType.CONTINUOUS_READ. Basically in the continuous mode the user can perform rapid scan and to prevent the user from decoding the same barcode twice user can set this value to an appropriate interval (in milliseconds). A value of 0 means no interval is required between two successive reads. Boundary values are 0 to 5000 in milliseconds in 500 increments such as 0, 500, 1000... etc

Note: If the application modifies ScannerConfig.ReaderParams.ReaderSpecific.ContinuousRead.sameSymbolTimeout and sameSymbolTimeout, the sameSymbolTimeout settings will take precedence.

differentSymbolTimeout

public int differentSymbolTimeout

This setting is used to prevent the scanner from decoding another symbol within this time interval. This is applicable only for the aim type ScannerConfig.AimType.CONTINUOUS_READ. The user may want to prevent decoding too quickly and set an interval that the user can aim before decoding the next barcode. A value of 0 means no interval is required between two successive reads. Boundary values are 0 to 5000 in milliseconds in 500 increments such as 0, 500, 1000... etc

Note: If the application modifies ScannerConfig.ReaderParams.ReaderSpecific.ContinuousRead.differentSymbolTimeout and differentSymbolTimeout, the differentSymbolTimeout settings will take precedence.

characterSetSelection

public ScannerConfig.CharacterSet characterSetSelection

Sets the character set to be used to decode the returned barcode data. This is generally set to match the encoding of the physical barcode to be scanned. If not set, default character set UTF-8 is used.

 
 	Example Usage:
 	readerParams.readerSpecific.cameraSpecific.characterSetSelection = CharacterSet.UTF_8;
 

autoCharacterSetFailureOption

public ScannerConfig.AutoCharacterSetFailureOption autoCharacterSetFailureOption

If the system cannot find a character set from the preferred order that can correctly decode the data, this will be used as the character set. The output string may not fully accurate.

 
 	Example Usage:
 	readerParams.readerSpecific.cameraSpecific.autoCharacterSetFailureOption = AutoCharacterSetFailureOption.UTF_8;
 

autoCharacterSetPreferredOrder

public ScannerConfig.AutoCharacterSetPreference[] autoCharacterSetPreferredOrder

Sets the preferred character set order to decode the barcode data when character set selection is set to "Auto". Preference order cannot be empty.

 
 	Example Usage:
 	readerParams.readerSpecific.cameraSpecific.autoCharacterSetPreferredOrder = new AutoCharacterSetPreference[]{AutoCharacterSetPreference.GB2312, AutoCharacterSetPreference.UTF_8};
 

scanMode

public ScannerConfig.ScanMode scanMode

Sets the scan mode. This allows to select one type from the ScanMode enum.

 
 	Example Usage:
 	readerParams.readerSpecific.cameraSpecific.scanMode = ScanMode.SINGLE_BARCODE;
 

zoom

public int zoom

This parameter controls the zoom level for camera. Note: Supported value ranges from 1 to 8 in steps of 1. It is recommended to set Camera Zoom value to 2 for decoding DotCode symbology.

digimarcDecoding

public boolean digimarcDecoding

Enables or disables the Digimarc decoding.

 
 	Example Usage:
 	readerParams.readerSpecific.cameraSpecific.digimarcDecoding = true;