Documentation

CraftAR On-Device Image Recognition Cordova Plugin for iOS and Android

Use the CraftAR On-Device Image Recognition Cordova Plugin for iOS and Android to integrate our high-performance On-Device Image Recognition capabilities into your mobile apps, using Apache™ Cordova cross-platform development framework and web technologies like JavaScript, HTML5 and CSS3.

We want to make development easy for you. To integrate CraftAR into your Cordova mobile app, you can directly add our plugin to your Cordova project.

We’ve bundled up all the tools you’ll need, including the necessary JavaScript and the CraftAR On-Device Image Recognition SDKs for iOS and Android.

This page gives you pointers how to get the Plugin and Examples, the documentation of the Classes, the Requirements of your system to use this plugin, and finally, Release Notes of our continuous updates.

How to get started with the CraftAR On-device Image Recognition Cordova Plugin for iOS and Android

Our CraftAR On-device Image Recognition Cordova Plugin for iOS and Android works together with the CraftAR Image Recognition platform.

Sign up to CraftAR (free trial available) or log in to get the instructions on how you can install the plugin and run the Examples:

Get the Plugin
from CraftAR

Requirements

To integrate the Cordova On-Device Image Recognition Plugin into your native app, you will need Cordova 7.0+.

Note: The current version is NOT COMPATIBLE with:

  • Cordova 8
  • Cordova Android engine version 7 or greater (use 6.4)
  • Cordova cli for Windows.

Class Reference Documentation

Follow this link to browse through the classes of the CraftAR On-device Image Recognition Cordova Plugin for iOS and Android.

Releases

Version 2.4.3

Dec 15th, 2017

  • Changed: Plugin dependencies now get installed from npm. Using subdir is being deprecated.
  • Added: (Image Recognition) Added url and custom properties to all Items.
Version 2.4.2

Nov 28th, 2017

  • Updated: Contains CraftAR On-device IR SDK (iOS: 1.6.2, Android: 1.4.2)
  • New: (Camera) Added camera features: Control FPS, control HD/SD capture, take picture.
  • Fixed: (On-device) Fixes in on-device collection management.
  • Fixed: (Finder scan mode) Fix Finder mode timeout.
  • Fixed: (Android) Remove limitation that only allowed portrait apps.
Version 2.3.1

August 17th, 2017

  • Updated: Contains CraftAR On-Device Image Recognition SDK (iOS: 1.6.1, Android: 1.4.1)
Version 2.3

July 13th, 2017

  • Updated: Contains the latest versions of the CraftAR On-Device Image Recognition SDK (iOS SDK version 1.6, Android SDK version 1.4).
  • Updated: Added missing files to run with Apache Cordova 7.
  • Fixed: iOS Build not working due to framework symlinks being broken there (see related question)
  • Fixed: Recognition bounding box was missing a corner.
Version 2.2

December 19th, 2016

  • Updated: CraftAR On-device Image Recognition SDK (iOS: 1.5, Android: 1.3)
  • Added: New method to control Cloud Finder Mode search rate (set search period)
  • Fixed: Exception logged on Android when intializing the plugin.
Version 2.1

April 18th, 2016

  • Updated: CraftAR On-device Image Recognition SDK (iOS: 1.4, Android: 1.2.1)
Version 2.0

April 18th, 2016

  • New version of the plugin for Cordova 6
  • Uses the CraftAR On-device Image Recognition SDK version 1 (1.2 for Android, 1.3 for iOS)