Documentation

Release Notes Wikitude SDK Professional Edition

Wikitude SDK 9.12.0

Release Date: 2022-07-06

New

  • Version upgrade for curl
  • The extended tracking feature is now marked as deprecated

Known Issues

Wikitude SDK 9.10

Release Date: 2021-08-24

Improved

  • Version upgrade of openssl, curl and FreeImage

Fixed

  • Fix for a rare crash in Instant Tracking functionality when using multiple trackers

Removed

Wikitude SDK 9.9

Release Date: 2021-07-01

New

Fixed

Removed

  • Ended support for Android 5.1. Android 6.0 is now the new minimum supported version

Wikitude SDK 9.8.0

Release Date: 2021-05-18

New

Improved

Fixed

Removed

Wikitude SDK 9.7.1

Release Date: 2021-04-28

Fixed

Wikitude SDK 9.7.0

Release Date: 2021-04-06

New

Improved

Fixed

Removed

Known Issues

Wikitude SDK 9.6.0

Release Date: 2021-02-23

New

Improved

Fixed

Wikitude SDK 9.5.0

Release Date: 2020-12-01

New

Improved

  • Faster initial recognition of Object Targets
  • Faster overall tracking of Object Targets
  • More accurate tracking of Object Targets in difficult situations
  • Better alignment of augmentations for Image Targets

Fixed

Removed

  • The samples in the JavaScript API don't contain any jQuery anymore, making it easier to work with them.

Wikitude SDK 9.4.0

Release Date: 2020-10-21

New

Improved

  • Object Trackers initialize with fewer wrong poses

Fixed

Removed

Wikitude SDK 9.3.1

Release Date: 2020-09-17

New

Known Issues

  • When using Xcode 12 check out the additional manual steps to move the script files.

Wikitude SDK 9.3

Release Date: 2020-08-25

New

Improved

Fixed

Removed

  • Support for iOS 11. iOS 12 is now the new minimum supported version
  • Support for Android 5.0. Android 5.1 is now the new minimum supported version

Known Issues

Wikitude SDK 9.2

Release Date: 2020-07-09

New

Improved

  • Image Tracking now behaves more stable against short, fast movements
  • Data communication with the Cloud Recognition version 2 service adapted, so that recognition accuracy is significantly improved (e.g. greater distance)
  • Update OpenSSL to version 1.1.1

Fixed

  • Fixed Cloud Recognition issue where accuracy was worse when HD or FullHD resolutions being were used

Removed

Known Issues

Wikitude SDK 9.1.0

Release Date: 2020-05-19

New

Improved

  • Tracking is not lost when zooming camera
  • Improvements to accuracy for Object Recognition
  • Improved handling of first recognition for objects
  • Improved alignment of augmentations for image tracking when rotating target

Fixed

Removed

Known Issues

Wikitude SDK 9.0.0

Release Date: 2020-03-31

New

  • Improved image tracking performance and stability

Fixed

Known Issues

Wikitude SDK 8.10.0

Release Date: 2019-12-10

New

  • Release available for Epson platform

Fixed

Known Issues

Wikitude SDK 8.9.1

Release Date: 2019-09-30

Fixed

Known Issues

Wikitude SDK 8.9

Release Date: 2019-09-24

New

  • Implemented support for iOS 13
  • Implemented support for Android 10

Improved

  • WebKit is now enabled by default, replaced all internal use of UIWebView with WKWebView.

Fixed

Removed

  • Removed internal use of the deprecated UIWebView.
  • Removed all UIWebView related properties from the WTArchitectView API.
  • Removed shouldUseWebKit from the WTArchitectView API, since we only use WebKit now.

Known Issues

Wikitude SDK 8.7

Release Date: 2019-08-13

New

Improved

  • Camera frame handling is now faster for all platforms.
  • Range for detecting an image target using an ImageTracker has been significantly improved.

Fixed

Removed

Known Issues

Wikitude SDK 8.6

Release Date: 2019-07-11

New

Improved

  • Changed plugin lifecycle behaviour. A call to pause is now always preceded by a call to resume

Fixed

Removed

  • Support for wto 7.0 file format for Object Targets

Known Issues

Wikitude SDK 8.5

Release Date: 2019-05-23

New

  • Image Recognition engine now can work with jpg, png and zip files as Target Collection resource
  • Image Recognition engine accepts png's with alpha channel as target images and respects transparent areas

Improved

  • Image Recognition engine detects images from a larger distance
  • Image Recognition engine detects duplicate targets more reliably

Fixed

  • Fixed an issue where the extended range option was ignored for Image Trackers, resulting in shorter recognition distance
  • Fixed an issue where the property physicalTargetHeight was not set when using cloud recognition.
  • Fixed an issue where the application could crash in case image, object or instant tracking were used with no valid license key set.
  • Fixed an issue that caused model animations to sometimes not be restarted properly when calling start.
  • Fixed an issue that caused some videos to be rendered incorrectly.
  • Fixed an issue where the application could crash when setting distance, rotation or translation change thresholds at runtime.
  • Fixed an issue where the AR.ObjectTracker.onError callback was called with an invalid argument, resulting in a JavaScript error.
  • Fixed an issue where AR.ImageTracker callbacks might have been called although they were not set, resulting in a JavaScript error.

