cordova-plugin-recognize-text v0.0.1

cordova-plugin-recognize-text

iOSのVNRecognizeTextRequestとVNDocumentCameraViewControllerを利用するためのプラグインです。

機能はVNRecognizeTextRequestを使用した文字認識とVNDocumentCameraViewControllerを使用したスキャナ画面の起動です。 iOS13以降のみに対応しています。

cordova >= 7.1.0
cordova-ios >= 4.5.0

Requirement

https://github.com/akofman/cordova-plugin-add-swift-support

Installation

cordova plugin add cordova-plugin-recognize-text

Supported Platforms

• iOS (>=13.0)

Usage

Example

// VNDocumentCameraViewControllerを使用してスキャナ画面が起動します
window.recognizeText.showScanner(
  function (result) {
    console.log(result) // { "texts": [ ["xxxxx","yyyyy","zzzzz"], ・・・ ] }
  },
  function (error) {
    console.log(error)
  },
  {
    // 高速テキスト認識or正確なテキスト認識（任意）
    // accurate or fast（デフォルトはaccurate）
    recognition_level: "accurate",

    // 対応言語を指定します（任意）
    // 現時点では英語のみ対応(デフォルトは["en_US"])
    recognition_languages: ["en_US"],

    // 認識処理中に言語補正を適用するかどうか（任意）
    // true or false（デフォルトはtrue）
    uses_language_correction: true
  }
)

// 画像パスを指定して、VNRecognizeTextRequestによる文字認識を行います
window.recognizeText.request(
  function (result) {
    console.log(result) // { "texts": ["xxxxx","yyyyy","zzzzz"] }
  },
  function (error) {
    console.log(error)
  },
  {
    // 入力ファイルをURI形式で指定します（必須）
    input_path: "file:///var/mobile/Containers/Data/Application/XXXXX-XXXX-XXXXX-XXXX-XXXXXXXX/tmp/sample.jpg",
    
    // その他はshowScannerと同じ
    recognition_level: "accurate",
    recognition_languages: ["en_US"],
    uses_language_correction: true
  }
)

window.recognizeText.isAvailable(function (result) {
  console.log(result) // iOS13 >= : true、other : false
})

Error Code

errorコールバックでは以下の形式のエラーを返します

{
  code: -1: パラメータが不正です, -2: 入力ファイルのパスが正しくありません, -3: 入力ファイルの読み込みに失敗しました, -4: iOS13以上でないために失敗しました, -5: 文字認識処理に失敗しました, -9: 不明なエラー
  description: エラーメッセージ
}