@pantrist/capacitor-plugin-ml-kit-text-recognition

Capacitor Wrapper for TextRecognition of Googles ML-Kit

Install

npm install @pantrist/capacitor-plugin-ml-kit-text-recognition
npx cap sync

Configuration

Android

Optional but recommended: You can configure your app to automatically download the ML model to the device after your app is installed from the Play Store. To do so, add the following declaration to your app's AndroidManifest.xml file:

<application ...>
  ...
  <meta-data
      android:name="com.google.mlkit.vision.DEPENDENCIES"
      android:value="ocr" />
  <!-- To use multiple models: android:value="ocr,model2,model3" -->
</application>

iOS

Nothing to do for iOS

Supported methods

| Name | Android | iOS | Web | | ----------- | ----------- |-----|-----| | detectText | ✅ | ✅ | ❌ |

API

• detectText(...)
• Interfaces

detectText(...)

detectText(options: DetectImageOptions) => Promise<TextDetectionResult>

Tries to detect text from the given image

| Param | Type | Description | | ------------- | ----------------------------------------------------------------- | ------------------------------ | | options | DetectImageOptions | Options for the text detection |

Returns: Promise<TextDetectionResult>

Interfaces

TextDetectionResult

| Prop | Type | Description | | ------------ | -------------------- | -------------------- | | text | string | Found text | | blocks | Block[] | Parsed text by lines |

Block

| Prop | Type | | ----------- | ------------------- | | lines | Line[] |

Line

| Prop | Type | | -------------- | ---------------------- | | elements | Element[] |

Element

DetectImageOptions

| Prop | Type | Description | | ----------------- | ------------------- | ------------------------------------------------------------------------------------------------ | | base64Image | string | The image to detect texts from | | rotation | number | The image's counter-clockwise orientation degrees. Only 0, 90, 180, 270 are supported. Default 0 |