Removed

Wikitude SDK 8.4

Release Date: 2019-04-09

New

Improved

  • Initial recognition for Object Targets is more accurate and stable
  • Improved recognition for image targets in difficult backgrounds

Fixed

  • Fixed an issue that prevented extended object tracking from working
  • Fixed an issue where 3D models were flickering when using Snap To Screen
  • Fixed an issue that caused landscape image targets to have incorrect augmentation scaling
  • Fixed an issue that caused errors in the JavaScript layer when using cloud recognition in combination with the onImageLost event of the AR.ImageTrackable
  • Fixed an issue that caused camera to stop after pause/resume using Plugins API

Removed

Known Issues

Wikitude SDK 8.3.2

Release Date: 2019-03-11

Fixed

  • Fixes an instant tracking issue where augmentations did not render correctly after the device orientation changed

Wikitude SDK 8.3.0

Release Date: 2019-02-26

New

  • Release of Native API for UWP platform
  • Support for Vuzix M300 for JavaScript API
  • General upgrade of computer vision engine increasing reliability and speed for Image, Object and Instant Trackers

Improved

Fixed

  • Fixes potential crash caused by ongoing network connections while destroying the SDK
  • Fixes an issue that caused instant tracking plane clicks to be registered incorrectly while not tracking
  • Fixes an issue that caused onRotationChanged callbacks to not obey the threshold correctly (missing invocations for values close to 180°)
  • Fixes rare crash when extended object tracking is frequently stopped and restarted

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 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

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

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 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
  • Support Epson BT-300 and BT-350

Improved

  • General performance improvements for Intel™ based architectures
  • Optimized performance for Instant Tracking
  • Updated method for personal calibration
  • Content in the sample application now better fits Epson screen

Fixed

  • Fixes an issue that occurred when AR.Model objects were assigned as instant tracking initialization drawables
  • Calculation of distance to target

Wikitude SDK 7.1.0

Release Date: 19.09.2017

New

Improved

  • Improved OpenGL ES resource handling

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

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
  • Improved calibration accuracy

Fixed

  • Return appropriate return values in the gesture event callbacks
  • Issue where setting AR.Drawable.rotate was not resulting in a correct rotation

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 5.3.1

Release Date: 24.11.2016

Fixed

SDK

Wikitude SDK 5.3.0

Release Date: 13.09.2016

New

SDK
  • Android 7.0 Nougat support
  • 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 tracking
  • 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 5.2.0

Release Date: 21.07.2016

(see list of known issues)

New

SDK
  • Custom Calibration for Smart Glasses
  • 1:1 Calibration
  • InputPlugins allow developer to use the Wikitude SDK with an external camera feed
  • New JS API to specify a custom cloud recognition server url through AR.context
  • Support for AR.openInBrowser(url, forceNative=false)
  • Support multiple regional co-located cloud recognition services
  • 3D model import: account for pivot node transformations
  • Extended Tracking
  • Plugins API
  • Full Android Studio setup and support
  • 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
3D Encoder
  • Option to select the type of back-face culling that should be applied when rendering the 3D model
  • 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
  • Updates OpenSSL to version 1.01r
  • Memory leak when using continuous cloud recognition
  • 3D models with 'Grouping on Takes' did not consider different animation offsets
  • 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
    • Crash on low end devices regarding threading
  • Continuous cloud recognition could not be stopped
  • Missing textures on certain 3D models
    • 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
  • 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
  • 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
  • Potential problem when deleting large .wtc files
  • onSnappedToScreen function is not called when using the enabledOnExitFieldOfVision property
  • 3D Model with animation not clickable
  • Compatibility with Android 5.0
  • Race condition on ArchitectView startup (leading to crash) when Javascript command are issued before the main HTML is loaded.
  • Better handling of AR worlds containing more VideoDrawables.
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
  • Windows 3D Encoder always rendered empty scenes
  • Memory leak on screenshot creation

Improved

  • Wikitude Sample App now implements Android Runtime Permissions (applies to Android 6.0 - API level 23)
  • Newest version of 3D rendering engine
  • Performance of Image Recognition initial recognition phase
  • Tracking Performance optimized and streamlined

Removed

  • Official support for Android version lower than Android 4.0

Wikitude SDK 4.0.2

Release Date: 18.08.2014

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

Wikitude SDK 4.0.1

Release Date: 07.08.2014

Fixed

  • Fixes VideoDrawable crash related to code obfuscation when creating a Play Store application

Wikitude SDK 4.0.0

Release Date: 29.07.2014

New

Fixed

  • A potential issue that caused rendering artefacts 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
  • Source code comments in sample apps

Wikitude SDK 3.2.2

Release Date 24.02.2014

New

  • Initial Public Release
  • Optimized version of the Wikitude SDK for Epson Moverio BT-200

Known issues

  • Design of cloud recognition sample (on-click) is misleading as button is in center and hard to reach
  • Videos tend to stutter.