Overall Workflow and Limitations

A quick look at the basic workflow of the SDK.

Basic Workflow

The process to enable persistent AR in a space can be divided into two main parts.

  • Mapping of the space.

  • Finding the device position in the space by localizing against the constructed map.

Our SDK provides functions for both mapping and localizing.

When mapping a space with our SDK, the images are sent to our servers for map construction.

After construction, the map can be downloaded from our servers. You can either download and embed the map into your app for full offline use or download the maps at runtime. Localization against the map happens on device.

We will later support localizing directly on servers. If this is something you are interested in, contact us at sdk@immersal.com.

Basic workflow illustrated.


The provided Mapping App Sample has 1 Workspace available for free trial users.

User-captured images are stored into this Workspace and are used for constructing the maps. Free trial users are effectively limited to working with one space at a time by having just one Workspace.

All constructed maps are stored in your account separate of the Workspace and can be downloaded later even if the images used to construct those maps have been deleted from your Workspace.

Screenshot of the Mapping App Workspace mode.


Localization uses map files that can be downloaded from the Developer Portal or by using the REST API.

For more information on how the set up localization, see Using the Multimap Sample.

The Mapping App Sample also includes a mode to test and visualize constructed maps.

Screenshot of the Mapping App's Visualize mode. The blue dots represent the point cloud of the map.


Current limitations for free trial users are:

  • 1 Workspace.

  • A limit of 128 images in the workspace. This should be enough for room-scale maps and slightly larger.

Only mapping needs a registered account and an active Developer Token. Localization can be done with just the map file available from Developer Portal. The map file can be shared with other users.