Documentation

iOS On-Device Image Recognition SDK

Our robust On-Device Image Recognition SDK can search through thousands of objects locally, inside your iOS apps, with no cloud support necessary. The recognition runs just as fast and just as reliable whether your users are online, connected to a weak network, or with no coverage at all.

We want to make development easy for you. To integrate the CraftAR iOS On-Device Image Recognition SDK into your native mobile app, we provide an iOS Framework that you can directly import into your XCode project.

This page gives you pointers to the Tutorials you should follow to integrate this SDK; the documentation of the Classes; how to run the Examples; the Requirements of your system to use this SDK, and finally, Release Notes of our continuous updates.

Download iOS SDK

How to get started with the SDK

In order to get started with the SDK, we recommend you to run the examples included in the distribution that you can download upon request (see button above). The examples are located in the Examples directory as an xCode Project.

Running the examples

The SDK is already linked in the project, available inside the distribution package. You can open it and just run the project from your device (note that running inside the Simulator is not available with the SDK).

The examples app opens a menu view that allows you to open the different examples. Each example opens the camera and the first step is for you to scan any object. We provide a set of reference images to point at that show different experiences. You can find those images in the folder Examples/Reference images.

We strongly recommend that you print this images out for testing. Pointing at them in your laptop/PC’s screen can heavily alter the experience due to artefacts that are invisible to your naked eye but very disturbing when captured with your smartphone.

augmented-reality-item-1

augmented-reality-item-2

image-recognition-item

Integrate the iOS On-device Image Recognition SDK into your own project

Follow this tutorial for instructions on how to integrate the iOS On-device Image Recognition SDK into your xCode projects.

Requirements

In order to integrate the iOS On-Device Image Recognition SDK into your native app, you will need Xcode 7 or newer, and at least iOS 8.0.

Class Reference Documentation

Follow this link to browse through the classes of the iOS On-device Image Recognition SDK

Download iOS SDK

Releases

Version 1.5

December 15, 2016

  • Changed: (CloudRecognition) Now you can control the search period through the CloudRecognitionSearchController.
  • Fixed: (Camera) Focus and contrast work better now. Set the focus point of interest instead of “triggering” the focus.
  • Fixed: (On-device IR) Crash when the app has UTF-8 characters in the name.
  • Fixed: Some conflicts with 3rd party libraries (libpng and FileUtils class).
Version 1.4

 August 31st, 2016

  • Added: Callback block for the [CraftARSDK stopCapture] message (it’s asynchronous).
  • Added: [CraftARCamera setCapturePreset] allows to use lower resolution video capture to speed up in slow devices.
  • Fixed: Check support for camera features (focus and exposure) before using them.
  • Fixed: Crash when adding invalid on-device collections, now produces an error.
  • Fixed: Removed warnings produced in xCode due to missing ModuleCache files.
  • Fixed: Removed warnings when compiling for iOS 8.0
  • Fixed: Error when adding empty collections.
Version 1.3

 March 14th, 2016

  • Advanced On-device collection synchronization (it only downloads resources for the items that have changed or are new)
  • Added interfaces to manage collection bundles with tags
  • Fixed errors in on-device bundles download
  • Changed singletons to improve swift integration
  • Fixed query image rescaling for Image Recognition
  • Made ‘take picture’ method public
Version 1.2

November 17, 2015

  • Use onDeviceRecognition.mSearchcontroller as searchController delegate
  • Added: Cloud image recognition module
  • Added: StartFinderWithTimeout
  • Fixed: SDK version mistake. Previous version major should be 1 not 3
  • Fixed: Several bugs
Version 1.0.1 (aka 3.1)

July 27, 2015

  • Added: Add collection from the CraftAR Service
  • Added: Synchronize collections with the CraftAR Service
  • Fixed: Several bugs
Version 1.0 (aka 3.0)

June 9, 2015
First release of the On-Device Image Recognition SDK for iOS. You can read more about this launch at our Releases Blog: What Can You Do with Catchoom’s NEW CraftAR On-Device Image Recognition Tool?.