PerceptionInfraredFrameSource 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 infrared frames.
public ref class PerceptionInfraredFrameSource 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 PerceptionInfraredFrameSource 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("PerceptionInfraredFrameSource may be unavailable after Windows Creator Update. Use Windows.Media.Frames.MediaFrameSource instead.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
class PerceptionInfraredFrameSource 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 PerceptionInfraredFrameSource[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("PerceptionInfraredFrameSource 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 PerceptionInfraredFrameSourcePublic NotInheritable Class PerceptionInfraredFrameSource- 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 infrared frame source. |
| CameraIntrinsics |
Gets a CameraIntrinsics value specifying the intrinsic properties of the infrared 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 infrared frames. |
| DisplayName |
Gets a string value indicating the display name of the infrared frame source. |
| Id |
Gets a string value indicating the unique ID of the infrared 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 infrared frame source. |
| VideoProfile |
Gets a PerceptionVideoProfile object indicating the current video profile. |
Methods
| AcquireControlSession() |
Attempts to acquire Controller Mode on the infrared frame source. |
| CanControlIndependentlyFrom(String) |
Retrieves a boolean value indicating whether or not the infrared frame source can be controlled separately from another frame source. |
| CreateWatcher() |
Creates a new infrared frame source watcher. |
| FindAllAsync() |
Finds all infrared frame sources. |
| FromIdAsync(String) |
Finds an infrared frame source by looking up its unique ID. |
| IsCorrelatedWith(String) |
Checks whether or not the infrared frame source is correlated with the target entity. |
| OpenReader() |
Gets a frame reader that reads frames from this infrared frame source. |
| RequestAccessAsync() |
Requests access to use infrared frame sources. |
| TryGetDepthCorrelatedCameraIntrinsicsAsync(PerceptionDepthFrameSource) |
Attempts to get the intrinsic properties of the depth camera that is correlated with this infrared source. |
| TryGetDepthCorrelatedCoordinateMapperAsync(String, PerceptionDepthFrameSource) |
Attempts to get a coordinate mapper that maps from infrared frame image space to depth frame space. |
| TryGetTransformTo(String, Matrix4x4) |
Gets the transform from the infrared 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 infrared 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. |