Documentation

Release Notes Wikitude SDK

Wikitude SDK 8.2.0

Release Date: 2018-11-10

New

  • Beta Release of Native API for UWP platform

Improved

  • Adds new parameters to ImageTrackable and ObjectTrackable onDrag{Began,Changed,Ended} callbacks that are hit tested against the tracking plane so that gestures can be implemented according to orientation of target

Fixed

  • Fixes issue where the camera frame rate was very low when using camera2 on certain Samsung devices
  • Fixes issue that caused model animations to not be resumed correctly upon losing and re-recognizing a target
  • Fixes an issue in the custom camera sample that caused a black frame to be rendered when certain 3D model were in the scene
  • Fixes an occasional crash for certain image targets when energy efficient tracking was enabled

Wikitude SDK 8.1.0

Release Date: 2018-09-11

New

  • Support and compatibility for iOS 12
  • Support and compatibility for Android 9.0
  • API to explicitly set efficiency mode for trackers for fast processing
  • Mandatory Group ID parameter for cloud recognition

Improved

  • Increased stability when tracking objects and scenes
  • Increased recognition accuracy for multiple objects in object target collection
  • Increased stability for Instant Tracking for rotational movements
  • General improvements to Instant Tracking for more accurate tracking and representation
  • Camera2 is now used by default on all devices with Android 5.1 or higher

Fixed

  • Fixes issue where recognising an image was not possible when the device was close to the image
  • Fixes instability(flickering augmentations) of continuous cloud recognition
  • Fixes ADE issues with Object Tracking and Occluders
  • Fixes crash when using SMART and not including ARCore as dependency of the application
  • Fixes AR.Sound issue when stopping and playing repeatedly

Wikitude SDK 8.0.0

Release Date: 05.07.2018

New

  • Ability to save Instant Tracking session as Instant Targets
  • Ability to load Instant Targets
  • Major update to the engine powering Object Tracker resulting in better recognition accuracy and better tracking stability
  • Introduction of new wto format version
  • New method to generate Object Targets using images instead of videos
  • New camera APIs to control exposure setting and focus area

Improved

Fixed

  • Wikitude SDK can now be built using Gradle 3 and Android Studio 3

Wikitude SDK 7.2.1

Release Date: 21.02.2018

Fixed

  • Fixes a bug where trial license did not allow to use Instant Tracking
  • Fixes a potential deadlock for cloud recognition that occurred in rare cases -Fixes a deadlock related to AR.HtmlDrawables

Wikitude SDK 7.2.0

Release Date: 05.02.2018

New

  • SMART - Wikitude's integration of ARKit and ARCore

Improved

Fixed

  • Fixes an issue where the SDK could crash on certain devices in case a running video drawable was interrupted
  • Fixes an issue where videos were rendered incorrectly when using AR.context.startVideoPlayer
  • Fixes an issue that occurred when AR.Model objects were assigned as instant tracking initialization drawables

Wikitude SDK 7.1.0

Release Date: 19.09.2017

New

  • Added support for Android O

Improved

  • Improved OpenGL ES resource handling
  • Improves usage of the Android camera2 API
  • SDK can now run in the Android emulator
  • Simplified example application

Fixed

  • Fixes an object tracker issue where the onTargetsLoaded callback was called before all object targets were extracted
  • Fixes an issue where Plugin::pause was not called in case it was unregistered from the SDK
  • Fixes an issue where the SDK could crash in case a new tracker was created while another one was already tracking
  • Fixes an issue where loading .wto files could have happened on the main thread
  • Fixes an issue where the SDK could have crashed in case a target collection resource was released
  • Fixes an issue where the SDK could have crashed in case a cloud recognition service was released
  • Fixes an issue where cloud recognition could crash after a new target was detected
  • Fixes an issue where the SDK could crash in case the camera was disabled at runtime and a tracker was tracking
  • Fixes an issue in the Wikitude 3D Encoder where a crash could happen in case a 3D Model had all model animation keyframe timestamps below 1
  • Fixes an issue where certain AR.Model animations are not rendered correctly
  • Fixes an issue where instant tracking initialisation drawables would not be rendered
  • Fixes an issue with AR.Model where pausing quickly after creation would break the rendering completely
  • Fixes an issue with AR.Model on some devices (i.e. Samsung Tab 4) where the rendering could be broken completely or initial scaling could be incorrect
  • Fixes an issue with AR.context.destroyAll where some objects might not have been destroyed
  • Fixes an issue where the SDK could crash on the emulator in case the Android camera1 API is used
  • Fixes an issue where GEO-AR and InstantTracking was not working on devices without gyroscope
  • Fixes an issue where AR.HTMLDrawable.evalJavascript was not working correctly
  • Fixes an issue where the SDK could only be used with targetsdkversion of 22 or lower because of textrelocations on x86 devices
  • Fixes an issue where GPS access was not destroyed properly

