capacitor-plugin-scanbot-barcode-scanner-sdk
    Preparing search index...

    Variable ScanbotBarcodeSDKConst

    ScanbotBarcodeSDK: {
        Barcode: {
            parseDocument(
                params: { acceptedFormats?: BarcodeDocumentFormat[]; rawText: string },
            ): Promise<BarcodeDocumentParserResult>;
            scanFromImage(
                params: {
                    configuration: BarcodeScannerConfiguration;
                    image: ImageInput;
                },
            ): Promise<BarcodeScannerResult>;
            scanFromPdf(
                params: {
                    configuration: BarcodeScannerConfiguration;
                    pdfFileUri: string;
                },
            ): Promise<BarcodeScannerResult>;
            startScanner(
                configuration: BarcodeScannerScreenConfiguration,
            ): Promise<ResultWrapper<BarcodeScannerUiResult>>;
        };
        ImageProcessor: { readImageData(imageFileUri: string): Promise<string> };
        cleanupStorage(): Promise<void>;
        getLicenseInfo(): Promise<LicenseInfo>;
        initialize(configuration: SdkConfiguration): Promise<LicenseInfo>;
        mockCamera(
            params: { imageFileUri: string; refreshOnEachFrame?: boolean },
        ): Promise<void>;
    }

    Entry point for all features that are part of Scanbot Barcode Scanner SDK.

    Type Declaration

    • Barcode: {
          parseDocument(
              params: { acceptedFormats?: BarcodeDocumentFormat[]; rawText: string },
          ): Promise<BarcodeDocumentParserResult>;
          scanFromImage(
              params: {
                  configuration: BarcodeScannerConfiguration;
                  image: ImageInput;
              },
          ): Promise<BarcodeScannerResult>;
          scanFromPdf(
              params: {
                  configuration: BarcodeScannerConfiguration;
                  pdfFileUri: string;
              },
          ): Promise<BarcodeScannerResult>;
          startScanner(
              configuration: BarcodeScannerScreenConfiguration,
          ): Promise<ResultWrapper<BarcodeScannerUiResult>>;
      }

      Used for barcode scanning features.

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

      Used for image processing features.

    • cleanupStorage: function
      • Cleans up the storage used by the Scanbot SDK.

        Returns Promise<void>

    • getLicenseInfo: function
      • Provides complete information about the current license.

        Returns Promise<LicenseInfo>

        • Returns complete information about the current license.
    • initialize: function
      • 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
      • 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.

          • OptionalrefreshOnEachFrame?: boolean

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

        Returns Promise<void>