PerceptionDepthFrameSource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A frame source that provides depth frames.
public ref class PerceptionDepthFrameSource 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)]
class PerceptionDepthFrameSource final/// [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("PerceptionDepthFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Frames.MediaFrameSource instead.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
class PerceptionDepthFrameSource 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)]
public sealed class PerceptionDepthFrameSource[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("PerceptionDepthFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Frames.MediaFrameSource instead.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
public sealed class PerceptionDepthFrameSourcePublic NotInheritable Class PerceptionDepthFrameSource- Inheritance
- Attributes
Windows requirements
| Device family |
Windows 10 (introduced in 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
Remarks
Version history
| Windows version | SDK version | Value added |
|---|---|---|
| 1511 | 10586 | DeviceId |
Properties
| Active |
Gets a boolean value indicating whether or not the source is active. |
| Available |
Gets a boolean value indicating whether or not the source is available. |
| AvailableVideoProfiles |
Gets a read-only collection of video profiles that are currently available from the depth frame source. |
| CameraIntrinsics |
Gets a CameraIntrinsics value specifying the intrinsic properties of the depth frame source camera device. |
| DeviceId |
Gets a string value that identifies the device on the system. |
| DeviceKind |
Gets a string value indicating the kind of physical device that generates the depth frames. |
| DisplayName |
Gets a string value indicating the display name of the depth frame source. |
| Id |
Gets a string value indicating the unique ID of the depth frame source. |
| IsControlled |
Gets a boolean value indicating whether or not the source is the subject of controller mode. |
| Properties |
Gets a read-only collection of frame source properties. |
| SupportedVideoProfiles |
Gets a read-only collection of video profiles that are supported by the depth frame source. |
| VideoProfile |
Gets a PerceptionVideoProfile object indicating the current video profile. |
Methods
| AcquireControlSession() |
Attempts to acquire Controller Mode on the depth frame source. |
| 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() |
Creates a new depth frame source watcher. |
| FindAllAsync() |
Finds all depth frame sources. |
| FromIdAsync(String) |
Finds an depth frame source by looking up its unique ID. |
| 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() |
Gets a frame reader that reads frames from this depth frame source. |
| RequestAccessAsync() |
Requests access to use depth frame sources. |
| TryGetDepthCorrelatedCameraIntrinsicsAsync(PerceptionDepthFrameSource) |
Attempts to get the intrinsic properties of the depth camera that is correlated with this depth source. |
| TryGetDepthCorrelatedCoordinateMapperAsync(String, PerceptionDepthFrameSource) |
Attempts to get a coordinate mapper that maps from depth frame image space to depth frame space. |
| 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) |
Attempts to set a video profile on this depth frame source. Requires an active Controller Mode control session on this frame source. |
Events
| ActiveChanged |
Subscribes to the ActiveChanged event. |
| AvailableChanged |
Subscribes to the AvailableChanged event. |
| CameraIntrinsicsChanged |
Subscribes to the CameraIntrinsicsChanged event. |
| PropertiesChanged |
Subscribes to the PropertiesChanged event. |
| VideoProfileChanged |
Subscribes to the VideoProfileChanged event. |