Skip to content

README.md

Latest commit

 

History

History
89 lines (56 loc) · 2.42 KB

README.md

File metadata and controls

89 lines (56 loc) · 2.42 KB
Raw

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

npm version

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(...)

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
lines string[] Parsed text by lines

DetectImageOptions

Prop Type Description
base64Image string The image to detect texts from