Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ScanSettings

A configuration object for scanning options.

Modified ScanSettings need to be applied to a scanner via BarcodePicker.applyScanSettings or Scanner.applyScanSettings to take effect.

Hierarchy

  • ScanSettings

Index

Constructors

constructor

  • new ScanSettings(__namedParameters?: object): ScanSettings
  • Creates a ScanSettings instance.

    Parameters

    Returns ScanSettings

Methods

disableSymbologies

  • Disable recognition of a symbology or list/set of symbologies.

    Parameters

    Returns ScanSettings

    The updated ScanSettings object.

enableSymbologies

  • Enable recognition of a symbology or list/set of symbologies.

    Parameters

    Returns ScanSettings

    The updated ScanSettings object.

getCodeDuplicateFilter

  • getCodeDuplicateFilter(): number
  • When the filter is set to -1, each unique code is only scanned once. When set to 0, duplicate filtering is disabled. Otherwise the duplicate filter specifies an interval in milliseconds.

    Returns number

    The code duplicate filter value.

getMaxNumberOfCodesPerFrame

  • getMaxNumberOfCodesPerFrame(): number
  • Returns number

    The maximum number of barcodes to be recognized every frame.

getSearchArea

  • Returns SearchArea

    The area of the image in which barcodes are searched.

getSymbologySettings

  • Get the configuration object for a symbology (which can then be modified).

    Parameters

    • symbology: Symbology

      The symbology for which to retrieve the configuration.

    Returns SymbologySettings

    The symbology configuration object for the specified symbology.

isSymbologyEnabled

  • isSymbologyEnabled(symbology: Symbology): boolean
  • Get the recognition enabled status for a symbology.

    Parameters

    • symbology: Symbology

      The symbology for which to retrieve the recognition enabled status.

    Returns boolean

    Whether the symbology enabled for recognition.

setCodeDuplicateFilter

  • setCodeDuplicateFilter(durationMilliseconds: number): ScanSettings
  • Set the code duplicate filter value.

    When the filter is set to -1, each unique code is only scanned once. When set to 0, duplicate filtering is disabled. Otherwise the duplicate filter specifies an interval in milliseconds.

    Parameters

    • durationMilliseconds: number

      The new value (-1, 0, or positive integer).

    Returns ScanSettings

    The updated ScanSettings object.

setMaxNumberOfCodesPerFrame

  • Set the maximum number of barcodes to be recognized every frame.

    Parameters

    • limit: number

      The new value (non-zero positive integer).

    Returns ScanSettings

    The updated ScanSettings object.

setSearchArea

  • Set the area of the image in which barcodes are searched.

    Parameters

    Returns ScanSettings

    The updated ScanSettings object.

toJSONString

  • toJSONString(): string
  • Returns string

    The configuration object as a JSON string.

Generated using TypeDoc