PerceptionDepthFrameSourceWatcher
PerceptionDepthFrameSourceWatcher
PerceptionDepthFrameSourceWatcher
PerceptionDepthFrameSourceWatcher
Class
Definition
Monitors changes to the list of depth frame sources, and provides notifications when the list changes.
public : sealed class PerceptionDepthFrameSourceWatcher : IPerceptionDepthFrameSourceWatcherpublic sealed class PerceptionDepthFrameSourceWatcher : IPerceptionDepthFrameSourceWatcherPublic NotInheritable Class PerceptionDepthFrameSourceWatcher Implements IPerceptionDepthFrameSourceWatcher// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Properties
Status Status Status Status
Gets the operational status of the depth frame source watcher.
public : DeviceWatcherStatus Status { get; }public DeviceWatcherStatus Status { get; }Public ReadOnly Property Status As DeviceWatcherStatus// You can use this property in JavaScript.
A DeviceWatcherStatus enumeration value indicating the status of the depth frame source watcher.
Methods
Start() Start() Start() 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.
public : void Start()public void Start()Public Function Start() As void// You can use this method in JavaScript.
Stop() Stop() Stop() 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.
public : void Stop()public void Stop()Public Function Stop() As void// You can use this method in JavaScript.
Events
EnumerationCompleted EnumerationCompleted EnumerationCompleted EnumerationCompleted
Subscribes to the EnumerationCompleted event. This event is fired after the initial enumeration of known depth frame sources is complete.
public : event TypedEventHandler EnumerationCompleted<PerceptionDepthFrameSourceWatcher, object>public event TypedEventHandler EnumerationCompleted<PerceptionDepthFrameSourceWatcher, object>Public Event EnumerationCompleted<PerceptionDepthFrameSourceWatcher, object>// You can use this event in JavaScript.
SourceAdded SourceAdded SourceAdded SourceAdded
Subscribes to the SourceAdded event.
public : event TypedEventHandler SourceAdded<PerceptionDepthFrameSourceWatcher, PerceptionDepthFrameSourceAddedEventArgs>public event TypedEventHandler SourceAdded<PerceptionDepthFrameSourceWatcher, PerceptionDepthFrameSourceAddedEventArgs>Public Event SourceAdded<PerceptionDepthFrameSourceWatcher, PerceptionDepthFrameSourceAddedEventArgs>// You can use this event in JavaScript.
Remarks
When the Start method is called, this event is fired for every depth frame source already known to the system, then the EnumerationCompleted event is fired. New depth frame sources that are subsequently added will trigger additional SourceAdded events.
SourceRemoved SourceRemoved SourceRemoved SourceRemoved
Subscribes to the SourceRemoved event. This event is fired once for every depth frame source that is removed.
public : event TypedEventHandler SourceRemoved<PerceptionDepthFrameSourceWatcher, PerceptionDepthFrameSourceRemovedEventArgs>public event TypedEventHandler SourceRemoved<PerceptionDepthFrameSourceWatcher, PerceptionDepthFrameSourceRemovedEventArgs>Public Event SourceRemoved<PerceptionDepthFrameSourceWatcher, PerceptionDepthFrameSourceRemovedEventArgs>// You can use this event in JavaScript.
Stopped Stopped Stopped 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.
public : event TypedEventHandler Stopped<PerceptionDepthFrameSourceWatcher, object>public event TypedEventHandler Stopped<PerceptionDepthFrameSourceWatcher, object>Public Event Stopped<PerceptionDepthFrameSourceWatcher, object>// You can use this event in JavaScript.