SpatialEntityWatcher SpatialEntityWatcher SpatialEntityWatcher SpatialEntityWatcher SpatialEntityWatcher Class

Definition

Monitors changes to the set of entities that participants add, update, or remove within a spatial entity store, and provides notifications when that set changes.

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

Windows 10 requirements

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

Remarks

Important

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

Properties

Status Status Status Status Status

Gets the operational status of the spatial entity watcher.

Methods

Start() Start() Start() Start() Start()

Starts watching for changes to the set of spatial entities in the store.

Stop() Stop() Stop() Stop() Stop()

Stops watching for changes to the set of spatial entities in the store.

Events

Added Added Added Added Added

The event that is raised when a new spatial entity is added to the store by a participant.

EnumerationCompleted EnumerationCompleted EnumerationCompleted EnumerationCompleted EnumerationCompleted

The event that is raised when the initial replay of prior changes to the spatial entity store has completed.

Removed Removed Removed Removed Removed

The event that is raised when a spatial entity is removed from the store by a participant.

Updated Updated Updated Updated Updated

The event that is raised when an existing spatial entity has its metadata updated by a participant.