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

Scanbot Document and Barcode Scanner SDK for Capacitor

import type { ImageInput } from './types/base/customTypes';
import type { DocumentStraighteningParameters, DocumentStraighteningResult } from './types/core/document_scanner/DocumentEnhancerTypes';
import type { Point } from './types/core/utils/utils';
/**
 * Entry point for all Document Enhancer features.
 */
export declare const ScanbotDocumentEnhancer: {
    /**
     * Straightens the document effectively straightening its edges and text.
     * @param {ImageInput} params.image - The image of the document to straighten.
     * @param {DocumentStraighteningParameters} params.straighteningParameters - The parameters to use for straightening.
     * @param {Point[]} params.priorCornersNormalized - If the corners are already known (e.g. from a prior detection), they can be provided here. The enhancer may take them into account to locate the document more accurately.
     * @returns {Promise<DocumentStraighteningResult>} - The result of the straightening operation.
     */
    straightenImage(params: {
        image: ImageInput;
        straighteningParameters: DocumentStraighteningParameters;
        priorCornersNormalized?: Point[];
    }): Promise<DocumentStraighteningResult>;
};