com.symbol.emdk.barcode

Class ScannerConfig.ScanParams

java.lang.Object

com.symbol.emdk.barcode.ScannerConfig.ScanParams

Enclosing class:

ScannerConfig

public class ScannerConfig.ScanParams
extends java.lang.Object

The ScanParams class 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.ReaderParams and Config.InterfaceParams) will be set automatically.

Field Summary

Fields

Modifier and Type	Field and Description
ScannerConfig.AudioStreamType	audioStreamType The audio stream type refers to type of streaming on which the scan beep should be played.
ScannerConfig.CodeIdType	codeIdType A Code ID character identifies the code type of a scanned barcode.
ScannerConfig.DecodeAudioFeedbackMode	decodeAudioFeedbackMode Controls the audio feedback mode.
java.lang.String	decodeAudioFeedbackUri Select an audio tone to sound upon a good decode.
boolean	decodeHapticFeedback Enable the device to vibrate upon a good decode.
boolean	decodeLEDFeedback Decoding LED Notification.
ScannerConfig.DecodeLEDFeedbackMode	decodeLEDFeedbackMode Controls the LED feedback mode.
int	decodeLEDTime Decode LED ON duration upon successful decode in milliseconds.
boolean	decodeScreenNotification Displays a screen overlay as a notification on a successful decode.
int	decodeScreenNotificationTime Length of time (in milliseconds) to display the screen overlay upon successful decode.
int	decodeScreenTranslucencyLevel Sets the percentage of translucency of decode screen notification overlay.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

codeIdType

public ScannerConfig.CodeIdType codeIdType

A Code ID character identifies the code type of a scanned barcode. This is useful when the reader is decoding more than one code type. Select a code ID character to insert between the prefix and the decoded symbol. Use enum ScannerConfig.CodeIdType.

 
 	Example Usage:
 	scanParams.codeIdType = CODE_ID_TYPE.NONE;
 
 

decodeAudioFeedbackUri

public java.lang.String decodeAudioFeedbackUri

Select an audio tone to sound upon a good decode. The valid audio files from the RingTone manager can be used for audio feedback. The audio tones stored as Application's private data (i.e. cache, asset) should not be specified for this field (decodeAudioFeedbackUri in ScanParams) to avoid access violation. Therefore any audio tones meant for this purpose must be stored under shared public directories (Music/ , Ringtones/) or shared "external storage".

 
 	Example Usage:
 	scanParams.decodeAudioFeedbackURI = "system/media/audio/notifications/decode-short.wav"; 
	scanParams.decodeAudioFeedbackUri = "sdcard/sample-audio.wav";
	scanParams.decodeAudioFeedbackUri = "sdcard/sample-audio.ogg";
	scanParams.decodeAudioFeedbackUri = "/sdcard/sample-audio.wav";
 
 

Notes:

1. To achieve no feedback (silent) upon a good decode, specify an empty string as below:
   scanParams.decodeAudioFeedbackURI = "";
2. Specifying any custom audio file with the same name as one of the system audio files (/system/media/audio/notifications/) for decodeAudioFeedbackUri in ScannerConfig.ScannerParams will play a system audio file instead of the specified custom audio file. This is working as designed.

decodeHapticFeedback

public boolean decodeHapticFeedback

Enable the device to vibrate upon a good decode.

 
 	Example Usage:
 	scanParams.decodeHapticFeedback = true;
 
 

decodeLEDTime

public int decodeLEDTime

Decode LED ON duration upon successful decode in milliseconds. This value can be from 0ms to 1000ms with a step of 25ms.

 
 	Example Usage:
 	scanParams.decodeLEDTime = 75;
 
 

audioStreamType

public ScannerConfig.AudioStreamType audioStreamType

The audio stream type refers to type of streaming on which the scan beep should be played. The decodeAudioFeedbackUri specified must be available for the audio streaming type specified.

 
 	Example Usage:
 	scanParams.audioStreamType = AudioStreamType.RINGER;
 
 

decodeLEDFeedback

public boolean decodeLEDFeedback

Decoding LED Notification.

 
 	Example Usage:
 	scanParams.decodeLEDFeedback = true;
 
 

decodeLEDFeedbackMode

public ScannerConfig.DecodeLEDFeedbackMode decodeLEDFeedbackMode

Controls the LED feedback mode.

 
 	Example Usage:
 	scanParams.decodeLEDFeedbackMode = DecodeLEDFeedbackMode.LOCAL;
 
 

decodeAudioFeedbackMode

public ScannerConfig.DecodeAudioFeedbackMode decodeAudioFeedbackMode

Controls the audio feedback mode.

 
 	Example Usage:
 	scanParams.decodeAudioFeedbackMode = DecodeAudioFeedbackMode.LOCAL;
 
 

decodeScreenNotification

public boolean decodeScreenNotification

Displays a screen overlay as a notification on a successful decode.

 
 	Example Usage:
 	scanParams.decodeScreenNotification = true;
 
 

decodeScreenNotificationTime

public int decodeScreenNotificationTime

Length of time (in milliseconds) to display the screen overlay upon successful decode.

 
 Example Usage:
 scanParams.decodeScreenNotificationTime = 1000;
 
 

decodeScreenTranslucencyLevel

public int decodeScreenTranslucencyLevel

Sets the percentage of translucency of decode screen notification overlay. This value can be from 20 to 50 with a step of 5.

 
 Example Usage:
 scanParams.decodeScreenTranslucencyLevel = 35;