Wikitude SDK 7.0.0

Release Date: 13.07.2017

New

  • Object Recognition and Tracking
  • Support for multiple Image Targets
  • New hit-testing API for SLAM engine
  • Option for Extended Range for Image Recognition
  • Option for InstantTracker to choose initial plane orientation
  • New AR.Occluder that acts as occlusion model
  • New option to forward logs from AR.logger to AndroidStudio or Xcode

Improved

  • Updated SLAM engine improves performance and accuracy for InstantTracker and Extended Tracking
  • Plugins access to currently tracked target
  • Plugins provide more details about image, object and instant targets
  • Android makes use of Sensor Motion API for smoother Geo AR
  • Performance of HTMLDrawables when setting the content of html drawables continuously

Fixed

  • Return appropriate return values in the gesture event callbacks
  • Issue where setting AR.Drawable.rotate was not resulting in a correct rotation
  • Issue where TargetRectangleInFrame returned the wrong position and size with HD frames

Wikitude SDK JavaScript API 6.1.0

Release Date: 28.03.2017

New

  • New JavaScript -> Java communication through AR.platform.sendJSONObject()
  • New AR.Model.onInitialized event. This event is called as soon as the 3d model is fully loaded in OpenGL ES
  • New compass offset API
  • New supported FrameColorSpace YV12 for input plugins
  • New plugin registration error callback that contains information why a plugin could not be registered
  • New Frame methods hasStrides() and getFrameStrides() to get stride information of frames provided by plugins

Improved

SDK
  • Trial licenses now support instant tracking
  • AR.Model.onLoaded is again called as soon as the .wt3 file is loaded (same behavior as in SDK 3.x - 5.x)
3D Encoder
  • Wikitude 3D Encoder for macOS is now properly signed

Fixed

  • Fixes an issue where 2D augmentations are always drawn in front of 3D augmentations
  • Fixes broken Architect Desktop Engine (ADE.js)
  • Fixes an issue where the app was not responding when an AR.InstantTracker was destroyed and re-created
  • Fixes an issue where injecting custom locations with an altitude of 0 would lead POIs to ignore the altitude
  • Fixes an issue where translation/rotation or scale changes were not applied when the setter was called with an object that contained only zeros like drawable.translate = {x:0, y:0, z:0}
  • Fixes an issue where the deprecated AR.Drawable2d.scale property setter was not working correctly
  • Fixes an issue where the AR.TargetCollectionResource.onError is not called when no network connection is available
  • Fixes an issue where some onError callbacks were not called correctly
  • Fixes an issue where input plugins would try to render YUV NV21 frames using the YV12 color format
  • Fixes an rendering issue that occurred in case the rendering surface has a different orientation than the device
  • Fixes a plugin issue where a wrong frame size and frame color space was reported in cameraFrameAvailable when using camera2
  • Fixes a memory leak in PermissionManager

Wikitude SDK JavaScript API 6.0.1

Release Date: 15.02.2017

Fixed

Wikitude SDK JavaScript API 6.0.0

Release Date: 25.01.2017

New

  • The new instant tracking feature allows users to place augmentations without any markers in any surrounding. Instant tracking uses Wikitudes own SLAM-based 3D engine.
  • Added advanced camera settings like HD and 60 fps camera rendering and a manual focus control (Camera 2 API)
  • Unified computer vision related class names
  • Multi-touch gestures allow the interaction with augmentations. Available touch gestures include dragging, scaling, rotation and panning.
  • Added 3D positioning for 2D augmentations
  • Added an option to enable/disable billboard behavior for AR.Drawables

