Documentation

How to obtain a free trial license

The Wikitude SDK requires a valid license key to be able to run properly. An empty or missing license key will block the augmented reality view from showing any meaningful content. You will see a watermark across the screen with the words License Key Missing. All JavaScript API calls will be ignored and not interpreted.

When downloading the Wikitude SDK 4.1 you will be forwarded to the license generation page, where a trial license key is automatically generated for you.

Copy the key into your app, which will unlock the trial mode of the Wikitude SDK. The trial mode of the Wikitude SDK contains the full feature set of the Wikitude SDK but will show a Trial watermark across the screen.

Each trial license key is valid for every application ID on every operating system. You can use the same trial license key in multiple apps.

Where should I enter the license key

Android

To use the Wikitude Android SDK you need to provide a valid license key to the onCreate lifecycle-method of the ArchitectView. This can either be done directly by providing the key as a string and the call the onCreate(final String key) method or creating an StartupConfiguration object, passing it the license as a string and then call the onCreate(final StartupConfiguration config) method. Please refer to the AbstractArchitectCamActivity of the SDK Examples project for a practical example of how to set the license key.

Epson Moverio

To use the Wikitude Epson Moverio SDK you need to provide a valid license key to the onCreate lifecycle-method of the ArchitectView. This can either be done directly by providing the key as a string and the call the onCreate(final String key) method or creating an StartupConfiguration object, passing it the license as a string and then call the onCreate(final StartupConfiguration config) method. Please refer to the AbstractArchitectCamActivity of the SDK Examples project for a practical example of how to set the license key.

iOS

To use the Wikitude iOS SDK with a certain license key, use the method -setLicenseKey: defined in WTArchitectView.h and provide a valid license key. The SDK Example application demonstrates the license handling in the file WTStandardARViewController.m. The license key is defined in line 17 and used in line 71.

Google Glass

To use the Google Glass SDK you need to provide a valid license key to the onCreate lifecycle-method of the ArchitectView. This can either be done directly by providing the key as a string and the call the onCreate(final String key) method or creating an StartupConfiguration object, passing it the license as a string and then call the onCreate(final StartupConfiguration config) method. Please refer to the AbstractArchitectCamActivity of the SDK Examples project for a practical example of how to set the license key.

Cordova Plugin

To use the Wikitude Cordova Plugin with a certain license key, use the this._sdkKey property defined in WikitudePlugin.js line 12. Please make sure that the license key is set in the appropriate WikitudePlugin.js file since Cordova is duplicating this particular file in both www folder.

Titanium Module

To use the Wikitude Titanium Module with a certain license key, enter the key while calling the Wikitude Module function createWikitudeView. This is demonstrated in the Wikitude Titanium sample application file ARchitectWindow.js line 31 and the key is defined in MainWindow.js line 14.

Vuzix

To use the Wikitude Vuzix SDK you need to provide a valid license key to the onCreate lifecycle-method of the ArchitectView. This can either be done directly by providing the key as a string and the call the onCreate(final String key) method or creating an StartupConfiguration object, passing it the license as a string and then call the onCreate(final StartupConfiguration config) method. Please refer to the AbstractArchitectCamActivity of the SDK Examples project for a practical example of how to set the license key.

Xamarin Component

Xamarin.iOS

To use the Wikitude iOS SDK with a certain license key, use the method -setLicenseKey: defined in the Xamarin Binding and provide a valid license key. The Wikitude Xamarin Example application demonstrates the license handling in the file ARViewController.cs line 34.

Xamarin.Android

To use the Wikitude iOS SDK with a certain license key, create a StartupConfiguration with your license key and pass this config object to the ArchitectView.OnCreate method. The Wikitude Xamarin Example application demonstrates the license handling in the file BasicArchitectActivity.cs line 49 - 51.