Interface UseHeadlessVideoScannerOptions

Options for configuring the VideoScanner.

interface UseHeadlessVideoScannerOptions {
    negativeDebounce?: number;
    onRepaint?: (() => unknown);
    onScanClose?: (() => unknown);
    onScanDetect?: ((readResults) => unknown);
    onScanStart?: (() => unknown);
    onScanStop?: (() => unknown);
    onScanUpdate?: ((readResults) => unknown);
    readerOptions?: ReaderOptions;
    scanThrottle?: number;
    scanning?: boolean;
    wasmLocation?: string;
}

Hierarchy (view full)

Properties

negativeDebounce? onRepaint? onScanClose? onScanDetect? onScanStart? onScanStop? onScanUpdate? readerOptions? scanThrottle? scanning? wasmLocation?

Properties

Optional negativeDebounce

negativeDebounce?: number

Minimum duration in milliseconds before a negative result is confirmed.

Optional onRepaint

onRepaint?: (() => unknown)

Callback function that is triggered when the browser repaints.

Type declaration

    • (): unknown

    • Callback function that is triggered when the browser repaints.

      Returns unknown

Optional onScanClose

onScanClose?: (() => unknown)

Callback function that is triggered when the scanning process is closed.

Type declaration

    • (): unknown

    • Callback function that is triggered when the scanning process is closed.

      Returns unknown

Optional onScanDetect

onScanDetect?: ((readResults) => unknown)

Callback function that is triggered when a new barcode is detected.

Type declaration

    • (readResults): unknown

    • Callback function that is triggered when a new barcode is detected.

      Parameters

      • readResults: ReadResult[]

        Array of detected barcodes.

      Returns unknown

Param: readResults

Array of detected barcodes.

Optional onScanStart

onScanStart?: (() => unknown)

Callback function that is triggered when the scanning process starts.

Type declaration

    • (): unknown

    • Callback function that is triggered when the scanning process starts.

      Returns unknown

Optional onScanStop

onScanStop?: (() => unknown)

Callback function that is triggered when the scanning process stops.

Type declaration

    • (): unknown

    • Callback function that is triggered when the scanning process stops.

      Returns unknown

Optional onScanUpdate

onScanUpdate?: ((readResults) => unknown)

Callback function that is triggered on each scan update, regardless of new detections.

Type declaration

    • (readResults): unknown

    • Callback function that is triggered on each scan update, regardless of new detections.

      Parameters

      • readResults: ReadResult[]

        Array of detected barcodes.

      Returns unknown

Param: readResults

Array of detected barcodes.

Optional readerOptions

readerOptions?: ReaderOptions

Configuration options for the ZXing barcode reader.

Optional scanThrottle

scanThrottle?: number

Minimum interval in milliseconds between scan operations to throttle the scan frequency.

Optional scanning

scanning?: boolean

control the activation of scanning

Optional wasmLocation

wasmLocation?: string

Location of the ZXing WebAssembly (WASM) file used for barcode decoding.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc