PerceptionDepthFrameReader PerceptionDepthFrameReader PerceptionDepthFrameReader PerceptionDepthFrameReader Class

Definition

Reads depth frames from a depth frame source.

public : sealed class PerceptionDepthFrameReader : IPerceptionDepthFrameReader, IClosablepublic sealed class PerceptionDepthFrameReader : IPerceptionDepthFrameReader, IDisposablePublic NotInheritable Class PerceptionDepthFrameReader Implements IPerceptionDepthFrameReader, IDisposable// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

IsPaused IsPaused IsPaused IsPaused

Gets a boolean value indicating whether or not this reader is paused.

public : PlatForm::Boolean IsPaused { get; set; }public bool IsPaused { get; set; }Public ReadWrite Property IsPaused As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

A boolean value indicating whether or not this reader is paused.

Source Source Source Source

Gets the depth frame source this reader gets frames from.

public : PerceptionDepthFrameSource Source { get; }public PerceptionDepthFrameSource Source { get; }Public ReadOnly Property Source As PerceptionDepthFrameSource// You can use this property in JavaScript.

Methods

Close() Close() Close() Close()

Releases system resources that are exposed by a Windows Runtime object

public : void Close()This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.

Dispose() Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

This member is not implemented in C++void Dispose()Sub Disposevoid Dispose()

TryReadLatestFrame() TryReadLatestFrame() TryReadLatestFrame() TryReadLatestFrame()

Attempts to read the most recent frame that is available to this depth frame reader.

public : PerceptionDepthFrame TryReadLatestFrame()public PerceptionDepthFrame TryReadLatestFrame()Public Function TryReadLatestFrame() As PerceptionDepthFrame// You can use this method in JavaScript.
Returns

If the attempt was successful, this method returns the most recent frame that is available to this depth frame reader. If the attempt was not successful, this method returns null.

Events

FrameArrived FrameArrived FrameArrived FrameArrived

Subscribes to the FrameArrived event. This event is fired whenever a new frame arrives from the depth frame source.

public : event TypedEventHandler FrameArrived<PerceptionDepthFrameReader,  PerceptionDepthFrameArrivedEventArgs>public event TypedEventHandler FrameArrived<PerceptionDepthFrameReader,  PerceptionDepthFrameArrivedEventArgs>Public Event FrameArrived<PerceptionDepthFrameReader,  PerceptionDepthFrameArrivedEventArgs>// You can use this event in JavaScript.