PerceptionDepthFrameSource PerceptionDepthFrameSource PerceptionDepthFrameSource PerceptionDepthFrameSource PerceptionDepthFrameSource Class

Definition

A frame source that provides depth frames.

public : sealed class PerceptionDepthFrameSource : IPerceptionDepthFrameSource, IPerceptionDepthFrameSource2
struct winrt::Windows::Devices::Perception::PerceptionDepthFrameSource : IPerceptionDepthFrameSource, IPerceptionDepthFrameSource2
public sealed class PerceptionDepthFrameSource : IPerceptionDepthFrameSource, IPerceptionDepthFrameSource2
Public NotInheritable Class PerceptionDepthFrameSource Implements IPerceptionDepthFrameSource, IPerceptionDepthFrameSource2
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

Active Active Active Active Active

Gets a boolean value indicating whether or not the source is active.

Available Available Available Available Available

Gets a boolean value indicating whether or not the source is available.

AvailableVideoProfiles AvailableVideoProfiles AvailableVideoProfiles AvailableVideoProfiles AvailableVideoProfiles

Gets a read-only collection of video profiles that are currently available from the depth frame source.

CameraIntrinsics CameraIntrinsics CameraIntrinsics CameraIntrinsics CameraIntrinsics

Gets a CameraIntrinsics value specifying the intrinsic properties of the depth frame source camera device.

DeviceId DeviceId DeviceId DeviceId DeviceId

Gets a string value that identifies the device on the system.

DeviceKind DeviceKind DeviceKind DeviceKind DeviceKind

Gets a string value indicating the kind of physical device that generates the depth frames.

DisplayName DisplayName DisplayName DisplayName DisplayName

Gets a string value indicating the display name of the depth frame source.

Id Id Id Id Id

Gets a string value indicating the unique ID of the depth frame source.

IsControlled IsControlled IsControlled IsControlled IsControlled

Gets a boolean value indicating whether or not the source is the subject of controller mode.

Properties Properties Properties Properties Properties

Gets a read-only collection of frame source properties.

SupportedVideoProfiles SupportedVideoProfiles SupportedVideoProfiles SupportedVideoProfiles SupportedVideoProfiles

Gets a read-only collection of video profiles that are supported by the depth frame source.

VideoProfile VideoProfile VideoProfile VideoProfile VideoProfile

Gets a PerceptionVideoProfile object indicating the current video profile.

Methods

AcquireControlSession() AcquireControlSession() AcquireControlSession() AcquireControlSession() AcquireControlSession()

Attempts to acquire Controller Mode on the depth frame source.

CanControlIndependentlyFrom(String) CanControlIndependentlyFrom(String) CanControlIndependentlyFrom(String) CanControlIndependentlyFrom(String) CanControlIndependentlyFrom(String)

This method returns a boolean value indicating whether or not the depth frame source can be controlled separately from another frame source.

CreateWatcher() CreateWatcher() CreateWatcher() CreateWatcher() CreateWatcher()

Creates a new depth frame source watcher.

FindAllAsync() FindAllAsync() FindAllAsync() FindAllAsync() FindAllAsync()

Finds all depth frame sources.

FromIdAsync(String) FromIdAsync(String) FromIdAsync(String) FromIdAsync(String) FromIdAsync(String)

Finds an depth frame source by looking up its unique ID.

IsCorrelatedWith(String) IsCorrelatedWith(String) IsCorrelatedWith(String) IsCorrelatedWith(String) IsCorrelatedWith(String)

Checks whether or not the depth frame source is correlated with the target entity. If the result is true, a transform matrix can be retrieved to change coordinate basis from this depth frame source to the entity, or vice versa.

OpenReader() OpenReader() OpenReader() OpenReader() OpenReader()

Gets a frame reader that reads frames from this depth frame source.

RequestAccessAsync() RequestAccessAsync() RequestAccessAsync() RequestAccessAsync() RequestAccessAsync()

Requests access to use depth frame sources.

TryGetDepthCorrelatedCameraIntrinsicsAsync(PerceptionDepthFrameSource) TryGetDepthCorrelatedCameraIntrinsicsAsync(PerceptionDepthFrameSource) TryGetDepthCorrelatedCameraIntrinsicsAsync(PerceptionDepthFrameSource) TryGetDepthCorrelatedCameraIntrinsicsAsync(PerceptionDepthFrameSource) TryGetDepthCorrelatedCameraIntrinsicsAsync(PerceptionDepthFrameSource)

Attempts to get the intrinsic properties of the depth camera that is correlated with this depth source.

TryGetDepthCorrelatedCoordinateMapperAsync(String, PerceptionDepthFrameSource) TryGetDepthCorrelatedCoordinateMapperAsync(String, PerceptionDepthFrameSource) TryGetDepthCorrelatedCoordinateMapperAsync(String, PerceptionDepthFrameSource) TryGetDepthCorrelatedCoordinateMapperAsync(String, PerceptionDepthFrameSource) TryGetDepthCorrelatedCoordinateMapperAsync(String, PerceptionDepthFrameSource)

Attempts to get a coordinate mapper that maps from depth frame image space to depth frame space.

TryGetTransformTo(String, Matrix4x4) TryGetTransformTo(String, Matrix4x4) TryGetTransformTo(String, Matrix4x4) TryGetTransformTo(String, Matrix4x4) TryGetTransformTo(String, Matrix4x4)

Gets the transform from the depth frame source to the target entity and sets hasResult to true, if a correlation exists. If a correlation does not exist, hasResult is set to false and result is not modified.

TrySetVideoProfileAsync(PerceptionControlSession, PerceptionVideoProfile) TrySetVideoProfileAsync(PerceptionControlSession, PerceptionVideoProfile) TrySetVideoProfileAsync(PerceptionControlSession, PerceptionVideoProfile) TrySetVideoProfileAsync(PerceptionControlSession, PerceptionVideoProfile) TrySetVideoProfileAsync(PerceptionControlSession, PerceptionVideoProfile)

Attempts to set a video profile on this depth frame source. Requires an active Controller Mode control session on this frame source.

Events

ActiveChanged ActiveChanged ActiveChanged ActiveChanged ActiveChanged

Subscribes to the ActiveChanged event.

AvailableChanged AvailableChanged AvailableChanged AvailableChanged AvailableChanged

Subscribes to the AvailableChanged event.

CameraIntrinsicsChanged CameraIntrinsicsChanged CameraIntrinsicsChanged CameraIntrinsicsChanged CameraIntrinsicsChanged

Subscribes to the CameraIntrinsicsChanged event.

PropertiesChanged PropertiesChanged PropertiesChanged PropertiesChanged PropertiesChanged

Subscribes to the PropertiesChanged event.

VideoProfileChanged VideoProfileChanged VideoProfileChanged VideoProfileChanged VideoProfileChanged

Subscribes to the VideoProfileChanged event.