SpatialEntityStore Class

Definition

Represents a shared pool of spatial entities, synchronized automatically among the participants in a remote session.

public ref class SpatialEntityStore sealed
class SpatialEntityStore sealed
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Windows.Perception.Spatial.ISpatialEntityStoreStatics), 262144, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class SpatialEntityStore
Public NotInheritable Class SpatialEntityStore
Inheritance
SpatialEntityStore
Attributes

Windows 10 requirements

Device family
Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v4.0)

Remarks

Important

The SpatialEntityStore approach of synchronizing spatial anchors between devices is not currently supported. Consider using Azure Spatial Anchors instead.

Properties

IsSupported

Gets whether spatial entity sharing is supported on this system.

Methods

CreateEntityWatcher()

Gets a watcher that lets an app observe when participants add, update or remove entities in the store.

RemoveAsync(SpatialEntity)

Removes a spatial entity from the store for all participants.

SaveAsync(SpatialEntity)

Saves a new or updated spatial entity into the store, to be synchronized with all participants.

TryGet(RemoteSystemSession)

Establishes or retrieves an automatically-synchronized pool of spatial entities for a remote session.

Applies to