Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SymbologySettings

A symbology-specific configuration object.

See https://docs.scandit.com/stable/c_api/symbologies.html for more details.

Hierarchy

  • SymbologySettings

Index

Methods

disableChecksums

disableExtensions

enableChecksums

enableExtensions

getActiveSymbolCounts

  • getActiveSymbolCounts(): number[]
  • Get the current list of active symbol counts.

    Returns number[]

    The list of active symbol counts.

getEnabledChecksums

  • Get the current set of enabled optional checksums.

    Note that the external Scandit Engine library will also use any applicable mandatory checksum for the symbology.

    Returns Set<Checksum>

    The set of enabled checksums.

getEnabledExtensions

  • Get the current set of enabled optional extensions.

    Note that the external Scandit Engine library will also use any applicable mandatory extension for the symbology.

    Returns Set<Extension>

    The set of enabled extensions.

isColorInvertedEnabled

  • isColorInvertedEnabled(): boolean
  • Returns boolean

    Whether color inverted recognition is enabled.

isEnabled

  • isEnabled(): boolean
  • Returns boolean

    Whether the symbology enabled for recognition.

setActiveSymbolCounts

  • Set the list of active symbol counts.

    If an empty or invalid symbol count range is given, the range will be set to its default value.

    Parameters

    • activeSymbolCounts: number[]

      The list of active symbol counts.

    Returns SymbologySettings

    The updated SymbologySettings object.

setActiveSymbolCountsRange

  • Set the (inclusive) range of active symbol counts.

    If an empty or invalid symbol count range is given, the range will be set to its default value.

    Parameters

    • minCount: number

      The minimum accepted number of symbols.

    • maxCount: number

      The maximum accepted number of symbols.

    Returns SymbologySettings

    The updated SymbologySettings object.

setColorInvertedEnabled

  • Enable or disable recognition of inverted-color symbology (in addition to normal colors).

    Parameters

    • enabled: boolean

      Whether color inverted recognition is enabled.

    Returns SymbologySettings

    The updated SymbologySettings object.

setEnabled

  • Enable or disable recognition of the symbology.

    Parameters

    • enabled: boolean

      Whether the symbology is enabled for recognition.

    Returns SymbologySettings

    The updated SymbologySettings object.

Generated using TypeDoc