capacitor-plugin-scanbot-sdk/dist/esm/Mrz.d.ts

Scanbot Document and Barcode Scanner SDK for Capacitor

import type { ImageInput, ResultWrapper } from './types/base/customTypes';
import type { MrzScannerConfiguration, MrzScannerResult } from './types/core/mrz/MrzTypes';
import type { MrzScannerScreenConfiguration } from './types/core/ui_v2/mrz/MrzScannerScreenConfiguration';
import type { MrzScannerUiResult } from './types/core/ui_v2/mrz/MrzScannerUiResult';
/**
 * Entry point for all MRZ scanning features.
 */
export declare const ScanbotMrz: {
    /**
     * Opens the Ready-To-Use UI MRZ scanner with the desired configuration.
     * @param {MrzScannerScreenConfiguration} configuration - The MRZ scanner configuration to be used for scanning.
     * @returns {Promise<ResultWrapper<MrzScannerUiResult>>} - The result of the MRZ scanning operation.
     */
    startScanner(configuration: MrzScannerScreenConfiguration): Promise<ResultWrapper<MrzScannerUiResult>>;
    /**
     * Scans MRZ from a given image with the desired configuration.
     * @param {ImageInput} params.image - The image to be used for scanning.
     * @param {MrzScannerConfiguration} params.configuration - The MRZ scanner configuration to be used for scanning.
     * @returns {Promise<MrzScannerResult>} - The result of the MRZ scanning operation.
     */
    scanFromImage(params: {
        image: ImageInput;
        configuration: MrzScannerConfiguration;
    }): Promise<MrzScannerResult>;
};