PerceptionDepthFrameReader Class

Definition

Namespace:

Windows.Devices.Perception

Reads depth frames from a depth frame source.

public ref class PerceptionDepthFrameReader sealed : IClosable

/// [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("PerceptionDepthFrameReader may be unavailable after Windows Creator Update.  Use Windows.Media.Capture.Frames.MediaFrameReader instead.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
class PerceptionDepthFrameReader final : IClosable

[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("PerceptionDepthFrameReader may be unavailable after Windows Creator Update.  Use Windows.Media.Capture.Frames.MediaFrameReader instead.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
public sealed class PerceptionDepthFrameReader : System.IDisposable

Public NotInheritable Class PerceptionDepthFrameReader
Implements IDisposable

Inheritance

Object Platform::Object IInspectable PerceptionDepthFrameReader

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute DeprecatedAttribute

Implements

IClosable IDisposable

Windows requirements

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

Properties

IsPaused	Gets a boolean value indicating whether or not this reader is paused.
Source	Gets the depth frame source this reader gets frames from.

Methods

Close()	Releases system resources that are exposed by a Windows Runtime object
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
TryReadLatestFrame()	Attempts to read the most recent frame that is available to this depth frame reader.

Events

FrameArrived

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

See also

• IClosable