cordova-plugin-document-scanner

This plugin defines a global scan object, which provides an API for scan the document from taking pictures and choosing image from the system's library.

Although the object is attached to the global scoped window, it is not available until after the deviceready event.

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    console.log(scan);
}

Installation

This requires cordova 7.1.0+ and cordova android 6.4.0+
npm link :- https://www.npmjs.com/package/cordova-plugin-document-scanner

cordova plugin add cordova-plugin-document-scanner

Please read issues and fixes section of readme for Ionic & PhoneGap installation and Android Oreo support

scan.scanDoc(sourceType, successCallback, errorCallback)

Takes a photo using the scan, or retrieves a photo from the device's image gallery. The image is passed to the document scanner and the scanned image passed to success callback as the URI for the image file.

The scan.scanDoc function opens the device's default scan application that allows users to snap pictures by default - this behavior occurs, when sourceType equals 1. Once the user snaps the photo, the scan application closes and the application is restored.

If sourceType is 0, then a dialog displays that allows users to select an existing image.

The return value is sent to the scanSuccess callback function, in the fileUri formats.

You can do whatever you want with the URI, for example:

• Render the image in an <img> tag.

Adds file:// in front of the imageuri returned for both android and ios [iOS example imageURI returned :- file:///var/mobile/Containers/Data/Application/8376778A-983B-4FBA-B21C-A4CFDD047AAA/Documents/image.png]

Supported Platforms

• Android (For Android Oreo support please read Issues and Fixes section)
• iOS

Example

scan.scanDoc(sourceType, scanSuccess, scanError);

scan.scanDoc

Take a photo and retrieve the image's file location:

scan.scanDoc(0, onSuccess, onFail);

function onSuccess(imageURI) {
    var image = document.getElementById('myImage');
    image.src = imageURI;
}

function onFail(message) {
    alert('Failed because: ' + message);
}

iOS Quirks

NOTE :- iOS has only document scan via camera for now (Any argument passed will start the camera scan). Document Scan from gallery will be available in future version. Also scanned images aren't saved to the gallery in iOS.

An example file URI obtained from success call back of scanDoc function looks like this file:///var/mobile/Containers/Data/Application/8376778A-983B-4FBA-B21C-A4CFDD047AAA/Documents/image.png

Issues and Fixes

• Error:Execution failed for task ':app:transformNativeLibsWithStripDebugSymbolForDebug'
  Delete local ndk-bundle folder. Example location :- C:\Users\Administrator\AppData\Local\Android\sdk\ndk-bundle

• CropViewController fails in Xcode due to Incompatible Swift Versions
  Refer issue 13

• Couldn't find "libopencv_java3.so" [Problem mainly with 64 bit build devices]
  Refer issue 8

• iOS scan UI buttons documentation
  Refer issue 15

• Adding plugin in Ionic
  Refer 6th response in issue 17

• Adding plugin in PhoneGap
  Refer entire issue 22

• iOS: multiple scan does not override the first image
  Refer entire issue 10

• Android Oreo Support / Failure delivering result ResultInfo
  Refer issue 19 & 17
  

Credits / Native library links

Android :- https://github.com/jhansireddy/AndroidScannerDemo
iOS :- https://github.com/charlymr/IRLDocumentScanner

Huge thanks to these authors for making their document scanning native libraries public.

More about us!

Find out more or contact us directly here :- http://www.neutrinos.co/

Facebook :- https://www.facebook.com/Neutrinos.co/
LinkedIn :- https://www.linkedin.com/company/25057297/
Twitter :- https://twitter.com/Neutrinosco
Instagram :- https://www.instagram.com/neutrinos.co/