react-native-scanbot-barcode-scanner-sdk/lib/typescript/src/Sdk.d.ts

Scanbot Barcode Scanner SDK React Native Plugin for Android and iOS

import { SdkConfiguration } from './types/base/SdkConfiguration';
import { LicenseInfo } from './types/core/licensing/LicensingTypes';
/**
 * Entry point for all features that are part of Scanbot Barcode Scanner SDK.
 */
export declare const ScanbotBarcodeSdk: {
    /**
     * Used for barcode scanning features.
     */
    Barcode: {
        startScanner(configuration: import("./types").BarcodeScannerScreenConfiguration): Promise<import("./types").ResultWrapper<import("./types").BarcodeScannerUiResult>>;
        scanFromImage(params: {
            image: import("./types").ImageInput;
            configuration: import("./types").BarcodeScannerConfiguration;
        }): Promise<import("./types").BarcodeScannerResult>;
        scanFromPdf(params: {
            pdfFileUri: string;
            configuration: import("./types").BarcodeScannerConfiguration;
        }): Promise<import("./types").BarcodeScannerResult>;
        parseDocument(params: {
            rawText: string;
            acceptedFormats?: import("./types").BarcodeDocumentFormat[] | undefined;
        }): Promise<import("./types").BarcodeDocumentParserResult>;
    };
    /**
     * Used for image processing features.
     */
    ImageProcessor: {
        readImageData(imageFileUri: string): Promise<string>;
    };
    /**
     * Mock camera preview by using static images as a frame source. This is useful for testing purposes.
     * @param {string} params.imageFileUri - The file uri of the image to be used as a mock camera frame.
     * @param {boolean} params.refreshOnEachFrame - If true, the mock camera will refresh the frame on each request, simulating a live camera feed. Default is false
     * @returns {Promise<void>}
     */
    mockCamera(params: {
        imageFileUri: string;
        refreshOnEachFrame?: boolean;
    }): Promise<void>;
    /**
     * Initializes the Scanbot SDK with the preferred configuration.
     * @param {SdkConfiguration} configuration - The SDK configuration to be used for initialization.
     * @returns {Promise<LicenseInfo>} - Returns complete information about the license used for initialization.
     */
    initialize(configuration: SdkConfiguration): Promise<LicenseInfo>;
    /**
     * Provides complete information about the current license.
     * @returns {Promise<LicenseInfo>} - Returns complete information about the current license.
     */
    getLicenseInfo(): Promise<LicenseInfo>;
    /**
     * Cleans up the storage used by the Scanbot SDK.
     * @returns {Promise<void>}
     */
    cleanupStorage(): Promise<void>;
};
//# sourceMappingURL=Sdk.d.ts.map