ScanSettings

interface ScanSettings

• intervalTime?: number

  Scan interval used to allow the library to release the CPU periodically. Measured in ms. The default value is 0.

• duplicateForgetTime?: number

  Ignore duplicated results found in the specified time period. Measured in ms. The default value is 3000, the maximum is 10000.

• whenToPlaySoundforSuccessfulRead?: string

  Sets when to play sound on barcode recognition (user input is required on iOS or Chrome for any sound to play). Allowed values are

  • never : never play sound, the default value;
  • frame : play sound when one or multiple barcodes are found on a frame;
  • unique : play sound when a unique barcode is found (if multiple unique barcodes are found on the same frame, play only once).

• soundOnSuccessfullRead?: string

  Specifies the sound to play on barcode recognition. If not specified, the default one is used.

• whenToVibrateforSuccessfulRead?: string

  Sets when to vibrate on barcode recognition (user input is required on iOS or Chrome for the vibration). Allowed values are

  • never: never vibrate, the default value;
  • frame: vibrate when one or multiple barcodes are found on a frame;
  • unique: vibrate when a unique barcode is found (if multiple unique barcodes are found on the same frame, vibrate only once).

• vibrateDuration?: number

  Returns or sets how long the vibration lasts in milliseconds. The default value is 300 .

let scanSettings = await scanner.getScanSettings();
scanSettings.intervalTime = 100; // 100ms
scanSettings.whenToPlaySoundforSuccessfulRead = "never";
scanSettings.whenToVibrateforSuccessfulRead = "never";
scanSettings.duplicateForgetTime = 3000; // 3s
await scanner.updateScanSettings(scanSettings);

• captureAndDecodeInParallel?: boolean

  Returns or sets whether to capture the next frame while the previous frame is being decoded to save time. The default value is true.

• autoZoom?: boolean

  Returns or sets whether to automatically zoom in on the video if the barcode appears too small in the video feed and fails to be read. This feature requires a intermediate_results module license. The default value is false.

• autoFocus?: boolean

  Returns or sets whether to automatically focus on the video when a barcode is found but fails to be read. This feature requires a intermediate_results module license. The default value is false.

• autoSuggestTip? boolean

  Returns or sets whether to automatically suggest Tip messages. This feature requires a intermediate_results module license. The default value is false.