Quickstart: Create an Android app with Azure Spatial Anchors

This quickstart covers how to create an Android app using Azure Spatial Anchors in either Java or C++/NDK. Azure Spatial Anchors is a cross-platform developer service that allows you to create mixed reality experiences using objects that persist their location across devices over time. When you're finished, you'll have an ARCore Android app that can save and recall a spatial anchor.

You'll learn how to:

  • Create a Spatial Anchors account
  • Configure the Spatial Anchors account identifier and account key
  • Deploy and run on an Android device

If you don't have an Azure subscription, create a free account before you begin.

Prerequisites

To complete this quickstart, make sure you have:

  • A Windows or macOS machine with Android Studio 3.4+.
    • If running on Windows, you'll also need Git for Windows and Git LFS.
    • If running on macOS, get Git installed via HomeBrew. Enter the following command into a single line of the Terminal: /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)". Then, run brew install git and brew install git-lfs.
    • To build the NDK sample, you'll also need to install the NDK and CMake 3.6 or greater SDK Tools in Android Studio.
  • A developer enabled and ARCore capable Android device.
    • Additional device drivers may be required for your computer to communicate with your Android device. See here for additional information and instructions.
  • Your app must target ARCore 1.11.0.

Create a Spatial Anchors resource

Go to the Azure portal.

On the left pane, select Create a resource.

Use the search box to search for Spatial Anchors.

Screenshot showing the results of a search for Spatial Anchors.

Select Spatial Anchors, and then select Create.

On the Spatial Anchors Account pane, do the following:

  • Enter a unique resource name by using regular alphanumeric characters.

  • Select the subscription that you want to attach the resource to.

  • Create a resource group by selecting Create new. Name it myResourceGroup, and then select OK.

    A resource group is a logical container into which Azure resources, such as web apps, databases, and storage accounts, are deployed and managed. For example, you can choose to delete the entire resource group in one simple step later.

  • Select a location (region) in which to place the resource.

  • Select New to begin creating the resource.

Screenshot of the Spatial Anchors pane for creating a resource.

After the resource is created, the Azure portal shows that your deployment is complete.

Screenshot showing that the resource deployment is complete.

Select Go to resource. You can now view the resource properties.

Copy the resource's Account ID value into a text editor for later use.

Screenshot of the resource properties pane.

Also copy the resource's Account Domain value into a text editor for later use.

Screenshot showing the resource's account domain value.

Under Settings, select Key. Copy the Primary key value, Account Key, into a text editor for later use.

Screenshot of the Keys pane for the account.

Open the sample project

Clone the samples repository by running the following commands:

git clone https://github.com/Azure/azure-spatial-anchors-samples.git
cd ./azure-spatial-anchors-samples

Open Android Studio.

Select Open an existing Android Studio project and select the project located at Android/Java/.

Configure account identifier and key

The next step is to configure the app to use your account identifier and account key. You copied them into a text editor when setting up the Spatial Anchors resource.

Open Android/Java/app/src/main/java/com/microsoft/sampleandroid/AzureSpatialAnchorsManager.java.

Locate the SpatialAnchorsAccountKey field and replace Set me with the account key.

Locate the SpatialAnchorsAccountId field and replace Set me with the account identifier.

Locate the SpatialAnchorsAccountDomain field and replace Set me with the account domain.

Deploy the app to your Android device

Power on the Android device, sign in, and connect it to the PC using a USB cable.

Select Run from the Android Studio toolbar.

Android Studio Deploy and Run

Select the Android device in the Select Deployment Target dialog, and select OK to run the app on the Android device.

Follow the instructions in the app to place and recall an anchor.

Stop the app by selecting Stop from the Android Studio toolbar.

Android Studio Stop

Clean up resources

In the preceding steps, you created Azure resources in a resource group. If you don't expect to need these resources in the future, you can delete them by deleting the resource group.

From the Azure portal menu or Home page, select Resource groups. Then, on the Resource groups page, select myResourceGroup.

On the myResourceGroup page, make sure that the listed resources are the ones you want to delete.

Select Delete resource group, type myResourceGroup in the text box to confirm, and then select Delete.

Next steps

In this quickstart, you created a Spatial Anchors account. You then configured and deployed an app to save and recall spatial anchors. To learn more about how to improve the app so it can share spatial anchors with other devices, continue to the next tutorial.