PerceptionFrameProviderInfo 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 specific set of properties describing a unique IPerceptionFrameProvider.
public ref class PerceptionFrameProviderInfo sealed
/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [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 PerceptionFrameProviderInfo 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.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class PerceptionFrameProviderInfo 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.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Deprecated("PerceptionFrameProviderInfo may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
class PerceptionFrameProviderInfo final
[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[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 PerceptionFrameProviderInfo
[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.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class PerceptionFrameProviderInfo
[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.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Deprecated("PerceptionFrameProviderInfo may be unavailable after Windows Creator Update. Please refer to AVStream on MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 262144, "Windows.Foundation.UniversalApiContract")]
public sealed class PerceptionFrameProviderInfo
function PerceptionFrameProviderInfo()
Public NotInheritable Class PerceptionFrameProviderInfo
- Inheritance
- Attributes
Windows requirements
Device family |
Windows 10 (introduced in 10.0.10240.0)
|
API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
Remarks
The properties are:
Id - A unique identifier of the IPerceptionFrameProvider, for example, a GUID or "com.contoso.depthcamera.x500.serialNumber1234".
- This id must be persistent across reboots.
- This id must be different between devices for a single manufacturer.
- This id must be approximately globally unique such that there are no conflicts on any one host.
DisplayName - A friendly name for the provider, for example, "Contoso Depth Camera x500".
DeviceKind - A descriptor of the kind of FrameProvider categorically, for example, "com.contoso.depthcamera.x500".
FrameKind - The type of frames the device creates. This must be one of:
- KnownPerceptionFrameKind::Color
- KnownPerceptionFrameKind::Depth
- KnownPerceptionFrameKind::Infrared
Hidden - Whether or not the device enumerates via FindAllAsync or device added events on source watchers. If false, the device is accessible only via FromIdAsync. If false, and the device is registered in a FaceAuthenticationGroup, the device is still enumerated as a Face Authentication source.
Constructors
PerceptionFrameProviderInfo() |
Initializes a new PerceptionFrameProviderInfo instance. |
Properties
DeviceKind |
Gets or sets the descriptor of the kind of FrameProvider categorically, for example, "com.contoso.depthcamera.x500". |
DisplayName |
Gets or sets the friendly name for the device, for example, "Contoso Depth Camera x500". |
FrameKind |
Gets or sets the type of frames the device creates. |
Hidden |
Gets or sets a value indicating whether the device enumerates via FindAllAsync or device-added events on source watchers. |
Id |
Gets or sets the unique identifier of the IPerceptionFrameProvider. |