ScannerConfig.ScanParams

EMDK For Android 5.0

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.

Public Fields

codeIdType

A Code ID character identifies the code type of a scanned bar code. 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;

Type:

com.symbol.emdk.barcode.ScannerConfig.CodeIdType

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";

Type:

java.lang.String

decodeHapticFeedback

Enable the device to vibrate upon a good decode.

Example Usage:


scanParams.decodeHapticFeedback = true;

Type:

boolean

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;

Type:

int

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;

Type:

com.symbol.emdk.barcode.ScannerConfig.AudioStreamType

decodeLEDFeedback

Decoding LED Notification.

Example Usage:


scanParams.decodeLEDFeedback = true;

Type:

boolean

decodeLEDFeedbackMode

Controls the LED feedback mode.

Example Usage:


scanParams.decodeLEDFeedbackMode = DecodeLEDFeedbackMode.LOCAL;

Type:

com.symbol.emdk.barcode.ScannerConfig.DecodeLEDFeedbackMode

decodeAudioFeedbackMode

Controls the audio feedback mode.

Example Usage:


scanParams.decodeAudioFeedbackMode = DecodeAudioFeedbackMode.LOCAL;

Type:

com.symbol.emdk.barcode.ScannerConfig.DecodeAudioFeedbackMode