Class VinScanner

API for VIN scanning.

Methods

cleanRecognitionQueue destroy run create

Methods

cleanRecognitionQueue

  • cleanRecognitionQueue(): Promise<void>

  • Clean the queue of recognized VIN.@returns

    Returns Promise<void>

destroy

  • destroy(): Promise<void>

  • Frees up any resources associated with this object. No other methods may be called on this object after destroy has been called.

    Returns Promise<void>

run

  • run(image, consumeImage?): Promise<VinScannerRunResponse>

  • Recognize VIN in the given image.

    Parameters

    • image: Image

      The image to recognize VIN in.

    • Optional consumeImage: Config.ConsumeType

      Controls if the image can still be used after calling this method, or if it will be consumed by the method. See ConsumeType for more details.

    Returns Promise<VinScannerRunResponse>

    The recognized text line.

Static create

  • create(workerBridge, configuration?): Promise<VinScanner>

  • Parameters

    • workerBridge: WorkerBridge
    • Optional configuration: {
          extractVINFromBarcode?: boolean;
          maximumNumberOfAccumulatedFrames?: number;
          minimumNumberOfRequiredFramesWithEqualScanningResult?: number;
          ocrResolutionLimit?: number;
          optimizeSingleLine?: boolean;
      }
      • Optional extractVINFromBarcode?: boolean

        If true, the VIN scanner will also extract VINs from barcodes. Requires a license that allows barcode scanning in addition to VIN scanning.

        Default Value

        false;
      • Optional maximumNumberOfAccumulatedFrames?: number

        Maximum number of accumulated frames to inspect before actual result is returned.

        Default Value

        3;
      • Optional minimumNumberOfRequiredFramesWithEqualScanningResult?: number

        Minimum number of accumulated frames that have equal result.

        Default Value

        2;
      • Optional ocrResolutionLimit?: number

        Maximum image size (height or width) for OCR process. 0 - do not rescale.

        Default Value

        0;
      • Optional optimizeSingleLine?: boolean

        Optimize for scanning a single line or a single word. Enable this option when scanning a single line or single word that are hard to scan reliably.

        Default Value

        true;

    Returns Promise<VinScanner>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc