Variable ScanbotBarcodeSdkConst

Type declaration

• Barcode: {
      parseDocument(params): Promise<BarcodeDocumentParserResult>;
      scanFromImage(params): Promise<BarcodeScannerResult>;
      scanFromPdf(params): Promise<BarcodeScannerResult>;
      startScanner(configuration): Promise<ResultWrapper<BarcodeScannerUiResult>>;
  }

  Used for barcode scanning features.

  • parseDocument:function

    • parseDocument(params): Promise<BarcodeDocumentParserResult>

    • Parameters

      • params: {
            acceptedFormats?: BarcodeDocumentFormat[];
            rawText: string;
        }

        • Optional acceptedFormats?: BarcodeDocumentFormat[]

        • rawText: string

      Returns Promise<BarcodeDocumentParserResult>

  • scanFromImage:function

    • scanFromImage(params): Promise<BarcodeScannerResult>

    • Parameters

      • params: {
            configuration: BarcodeScannerConfiguration;
            image: ImageInput;
        }

        • configuration: BarcodeScannerConfiguration

        • image: ImageInput

      Returns Promise<BarcodeScannerResult>

  • scanFromPdf:function

    • scanFromPdf(params): Promise<BarcodeScannerResult>

    • Parameters

      • params: {
            configuration: BarcodeScannerConfiguration;
            pdfFileUri: string;
        }

        • configuration: BarcodeScannerConfiguration

        • pdfFileUri: string

      Returns Promise<BarcodeScannerResult>

  • startScanner:function

    • startScanner(configuration): Promise<ResultWrapper<BarcodeScannerUiResult>>

    • Parameters

      • configuration: BarcodeScannerScreenConfiguration

      Returns Promise<ResultWrapper<BarcodeScannerUiResult>>

• ImageProcessor: {
      readImageData(imageFileUri): Promise<string>;
  }

  Used for image processing features.

  • readImageData:function

    • readImageData(imageFileUri): Promise<string>

    • Parameters

      • imageFileUri: string

      Returns Promise<string>

• cleanupStorage:function

  • cleanupStorage(): Promise<void>

  • Cleans up the storage used by the Scanbot SDK.

    Returns Promise<void>

• getLicenseInfo:function

  • getLicenseInfo(): Promise<LicenseInfo>

  • Provides complete information about the current license.

    Returns Promise<LicenseInfo>

    • Returns complete information about the current license.

• initialize:function

  • initialize(configuration): Promise<LicenseInfo>

  • Initializes the Scanbot SDK with the preferred configuration.

    Parameters

    • configuration: SdkConfiguration

      The SDK configuration to be used for initialization.

    Returns Promise<LicenseInfo>

    • Returns complete information about the license used for initialization.

• mockCamera:function

  • mockCamera(params): Promise<void>

  • Mock camera preview by using static images as a frame source. This is useful for testing purposes.

    Parameters

    • params: {
          imageFileUri: string;
          refreshOnEachFrame?: boolean;
      }

      • imageFileUri: string

        The file uri of the image to be used as a mock camera frame.

      • Optional refreshOnEachFrame?: boolean

        If true, the mock camera will refresh the frame on each request, simulating a live camera feed. Default is false

    Returns Promise<void>