![](\"https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png\")
@capacitor-community/image-to-text
\n Capacitor plugin for image to text processing using Apple's Vision Framework for iOS and MLKit's Vision Framework for Android..\n
\n\n## Credits\n\nThis project was forked from the [Cap ML](https://github.com/bendyworks/cap-ml) plugin written by Vennela Kodali. It was refactored and converted to Capacitor 4.\n\n- For Capacitor 4 projects use v4.x\n- For Capacitor 5 projects use v5.x\n- For Capacitor 6 projects use v6.x\n\n## Installation\n\n```\nnpm install @capacitor-community/image-to-text\n```\n\n## Usage\n\nThere is one method `detectText` that takes a filename of an image and will return the text associated with it.\n\nAdd the following to your application:\n\n```typescript\nimport { Ocr, TextDetections } from '@capacitor-community/image-to-text';\n\n...\n\nconst data: TextDetections = await Ocr.detectText({ filename: '[get-filename-of-image-jpg]' });\nfor (let detection of data.textDetections) {\n console.log(detection.text);\n}\n```\n\nThe above code will convert the image file and `console.log` the text found in it.\n\n## Example with Camera\n\nYou can use the [`@capacitor/camera`](https://capacitorjs.com/docs/apis/camera) plugin to take a photo and convert it to text:\n\n```\nimport { Camera, CameraResultType, CameraSource } from '@capacitor/camera';\nimport { Ocr, TextDetections } from '@capacitor-community/image-to-text';\n```\n\n...\n\n```typescript\nconst photo = await Camera.getPhoto({\n quality: 90,\n allowEditing: true,\n resultType: CameraResultType.Uri,\n source: CameraSource.Camera,\n});\n\nconst data: TextDetections = await Ocr.detectText({ filename: photo.path });\n\nfor (let detection of data.textDetections) {\n console.log(detection.text);\n}\n```\n\nA full sample application can be found [here](https://github.com/dtarnawsky/capacitor-ocr-example).\n\n\n\n## iOS Usage\n\nNo additional setup is required to use this plugin in a iOS Capacitor project.\n\n## Android Usage\n\nYour project must include a `google-services.json` file stored in the Android project folder (usually `android/app`).\n\n### Create Firebase Project and App\n\n- Sign in to [console.firebase.google.com](https://console.firebase.google.com/)\n- Click on `Add Project` and follow through the steps.\n- Click the `Android` icon to create an android app.\n- Enter the `Package Name` which must match your apps package name (You can find it in `android/app/AndroidManifest.xml`).\n- Click `Register App`\n- Download `google-services.json` and save into your project's `android/app` directory.\n\n### Add Firebase SDK\n\nThe sample project has this in place in its `build.gradle` (see [here as a reference](https://github.com/dtarnawsky/capacitor-ocr-example/blob/09e7fb935f68e642d4906eb0ed002a52d1868b52/android/app/build.gradle#L47)).\n\nNote: Most starter Capacitor projects are preconfigured to load `google-services.json`.\n\n## API Reference\n\nDetectTextFileOptions \\| DetectTextBase64Options | Options for text detection |\n\n**Returns:** Promise<TextDetections>\n\n--------------------\n\n\n### Interfaces\n\n\n#### TextDetections\n\n| Prop | Type |\n| -------------------- | ---------------------------- |\n| **`textDetections`** | TextDetection[] |\n\n\n#### TextDetection\n\n| Prop | Type |\n| ----------------- | ----------------------------- |\n| **`bottomLeft`** | [number, number] |\n| **`bottomRight`** | [number, number] |\n| **`topLeft`** | [number, number] |\n| **`topRight`** | [number, number] |\n| **`text`** | string |\n\n\n#### DetectTextFileOptions\n\n| Prop | Type |\n| ----------------- | ------------------------------------------------------------- |\n| **`filename`** | string |\n| **`orientation`** | ImageOrientation |\n\n\n#### DetectTextBase64Options\n\n| Prop | Type |\n| ----------------- | ------------------------------------------------------------- |\n| **`base64`** | string |\n| **`orientation`** | ImageOrientation |\n\n\n### Enums\n\n\n#### ImageOrientation\n\n| Members | Value |\n| ----------- | -------------------- |\n| **`Up`** | 'UP' |\n| **`Down`** | 'DOWN' |\n| **`Left`** | 'LEFT' |\n| **`Right`** | 'RIGHT' |\n\n