react-native-scanbot-sdk/lib/typescript/src/vin/VinScannerTypes.d.ts

Scanbot Document and Barcode Scanner SDK React Native Plugin for Android and iOS

import { TextPatternScannerResult } from '../text_pattern_scanner/TextPatternScannerTypes';
import { ToJsonConfiguration } from '../utils/json/JsonSerializationTypes';
import { DeepPartial, PartiallyConstructible, Point } from '../utils/utils';
/**
Status of the barcode extraction.

- `SUCCESS`:
   Barcode containing a VIN was successfully extracted.
- `BARCODE_WITHOUT_VIN`:
   Barcode was found but it does not contain a VIN.
- `NO_BARCODE_FOUND`:
   No barcode was found in the image.
- `BARCODE_EXTRACTION_DISABLED`:
   Barcode extraction is disabled in the configuration.
*/
export type VinBarcodeExtractionStatus = 'SUCCESS' | 'BARCODE_WITHOUT_VIN' | 'NO_BARCODE_FOUND' | 'BARCODE_EXTRACTION_DISABLED';
export declare const VinBarcodeExtractionStatusValues: VinBarcodeExtractionStatus[];
/**
Result of the barcode scanner.
*/
export declare class VinBarcodeResult extends PartiallyConstructible {
    /**
      Text result of the barcode scanner.
      */
    readonly extractedVIN: string;
    /**
      Rectangle of the barcode in the image.
      */
    readonly rectangle: Point[];
    /**
      Status of the barcode extraction.
      */
    readonly status: VinBarcodeExtractionStatus;
    /** @param source {@displayType `DeepPartial<VinBarcodeResult>`} */
    constructor(source?: DeepPartial<VinBarcodeResult>);
    serialize(config?: ToJsonConfiguration): DeepPartial<VinBarcodeResult>;
}
/**
Result of the VIN scanner.
*/
export declare class VinScannerResult extends PartiallyConstructible {
    /**
      Text result of the VIN scanner.
      */
    readonly textResult: TextPatternScannerResult;
    /**
      Barcode result of the VIN scanner.
      */
    readonly barcodeResult: VinBarcodeResult;
    /** @param source {@displayType `DeepPartial<VinScannerResult>`} */
    constructor(source?: DeepPartial<VinScannerResult>);
    serialize(config?: ToJsonConfiguration): DeepPartial<VinScannerResult>;
}
/**
Configuration for the VIN scanner.
*/
export declare class VinScannerConfiguration extends PartiallyConstructible {
    /**
      If true, the VIN scanner will also extract VINs from barcodes.
      Requires a license that allows barcode scanning in addition to VIN scanning.
      
      Default is false
      */
    extractVINFromBarcode: boolean;
    /**
      Maximum image size (height or width) for OCR process. 0 - do not rescale.
      
      Default is 0
      */
    ocrResolutionLimit: number;
    /**
      Maximum number of accumulated frames to inspect before actual result is returned.
      
      Default is 3
      */
    maximumNumberOfAccumulatedFrames: number;
    /**
      Minimum number of accumulated frames that have equal result.
      
      Default is 2
      */
    minimumNumberOfRequiredFramesWithEqualScanningResult: number;
    /** @param source {@displayType `DeepPartial<VinScannerConfiguration>`} */
    constructor(source?: DeepPartial<VinScannerConfiguration>);
}
//# sourceMappingURL=VinScannerTypes.d.ts.map