Table Of Contents

Previous topic

Getting Started

Next topic

2.0

Getting Started with EasyAR SDK

What is EasyAR SDK

EasyAR SDK is an Augmented Reality Engine. There are two editions, EasyAR SDK Basic and EasyAR SDK Pro. EasyAR SDK 1.x only have the Basic Edition.

EasyAR SDK Basic is free for commercial use. There is no limitations or any watermarks. It supports AR based on planar target, supports smooth load and recognition for more than 1000 local targets, supports video playback based on HW codecs, supports transparent video and streaming video, supports QR code recognition, supports tracking multi-target simultaneously.

EasyAR SDK Pro is a brand-new edition introduced in EasyAR SDK 2.0. All features inside EasyAR SDK Basic are available in EasyAR SDK Pro. And there are more features compared to EasyAR SDK Basic, including 3D object tracking, SLAM, and screen recording.

EasyAR SDK Pro is not free, pricing and payment details are listed on the EasyAR SDK product page. Free trial for EasyAR SDK Pro is provided. Each app will have limited startup times every day in the trial period.

Registration

Registration is required to use EasyAR.

Register at www.easyar.com using your email address. If you have already have a SightPlus account, you can login use your account and you may be asked to complete your information for email.

Get a KEY

*Please notice the details and operations of the webpage in this section may change.

To initialize EasyAR SDK, a key is required.

Key is generated after you create an item after login.

../../_images/image111.png

Bundle ID/Package Name is required if you are creating mobile apps.

../../_images/image121.png

You can modify application name after the creation. The bundle ID cannot be changed once after creation.

../../_images/image131.png

To get the key, press key on the right side, then you will enter the key page.

This page shows you the current status of the application, the features enabled and keys for all EasyAR SDK versions. The right corner is a place to show which EasyAR SDK editions are available for this application.

../../_images/image141.png

Keys cannot be used with mismatched EasyAR SDK versions. EasyAR SDK 1.0 key can be used only on EasyAR 1.0 and other 1.0 minor versions. EasyAR SDK 2.0 key can be used only on EasyAR 2.0 for now, and other 2.0 minor versions if not specified later. Click show to view the key.

../../_images/image151.png

Which Key should I use?

EasyAR SDK 1.0 key can be used only on EasyAR 1.0 and other 1.0 minor versions.

EasyAR SDK 2.0 key can be used only on EasyAR 2.0 for now, and other 2.0 minor versions if not specified later. Click show to view the key.

You can use a basic key on EasyAR SDK Basic but not on EasyAR SDK Pro. If a basic key is used on EasyAR SDK Pro, you will get an Invalid Key error.

You can use a basic + Pro(trail) key on both EasyAR SDK Basic and EasyAR SDK Pro. When used on EasyAR SDK Basic, there are no limitations and it acts the same as you are using a basic key. But when used on EasyAR SDK Pro, it will only allow you to initialize the Pro SDK 100 times per day. When the number of calls to initialize exceeds the limitation, you will get an Invalid Key error when used on EasyAR SDK Pro, but everything will still work and there will be no errors if used on EasyAR SDK Basic.

You can use a basic + Pro key on both EasyAR SDK Basic and EasyAR SDK Pro, with no limitations.

EasyAR SDK Basic and EasyAR SDK Pro are packaged with the Basic or Pro name, make sure to download and use the SDK package you need.

Pro Trail

*Please notice the details and operations of the webpage in this section may change.

To use EasyAR SDK Pro, you have to have a key available for Pro features. You can have free trail by making your app pro available. Click the Try Pro feature button on the right side.

../../_images/image161.png

Then the right corner will change, showing that pro feature is available for trail. This operation do not cost any money and you are safe to change it back by pressing stop pro Trail on the right.

../../_images/image171.png

Pro Upgrade

*Please notice the details and operations of the webpage in this section may change.

When you are satisfied with EasyAR Pro features, you can upgrade you app to the formal Pro version. This will remove the limitations for trail. Click Enable Pro feature button on the right side after purchase.

../../_images/image181.png

Then the right corner will change, showing that pro feature is enabled.

../../_images/image191.png

Please notice once you have upgrade your app to Pro, there is no way to go back.

Continue with EasyAR SDK Samples

The links below will lead you to the description for the latest SDK version. You can find similar articles for older versions.

Continue with EasyAR SDK Packages

The links below will lead you to the description for the latest SDK version. You can find similar articles for older versions.