Improved

  • Updated target collection format (.wtc) which improves the robustness and performance of 2D image recognition.
  • Extended tracking improved significant using the new SLAM technology
  • Behaviour of removing plugins at runtime - lifecycle callbacks are now called properly
  • Plugins now receive a call to surfaceChanged in case the device was rotated while the application was not active.
  • Calling the start function of AR.ModelAnimation in case the referenced 3D model is not loaded yet actually starts the animation as soon as the 3D model is loaded
  • Add toast output if media player activity is not declared in manifest
  • Add javadoc.jar to the Android SDK to integrate into Android Studio

Fixed

  • Fixed an issue where the SDK could crash in case a lot of AR.Trackable2DObject are generated in a loop and immediately destroyed
  • Fixed an issue where the AR.Model onLoaded callback would be called although the 3D model is actually rendered for the first time in the next frame
  • Fixed an issue where the SDK was not working using multiple AR views

Wikitude SDK JavaScript API 5.3.1

Release Date: 24.11.2016

Fixed

SDK
  • Fixes an issue where AR.CloudTracker would not work when using input plugins
  • Fixes an issue where the camera could not be resumed after it was stopped through AR.hardware.camera.enabled = false
  • Fixes a crash if AR.BaseTracker are destroyed with AR.Trackable2DObject's still attached to it
  • Fixes an issue where the AR.Trackable2DObject onEnterFieldOfVision trigger would not be fired if the trackable was created after it's AR.BaseTracker already recognized a target
  • Fixes an issue where proguard for an app was not able to exclude wikitude sdk classes
  • Fixes an issue where a video opened via AR.context.openInBrowser(url) was not destroyed after leaving the activity
  • Fixes an issue where image recognition was no longer working on the Nexus7

Wikitude SDK JavaScript API 5.3.0

Release Date: 13.09.2016

New

SDK
  • Android 7.0 Nougat support
  • Positionables allow developer to position AR.Drawables in 3D space using the Plugins API. The new marker tracking example provides a detailed demonstration of this feature.
  • New InputFrameRenderSettings options for Plugins API
  • A new include for the architect.js to prevent mixed content errors in https environments

Fixed

SDK
  • Fixes an issue where AR.CloudTracker would not be able to send proper server requests
  • Fixes an issue when enabling and disabling the camera via AR.hardware.camera.enabled
  • Fixes an issue when resolving relative paths inside the JS library
  • Fixes an issue where the SDK could crash if a different Architect World is loaded and the previous one used cloud recognition
  • Fixes a rare crash in the 3D Tracking engine

Improvements

  • Improved memory handling of 3D models
  • Improved support for different Camera2 API implementations for Input Plugins
  • Improved and aligned behaviour of cache handling
  • isDeviceSupported now returns a more detailed list which requirements are not met

Wikitude SDK JavaScript API 5.2.0

Release Date: 08.07.2016

New

SDK
  • InputPlugins allow developer to use the Wikitude SDK with an external camera feed

Fixed

SDK
  • Updates OpenSSL to version 1.01r
  • Fixen an issue where AR.ImageDrawables might not appear after loading an Architect World or resuming the SDK
  • Fixes an issue where 3D models might not be rendered correctly after the SDK paused/resumed
  • Fixes an issue where destroying the SDK while a large .wtc file is loading, crashed the SDK
  • Fixes several issues that might lead to a crash if the SDK is paused/resumed
  • Fixes several issues that might lead to a crash if the SDK is destroyed and immediately afterwards created again
3D Encoder
  • Fixes animations with negative start offsets
  • Fixes animations containing several takes
  • Fixes “texture not found” bug on Windows
  • Adds a new warning in case of invalid polygon indices of materials
  • Update to FBX SDK 2017, FBX version 7.5

Wikitude SDK JavaScript API 5.1.4

Release Date: 14.03.2016

New

3D Encoder
  • Option to select the type of back-face culling that should be applied when rendering the 3D model

Fixed

SDK
  • Memory leak when using continuous cloud recognition
  • 3D models with 'Grouping on Takes' did not consider different animation offsets
3D Encoder
  • Windows 3D Encoder always rendered empty scenes

Wikitude SDK JavaScript API 5.1.3

