Class BarcodeScannerConfiguration

Hierarchy

  • ScannerConfiguration
    • BarcodeScannerConfiguration

Constructors

constructor

Properties

_onDetectionFailed? barcodeFormats? captureDelay? container? containerId? engineMode? mirrored? onBarcodesDetected? onError overlay? preferredCamera? returnBarcodeImage? scanAndCount? showFinder? style? videoConstraints? zoom? DEFAULT_ACCEPTED_ANGLE_SCORE DEFAULT_ACCEPTED_SIZE_SCORE DEFAULT_VIDEO_RESOLUTION_4K DEFAULT_VIDEO_RESOLUTION_HD

Methods

fromJson mapValues mapValuesDeep

Constructors

constructor

Properties

Optional _onDetectionFailed

_onDetectionFailed?: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: ImageData

      Returns void

Optional barcodeFormats

barcodeFormats?: BarcodeFormat[]

Optional captureDelay

captureDelay?: number

Capture delay in milliseconds after detecting barcodes. Defaults to 1000

Optional container

container?: HTMLElement

The container HTML element of Scanbot Web SDK camera. Required when 'containerId' property is left undefined when calling any ScanbotSDK createScanner function. If both are provided, 'container' property takes precedence.

Optional containerId

containerId?: string

The container HTML element id of Scanbot Web SDK camera. Required when 'container' property is left undefined when calling any ScanbotSDK createScanner function If both are provided, 'container' property takes precedence.

Optional engineMode

engineMode?: EngineMode

Optional mirrored

mirrored?: boolean

Optional onBarcodesDetected

onBarcodesDetected?: ((e) => void)

Type declaration

onError

onError: ((e) => void)

Type declaration

    • (e): void

    • Error callback of the SDK.

      Parameters

      • e: any

      Returns void

Optional overlay

overlay?: SelectionOverlayConfiguration

Optional preferredCamera

preferredCamera?: string

Optional returnBarcodeImage

returnBarcodeImage?: boolean

Optional scanAndCount

scanAndCount?: BarcodeCountConfiguration

Special property to enable barcode count mode. This is a type of a ready-to-use user interface scanning and counting found barcodes. It can be configured via its 'style' (BarcodeCountStyleConfiguration) property. It returns results normally via 'onBarcodesDetected' callback. Please note that results are returned for each consecutive scan, not only after the last scan

Optional showFinder

showFinder?: boolean

Optional style

style?: ViewFinderConfiguration

Optional videoConstraints

videoConstraints?: any

ScanbotCameraView video constraints

Optional zoom

zoom?: number

Digital zoom level of the video stream. Defaults to 1.0. Please note that this is not the same as the optical zoom of the camera.

Static DEFAULT_ACCEPTED_ANGLE_SCORE

DEFAULT_ACCEPTED_ANGLE_SCORE: number

Static DEFAULT_ACCEPTED_SIZE_SCORE

DEFAULT_ACCEPTED_SIZE_SCORE: number

Static DEFAULT_VIDEO_RESOLUTION_4K

DEFAULT_VIDEO_RESOLUTION_4K: {
    height: number;
    width: number;
}

Type declaration

  • height: number
  • width: number

Static DEFAULT_VIDEO_RESOLUTION_HD

DEFAULT_VIDEO_RESOLUTION_HD: {
    height: number;
    width: number;
}

Type declaration

  • height: number
  • width: number

Methods

Static fromJson

Static mapValues

  • mapValues(source, destination, ignore?): void

  • Parameters

    • source: any
    • destination: {
          [key: string]: any;
      }
      • [key: string]: any
    • Optional ignore: string[]

    Returns void

Static mapValuesDeep

  • mapValuesDeep(source, destination): void

  • Parameters

    • source: any
    • destination: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc