SpatialEntityStore SpatialEntityStore SpatialEntityStore SpatialEntityStore SpatialEntityStore Class


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

public : sealed class SpatialEntityStore
struct winrt::Windows::Perception::Spatial::SpatialEntityStore
public sealed class SpatialEntityStore
Public NotInheritable Class SpatialEntityStore
// This class does not provide a public constructor.

Windows 10 requirements

Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)



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


IsSupported IsSupported IsSupported IsSupported IsSupported

Gets whether spatial entity sharing is supported on this system.


CreateEntityWatcher() CreateEntityWatcher() CreateEntityWatcher() CreateEntityWatcher() CreateEntityWatcher()

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

RemoveAsync(SpatialEntity) RemoveAsync(SpatialEntity) RemoveAsync(SpatialEntity) RemoveAsync(SpatialEntity) RemoveAsync(SpatialEntity)

Removes a spatial entity from the store for all participants.

SaveAsync(SpatialEntity) SaveAsync(SpatialEntity) SaveAsync(SpatialEntity) SaveAsync(SpatialEntity) SaveAsync(SpatialEntity)

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

TryGet(RemoteSystemSession) TryGet(RemoteSystemSession) TryGet(RemoteSystemSession) TryGet(RemoteSystemSession) TryGet(RemoteSystemSession)

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