Release Date: 03.03.2016

New

  • New JS API to specify a custom cloud recognition server url through AR.context
SDK
  • Support for AR.openInBrowser(url, forceNative=false)
3D Encoder
  • different modes for grouping animations
  • mesh deformer animations take into account geometric transforms mesh transformations
  • support for shared joint nodes
  • new wt3 file format; wt3 created with Encoder 1.3 cannot be used with SDK < 5.1.3

Fixed

SDK
  • onError trigger not called if local assets could not be loaded
  • AR.ModelAnimation onFinish trigger not called
  • Texture settings for 3D model rendering
  • Mesh deformer animations take into account geometric transforms mesh transformations
  • CloudTracker might not load on low end devices
  • Camera and sensors could not be started or stopped from the JavaScript API
  • Tracker not created when loading multiple architect worlds consecutively
3D Encoder
  • Memory leak on screenshot creation

Wikitude SDK JavaScript API 5.1.2

Release Date: 11.02.2016

Fixed

  • Crash on low end devices regarding threading
  • Continuous cloud recognition could not be stopped

Wikitude SDK JavaScript API 5.1.1

Release Date: 12.01.2016

Fixed

  • Missing textures on certain 3D models

Improved

  • Wikitude Sample App now implements Android Runtime Permissions (applies to Android 6.0 - API level 23)

Wikitude SDK JavaScript API 5.1.0

Release Date: 01.12.2015

New

  • Support for Android switched camera on Nexus 5X
  • Support multiple regional co-located cloud recognition services
  • 3D model import: account for pivot node transformations

Fixed

  • 3D model import:
    • Animation grouping
    • Account for animation stack (numbering of animations if more than one animation tracks are on the FBX animation stack)
    • Accept the first texture of a multi-textured 3d model
    • Accept 3d models with more than one mesh skins per node

Wikitude SDK JavaScript API 5.0.0

Release Date: 27.08.2015

New

  • Extended Tracking
  • Plugins API
  • Full Android Studio setup and support
  • Unity Plugin
  • Native API

Fixed

  • Potential problem with 3D special effects causing crashes
  • Potential problem when calling trackable.drawables.addCamDrawable() while snapping is active
  • Wrong log messages for connection not found
  • Potential problem when clicking parts of a 3D model
  • Potential problem when 3D models are re-loaded fast
  • Potential memory increase with certain 3D models
  • Problem when at the same time addCamDrawable is called in the onExitFieldOfVision event
  • Potential problem with texture rendering when clicking a button

Improved

  • Newest version of 3D rendering engine

Removed

  • Official support for Android version lower than Android 4.0

Wikitude SDK JavaScript API 4.1.1

Release Date: 27.04.2015

Fixed

  • Missing QT 5 .dll's for Windows 3D Encoder
  • AR.Model onError handler now has more details about what failed
  • Loading of ClientTracker works as expected when no onLoaded trigger is set
  • Documentation clarifications and fixes
  • Updated Terms of Service

Wikitude SDK JavaScript API 4.1.0

Release Date: 03.03.2015

New

  • Access to the device front cam through a JavaScript API and the native SDK
  • Hardware access API for advanced camera features (zoom, focus)
  • Native support for 64-bit ARM devices
  • Information about distance to the image target
  • Click on 3D model now returns mesh part
  • Updated sample app
  • CloudTracker for cloud recognition support
  • API changes
    • moved all initialization parameters to new class StartupConfiguration
    • renamed ARMode to Features
    • uniform naming convention of API methods on all platforms

Fixed

  • Potential problem when deleting large .wtc files
  • onSnappedToScreen function is not called when using the enabledOnExitFieldOfVision property
  • 3D Model with animation not clickable

Improved

  • Performance of Image Recognition initial recognition phase
  • Tracking Performance optimized and streamlined

Wikitude SDK JavaScript API 4.0.3 DRC

Release Date: 25.11.14

Fixed

  • Race condition on ArchitectView startup (leading to crash) when Javascript command are issued before the main HTML is loaded.

Improved

  • Better handling of AR worlds containing more VideoDrawables.

Wikitude SDK JavaScript API 4.0.3

Release Date: 28.10.14

