Azure Spatial Anchors

Azure Spatial Anchors

Windows
MacOS
Linux
On this page

Actions

Construct Cloud Anchor

Construct a cloud anchor for the pin. This is not yet stored in the cloud.

Target is Azure Spatial Anchors Library

Create ARPin Around Azure Cloud Spatial Anchor

Create an ARPin around an already existing cloud anchor.

Target is Azure Spatial Anchors Library

Create Watcher

Create and start a 'Watcher' searching for azure cloud spatial anchors as specified in the locate criteria. Use an AzureSpatialAnchorsEventComponent's events to get notifications of found anchors and watcher completion.

Target is Azure Spatial Anchors Library

Get App Properties

The AppProperties dictionary of the cloud anchor.

Target is Azure Cloud Spatial Anchor

Get Azure Cloud Identifier

The Azure Cloud identifier of the spatial anchor is the persistent identifier by which a cloud anchor can be requested from the azure cloud service. Empty if the anchor has not been saved or loaded yet.

Target is Azure Cloud Spatial Anchor

Get Expiration

The Expiration time of the cloud anchor as seconds into the future.

Target is Azure Cloud Spatial Anchor

Refresh Cloud Anchor Properties

Get the latest cloud anchor properties from the cloud. This will start a Latent Action to fetch the AzureCloudSpatialAnchor's propertiesfrom the Azure Spatial Anchors cloud service.

Target is Azure Spatial Anchors Library

Save Cloud Anchor

Save the cloud anchor to the cloud. This will start a Latent Action to save the AzureCloudSpatialAnchor to the Azure Spatial Anchors cloud service.

Target is Azure Spatial Anchors Library

Set App Properties

Set the AppProperties dictionary of the cloud anchor. You must call SaveCloudAnchor or UpdateCloudAnchorProperties before these will be persisted on azure.

Target is Azure Cloud Spatial Anchor

Set Expiration

Set the Expiration time of the cloud anchor as seconds into the future. You must call SaveCloudAnchor or UpdateCloudAnchorProperties before this will be persisted on azure.

Target is Azure Cloud Spatial Anchor

Stop Watcher

Stop the specified Watcher looking for anchors, if it still exists.

Target is Azure Spatial Anchors Library

Update Cloud Anchor Properties

Save the cloud anchor's properties to the cloud. This will start a Latent Action to save the AzureCloudSpatialAnchor properties to the Azure Spatial Anchors cloud service. This can fail if another client updates the anchor. If that happens you will have to call RefreshCloudAnchorProperties to get the updated values before you might UpdateCloudAnchorProperties sucessfully.

Target is Azure Spatial Anchors Library

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback