PerceptionDepthFrameSourceWatcher Class

Definition

Namespace:

Windows.Devices.Perception

Monitors changes to the list of depth frame sources, and provides notifications when the list changes.

public ref class PerceptionDepthFrameSourceWatcher sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Deprecated("PerceptionDepthFrameSourceWatcher may be unavailable after Windows Creator Update.  Use Windows.Devices.Enumeration.DeviceWatcher instead.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
class PerceptionDepthFrameSourceWatcher final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Deprecated("PerceptionDepthFrameSourceWatcher may be unavailable after Windows Creator Update.  Use Windows.Devices.Enumeration.DeviceWatcher instead.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
public sealed class PerceptionDepthFrameSourceWatcher

Public NotInheritable Class PerceptionDepthFrameSourceWatcher

Inheritance

Object Platform::Object IInspectable PerceptionDepthFrameSourceWatcher

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute DeprecatedAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Properties

Status

Gets the operational status of the depth frame source watcher.

Methods

Start()	When this method is called, the depth frame source watcher enumerates any existing depth frame sources it has not already enumerated by firing a SourceAdded event for each one. An EnumerationCompleted event is fired when this enumeration is complete. The depth frame source then starts watching for new depth frame sources.
Stop()	When this method is called, the depth frame source watcher stops looking for changes to the depth frame source list. This operation is not immediate; the Stopped event will be triggered when the Stop operation is complete.

Events

EnumerationCompleted	Subscribes to the EnumerationCompleted event. This event is fired after the initial enumeration of known depth frame sources is complete.
SourceAdded	Subscribes to the SourceAdded event.
SourceRemoved	Subscribes to the SourceRemoved event. This event is fired once for every depth frame source that is removed.
Stopped	Subscribes to the Stopped event. This event is fired when the IPerceptionColorFrameSourceWatcher has stopped listening for changes to the list of depth frame sources.