Fixed

  • Compatibility with Android 5.0

Wikitude SDK JavaScript API 4.0.2

Release Date: 09.10.14

New

  • Android L compliance, according to the new guidelines
  • AR Mode configurable on startup (default is IR+Geo)

Improved

  • Image target recognition
  • Optimized SDK for Android 2.3+ by removing fallbacks for older Android versions

Fixed

  • Fixes an issue with flickering augmentations for certain image targets
  • Fixes an issue where the 'onSnappedToScreen' function was not called when using the 'enabledOnExitFieldOfVision' property
  • It is safe to call normal lifecycle events of the ARchitectView even if initialization fails
  • ARchitect WebView lifecycle doesn't interfere with other WebViews in the same application

Wikitude SDK JavaScript API 4.0.1

Release Date: 07.08.14

Fixed

  • Fixes Videodrawable crash related to code obfuscation when creating a Play Store application
  • Fixes Videodrawable loop behaviour on Samsung devices.

Wikitude SDK JavaScript API 4.0.0

Release Date: 29.07.14

New

Fixed

  • A potential issue that caused rendering artifacts when objects were created outside of the current culling distance
  • Fixes a problem with wrong camera orientation
  • Fixes various problems with VideoDrawables
  • Fixes a potential issue with 3D models that were not deleted correctly from a temporary directory
  • Fixes a potential issue with 3D models that were not destroyed correctly when using the JS destroy() API
  • Transparent videos on PowerVR SGX 540 devices
  • Can load the same 3D model more than once
  • VideoDrawables crash on pause / resume
  • Load and show more than one video in a single AR world

Improved

  • Samples to reflect Snap-to-screen feature and wildcard support
  • Comments in sample apps source code

Wikitude SDK JavaScript API 3.3.2

Release Date: 29.07.14

Fixed

  • Fixes various problems with VideoDrawables
  • Fixes a potential issue with 3D models that were not deleted correctly from a temporary directory
  • Updates OpenSSL version to 1.0.1h
  • Transparent videos on PowerVR SGX 540 devices
  • Can load the same 3D model more than once
  • VideoDrawables crash on pause / resume
  • Load and show more than one video in a single AR world

Wikitude SDK JavaScript API 3.3.1

Release Date: 24.04.2014

New

  • Listener for PageLoaded Event

Fixed

  • Possible memory allocation issues during application close
  • Possible error where screenshot was not captured
  • Crash when exiting and reentering the same architect world
  • Some PNG images couldn't be loaded

Wikitude SDK JavaScript API 3.3.0

Release Date: 01.04.2014

New

  • Multiple AR views supported
  • URL scheme support for tel:, sms: and mailto:
  • Scaling mode: Global Scene (See JavaScript API Referencefor more details)
  • Method getSupportedARModeForDevice to retrieve suitable AR mode for device

Fixed

  • JavaScript error reported at start-up (Uncaught ReferenceError)
  • Possible mix-up of 3D textures with the same name in different 3D models
  • Possible exception when using Video Drawable (ConcurrentModificationException) fixed
  • Possible crash when sending app to background and back when playing video
  • Loading of worlds from SD card on Android 3.0 (and earlier) and sound loading from SD card

Improved

  • Camera View on low-end devices
  • Injection of JavaScript API on Android 3.0+
  • Compatibility with Android 4.4 and SDK 19

Wikitude SDK JavaScript API 3.2.1

Release Date: 04.12.2013

Fixed

  • Compilation error preventing gif files to be shown in AR scene
  • Animation loops of 3D models
  • onError trigger not called for images in not supported format
  • Rare cases where Android UI becomes unresponsive when opening an activity on top of Wikitude SDK

Wikitude SDK JavaScript API 3.2.0

Release Date: 10.10.2013

New

  • VideoDrawables to display videos on top of image targets or as part of GeoObjects
  • Taking screenshot of AR scene
  • Examples for VideoDrawables

Fixed

  • AR.context.startVideoPlayer was unable to play videos from asset folder
  • ADE.js interfered with architect.js under certain circumstances when loaded from bundle/assets
  • Rare case of crashing in onDestroy
  • Under certain circumstances the sensors where not paused
  • Camera uses auto focus for better recognition performance
  • Fixed loading worlds from any source
  • Changing viewport of HTML drawable after creation results in crash

