Dev Center
Table of contents

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.

  • 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.

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

version 9.3.1

  • Latest version(10.2.10)
  • Version 10.x
    • Version 10.0.21
    • Version 10.0.20
  • Version 9.x
    • Version 9.6.40
    • Version 9.6.33
    • Version 9.6.32
    • Version 9.6.31
    • Version 9.6.30
    • Version 9.6.21
    • Version 9.6.20
    • Version 9.6.11
    • Version 9.6.10
    • Version 9.6.2
    • Version 9.6.1
    • Version 9.6.0
    • Version 9.3.1
    • Version 9.3.0
    • Version 9.2.13
    • Version 9.2.12
    • Version 9.2.11
    • Version 9.0.2
    • Version 9.0.1
    • Version 9.0.0
  • Version 8.x
    • Version 8.8.7
    • Version 8.8.5
    • Version 8.8.3
    • Version 8.8.0
    • Version 8.6.3
    • Version 8.6.0
    • Version 8.4.0
    • Version 8.2.5
    • Version 8.2.3
    • Version 8.2.1
    • Version 8.2.0
    • Version 8.1.3
    • Version 8.1.2
    • Version 8.1.0
    • Version 8.0.0
  • Version 7.x
    • Version 7.6.0
    • Version 7.5.0
Change +