Documentation

iOS CraftAR Augmented Reality SDK

The CraftAR Augmented Reality SDK renders Augmented Reality experiences automagically in your own branded iOS apps and offers high-performance tracking.

Seamlessly render on-device or cloud items, such as videos with high-quality playback, buttons and 3D models, in your native iOS apps.

We want to make development easy for you. To integrate CraftAR into your iOS Augmented Reality app, we provide the iOS Augmented Reality SDK as 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 from CraftAR

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 Augmented Reality SDK into your own project

Follow this tutorial for instructions on how to integrate the iOS Augmented Reality SDK into your xCode projects.

Requirements

To integrate the 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 Augmented Reality SDK

Releases

Version 5.2

March 5th, 2018

  • Fixed: (Augmented Reality) On-device bundles now download the contents of the AR Items on the device when synchronizing the collection.
  • Fixed: (Augmented Reality) Error in 3D model caching (for Cloud AR items) that forced download of textures every time.
Version 5.1.1

December 12th, 2017

  • Fixed: (Augmented Reality) Fixed errors when creating 3D models from URLs and local files.
Version 5.1.0

November 7th, 2017

  • Changed: (Augmented Reality) New performance and quality improvements to our core tracking technology.
  • Added: (Augmented Reality) Allow to disable automatic AR content creation.
  • Added: (Augmented Reality) New method to control the maximum number of AR items that can be tracked simultaneously.
  • Fixed: (Augmented Reality) Fixed flashing watermark when using AR videos with transparency.
  • Fixed: (Augmented Reality) Fixed problems when changing properties of ImageButton contents.
  • Fixed: (Augmented Reality) Fixed CheckImageQuality to be able to call it without opening the camera capture.
  • Fixed: (Collection Manager) Fixed infrequent crash when adding on-device collections.
Version 5.0.1

August 17th, 2017

  • Added: (Camera) Added adaptive control of capture settings depending on the device.
  • Fixed: (Camera) Fixed artifacts appearing in the camera preview on some devices.
  • Fixed: (Common) Fixed embedded libraries to contain bitcode.
  • Fixed: (Augmented Reality) Fixed touch events on videos with the transparency mask property set.
  • Fixed: (Augmented Reality) Fixed compilation for Simulator.
Version 5.0

July 12th, 2017

  • New: (Augmented Reality) This version of the SDK includes a new, improved version of our tracking technology.
  • New: (Augmented Reality) Increased camera FPS and added interface to control camera FPS.
  • New: (Augmented Reality) Now you can add items to the tracking before the camera capture is started.
  • New: (Augmented Reality) Now you can directly load all AR items from an on-device collection to the Tracking at once.
  • Changed: (Common) Pods.framework now only contains AFNetworking 3.0.
  • Changed: (Camera) Set focus “point of interest” moved to the CraftARSDK class.
  • Added: (Camera) Add method to run a callback block when the camera is opened to allow custom configurations.
  • Fixed: (Augmented reality) Portrait videos with orientation metadata are now displayed correctly.
  • Fixed: Fixed: (Augmented reality) Improved rendering performance.
  • Fixed: (Augmented Reality) Fixed typo in the CraftARTrackingContent class.
Version 4.4

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: (Augmented Reality) Set video content transparency mask programmatically now works.
  • Fixed: Some conflicts with 3rd party libraries (libpng and FileUtils class).
Version 4.3

 August 31st, 2016

  • Added: Volume control for video contents.
  • 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: Small memory leak when adding AR Items for tracking.
  • 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.
  • Fixed: Crash when there is no delegate for 3D model downloads and the download fails.
Version 4.2

 March 14th, 2016

  • Fixed bug in touch events
  • Advanced On-device collection synchronization (it only downloads resources for the items that have changed or are new)
  • Added method to check on the device how good an image is for AR
  • 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
  • Fixed bug where AR items were not added for tracking occasionally
  • Made ‘take picture’ method public
Version 4.1

 November 17th 2015

  • Use CloudRecognition.mSearchcontroller as searchController delegate
  • Added: startFinderWithTimeout feature
  • Fixed: several bugs
Version 4.0

 October 30, 2015

  • Completely new SDK architecture
  • Improved: 2D tracking for most conditions
  • Added: on-device Augmented Reality
  • Added: HD capture
  • Added: iOS 9 support and bitcode embedded
  • Added: take screenshots of the AR scene
  • Added: start tracking until something is detected or until a timeout is over
  • Added: OS network error forwarding
  • Fixed: several bug fixes
Version 3.0.2

 December 11, 2014

  • Distribute libs in Universal framework format.
  • Added: error message when reference data is being generated.
Version 3.0

 December 3, 2014

  • New CraftARSDK.framework distribution
  • The SDK classes are now called CraftARxxx
  • The CloudRecognitionItem class is now called CraftARItem
  • Improved: faster recognition by using my.craftar.net (points to the geographically closest server)
  • Added: off-tracking content rendering capabilities
  • Added: CraftARItem receives tracking events
  • Fixed: bugs on iOS 8
Version 2.3.1

 September 1, 2014

  • Added: support for User Interface rotation.
Version 2.3

 August 12, 2014

  • Added: support for 3D models.
  • Added: support for video transparency using the transparency_mask flag in the video contents
  • Fixed: bugs causing crashes during navigation
  • Removed: dependencies with libstdc++
Version 2.2.1

 June 23, 2014

  • Added: support new content scale
  • Added: video features made public
  • Fixed: memory leak in camera preview creation
  • Fixed: tracking events for contents
Version 2

January 14, 2014

Version 1

October 2, 2013
The first version of the iOS SDK is focused mainly on our Cloud Image Recognition functionalities.
Learn more about the launch of the SDK in our Releases Blog: Extra, Extra, Read All About our New SDK.