Improved

  • Resource loading and caching of images, 3D models and tracker files
  • Images can be loaded from any source
  • Loading time of image recognition tracker
  • Radar position and size is now defined as a DOM element (e.g. div-tag styled in CSS). That way you can define scale and position in HTML instead of defining offsets in SDU unit.
  • Browse POI samples

Wikitude SDK JavaScript API 3.1.0

Release Date: 27.08.2013

Fixed

  • Problem with included ade.js on device interfered with ARchitect API
  • AnimatedImageDrawable's frame rate was ignored after resume.
  • Executing onDocumentLocationChanged trigger for HTML Drawable in ADE was broken.
  • Under certain circumstances SDK didn't pause when switched to background.

Improved

  • HTML Drawables work correctly with dynamic content
  • Image detection two times faster
  • Better support for target images with low contrast
  • More reliable tracking, especially for difficult target images
  • Optimized texture memory usage for non square images

Wikitude SDK JavaScript API 3.0.1

Release Date: 25.07.2013

Fixed

  • Orientation issue for Android tablets

Wikitude SDK JavaScript API 3.0.0

Release Date: 18.06.2013

New

  • Integrated image recognition and tracking engine
  • Examples application
  • Support for 3D model animations
  • Support for transparent materials, textures and colors on 3D models
  • API method for setting distance based scaling parameters. See reference on AR.context.scene

Fixed

  • Under certain circumstances the light of a 3D model was ignored
  • Issue when locking screen and radar is visible
  • Possible crash when using wrong license key
  • Possible crash when returning to an ArchitectView that uses HTMLDrawables
  • Aspect ratio in camera for devices with image recognition capability

Improved

  • Image recognition supports up to 1000 targets
  • Rewritten, extended and improved SDK documentation.
  • Significant increase of performance at start up and general performance increase
  • Minor fixes

Removed

  • Support for Vuforia SDK

Wikitude SDK JavaScript API 2.0.0

Release Date: 26.02.2013

New

  • Support for 3D models via new ARchitect class Model

Fixed

  • Missing SD card prevented image recognition from running successfully.

Improved

  • Minor fixes and performance improvements

Wikitude SDK JavaScript API 1.2.0

Release Date: 18.12.2012

New

  • Improved bridge performance (SteelBridge and Weasel)
  • onFinish trigger for AnimatedImageDrawables
  • ImageResource onLoad() reports width and height of loaded image
  • PropertyAnimation can be paused and resumed
  • Customize clicking behavior (click, touch down, touch up)
  • Set culling distance from JavaScript
  • Support for Vuforia SDK v2.0

Improved

  • Architect Desktop Engine (ADE) now overlays world

Wikitude SDK JavaScript API 1.1.1

Release Date: 26.09.2012

Fixed

  • Possible crash when using openInBrowser or startVideoPlayer while IR is active
  • Possible crash when calling start / stop while IR is active

Improved

  • Minor performance increase for rendering HTML drawables.
  • Handling of images with semi transparency

Wikitude SDK JavaScript API 1.1.0

Release Date: 16.08.2012

New

  • HTML Drawables
  • Relative locations
  • Customizable AR radar
  • Sprite Animations
  • 3D Transformation
  • Animation Groups
  • Extension for Qualcomm Vuforia SDK for Image Recognition
  • Possibility to turn off camera and sensors
  • Possibility to add a single drawable to multiple GeoObjects

Improved

  • New tutorials and snippets
  • Library Reference examples and texts
  • New simple IR example
  • Streamlined trigger properties
  • Rendering performance in general
  • Performance of AR.logger output on device

Wikitude SDK JavaScript API 1.0.5

New

  • Added setCullingDistance to ArchitectView (SDK)
  • Added possibility for better error handling when loading an ARchitect World (SDK)
  • Improved SimpleARBrowser example

Note

  • Including a viewport meta-tag in your ARchitect World is recommended if you target different screen resolutions (see ARchitectTools/Hello World/Hello World.html for more details)

Wikitude SDK JavaScript API 1.0.4

  • Licensable SDK

Wikitude SDK JavaScript API 1.0.3

  • Initial Public SDK Release