@capacitor-community/image-to-text/dist/esm/definitions.d.ts

Image to Text (OCR) Plugin for Capacitor

export interface CapacitorOcrPlugin {
    /**
     * Detect text in an image
     * @param options Options for text detection
     */
    detectText(options: DetectTextFileOptions | DetectTextBase64Options): Promise<TextDetections>;
}
export interface DetectTextFileOptions {
    filename: string;
    orientation?: ImageOrientation;
}
export interface DetectTextBase64Options {
    base64: string;
    orientation?: ImageOrientation;
}
export interface TextDetections {
    textDetections: TextDetection[];
}
export interface TextDetection {
    bottomLeft: [number, number];
    bottomRight: [number, number];
    topLeft: [number, number];
    topRight: [number, number];
    text: string;
}
export declare enum ImageOrientation {
    Up = "UP",
    Down = "DOWN",
    Left = "LEFT",
    Right = "RIGHT"
}