Negligent Parachute Maintainers

    cordova-plugin-image-recognition

    1.0.2 • Public • Published

    cordova-plugin-image-recognition

    image recognition plugin for Cordova apps, ( for now it's only available for Android ).

    it used the amazing EasyAR 2.1.0 free services to recognise specified images

    please read EasyAR Terms of Use for Free Services

    Get Started

    cordova plugin add cordova-plugin-image-recognition

    Simply adding this plugin to the Cordova project will make the window.ImageRecognition global object available once the deviceready event propagates.

    Usage

    to use this plugin you have to get EasyAR SDK License Key for each application

    How to get EasyAR SDK License Key:

    • go to https://www.easyar.com/
    • Sign in if you already have account or Sign up for new account
    • in SDK Authorization section click on Add SDK License Key
    • choose type : EasyAR SDK Basic: Free and no watermark , set your App Name and PackageName (Android)
    • click Confirm
    • that will generate SDK License Key for your application

    There are two primary steps to integrating cordova-plugin-image-recognition:

    1. Init

    set EasyAR SDK License Key

    window.ImageRecognition.init("EasyAR_SDK_License_Key");

    or set EasyAR SDK License Key & specify images to recognise

    window.ImageRecognition.init("EasyAR_SDK_License_Key",{
        "images":[{
            "image": "test.jpg", //image path in www folder
            "name" : "test" //name that return when this image detected
        },{
            "image": "pages/page1.jpg", //image path in www folder
            "name" : "page1" //name that return when this image detected
        }]
    });

    2. Start

    Later in your application, simply call the start to open camera and start looking for images.

    function successCallback (res) { alert(res); }
    function failureCallback (err) { alert(err); }
    window.ImageRecognition.start(successCallback, failureCallback);

    when camera recognise one of the specified images, successCallback will called and it will pass the recognised image name as argument.

    API

    init

    set EasyAR SDK License Key

    window.ImageRecognition.init("EasyAR_SDK_License_Key");

    or set EasyAR SDK License Key & specify images to recognise

    window.ImageRecognition.init("EasyAR_SDK_License_Key",{
        "images":[{
            "image": "test.jpg", //image path in www folder
            "name" : "test" //name that return when this image detected
        },{
            "image": "pages/page1.jpg", //image path in www folder
            "name" : "page1" //name that return when this image detected
        }]
    });

    start

    start looking for the images that specified to be recognised

    function successCallback (res) { alert(res); }
    function failureCallback (err) { alert(err); }
    window.ImageRecognition.start(successCallback, failureCallback);

    addImage

    to add any image from your assets "www" folder to the image list that specified to be recognised

    var img = "test.jpg"; //image path in www folder
    var name = "test" //name that return when this image detected
    window.ImageRecognition.addImage(img,name);

    removeImageByName

    to remove every image have this name from the image list that specified to be recognised

    window.ImageRecognition.removeImageByName("test");

    search

    it's the same as start function but it dosen't use the image list that specified by init add addImage functions, insteade it uses it's own image list that passing by this function

    function successCallback (res) { alert(res); }
    function failureCallback (err) { alert(err); }
    var imageList = {
      "images" :
      [
        {
          "image" : "pages/page1.jpg",
          "name" : "page1"
        },
        {
          "image" : "pages/page2.jpg",
          "name" : "page2"
        }
      ]
    };
    window.ImageRecognition.search(imageList,successCallback, failureCallback);

    Install

    npm i cordova-plugin-image-recognition

    DownloadsWeekly Downloads

    5

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    20.4 MB

    Total Files

    16

    Last publish

    Collaborators

    • mhdferas