PerceptionFrameProviderInfo PerceptionFrameProviderInfo PerceptionFrameProviderInfo PerceptionFrameProviderInfo Class

Definition

A specific set of properties describing a unique IPerceptionFrameProvider.

public : sealed class PerceptionFrameProviderInfo : IPerceptionFrameProviderInfopublic sealed class PerceptionFrameProviderInfo : IPerceptionFrameProviderInfoPublic NotInheritable Class PerceptionFrameProviderInfo Implements IPerceptionFrameProviderInfo// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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() PerceptionFrameProviderInfo() PerceptionFrameProviderInfo() PerceptionFrameProviderInfo()

Initializes a new PerceptionFrameProviderInfo instance.

public : PerceptionFrameProviderInfo()public PerceptionFrameProviderInfo()Public Sub New()// You can use this method in JavaScript.

Properties

DeviceKind DeviceKind DeviceKind DeviceKind

Gets or sets the descriptor of the kind of FrameProvider categorically, for example, "com.contoso.depthcamera.x500".

public : PlatForm::String DeviceKind { get; set; }public string DeviceKind { get; set; }Public ReadWrite Property DeviceKind As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The descriptor of the kind of FrameProvider categorically, for example, "com.contoso.depthcamera.x500".

DisplayName DisplayName DisplayName DisplayName

Gets or sets the friendly name for the device, for example, "Contoso Depth Camera x500".

public : PlatForm::String DisplayName { get; set; }public string DisplayName { get; set; }Public ReadWrite Property DisplayName As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The friendly name for the device.

FrameKind FrameKind FrameKind FrameKind

Gets or sets the type of frames the device creates.

public : PlatForm::String FrameKind { get; set; }public string FrameKind { get; set; }Public ReadWrite Property FrameKind As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The type of frames the device creates. Must be one of: IKnownPerceptionFrameKind::Color, IKnownPerceptionFrameKind::Depth, or IKnownPerceptionFrameKind::Infrared.

Hidden Hidden Hidden Hidden

Gets or sets a value indicating whether the device enumerates via FindAllAsync or device-added events on source watchers.

public : PlatForm::Boolean Hidden { get; set; }public bool Hidden { get; set; }Public ReadWrite Property Hidden As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if the device enumerates via FindAllAsync or device added events on source watchers; otherwise, false. If false, the device will only be accessible via FromIdAsync. If false, the device will enumerate as a Face Authentication source, if registered via PerceptionFrameProviderManagerService::RegisterFaceAuthenticationGroup().

Id Id Id Id

Gets or sets the unique identifier of the IPerceptionFrameProvider.

public : PlatForm::String Id { get; set; }public string Id { get; set; }Public ReadWrite Property Id As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The unique identifier of the IPerceptionFrameProvider, for example, a GUID, or "com.contoso.depthcamera.x500.serialNumber1234".