KSPROPERTY_CAMERACONTROL_EXTENDED_FACEAUTH_MODE
KSPROPERTY_CAMERACONTROL_EXTENDED_FACEAUTH_MODE is a property ID that is used to turn on and off face authentication.
Usage Summary Table
Scope | Control | Type |
---|---|---|
Version 1 |
Pin |
Synchronous |
The following bit flags control face authentication in the driver:
#define KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_DISABLED 0x0000000000000001
#define KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_ALTERNATIVE_FRAME_ILLUMINATION 0x0000000000000002
#define KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_BACKGROUND_SUBTRACTION 0x0000000000000004
The following table describes the flag capabilities:
Flag | Description |
---|---|
KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_DISABLED |
Optional capability. When specified, the video Face authentication mode is disabled in the driver. This flag is mutually exclusive with the KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_BACKGROUND_SUBTRACTION and KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_ALTERNATIVE_FRAME_ILLUMINATION flags. |
KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_ALTERNATIVE_FRAME_ILLUMINATION |
Mandatory capability if KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_BACKGROUND_SUBTRACTION is not supported. When specified, it is mandatory to set KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_ALTERNATIVE_FRAME_ILLUMINATION on each sample as described by the frame metadata. This flag is mutually exclusive with the KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_BACKGROUND_SUBTRACTION and KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_DISABLED flags. In this mode it is expected to alternate IR strobe on/off for each frame captured. |
KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_BACKGROUND_SUBTRACTION |
Mandatory capability if KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_ALTERNATIVE_FRAME_ILLUMINATION is not supported. This flag is mutually exclusive with the KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_ALTERNATIVE_FRAME_ILLUMINATION and KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_DISABLED flags. In this mode it is expected to create an IR image with background ambient IR light subtracted. |
By default, the driver should have KSPROPERTY_CAMERACONTROL_EXTENDED_FACEAUTH_MODE set to KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_DISABLED if it is a general purpose IR camera. Otherwise it should be set to KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_BACKGROUND_SUBTRACTION or KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_ALTERNATIVE_FRAME_ILLUMINATION.
IR cameras should advertise KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_DISABLED if they are expected to work for general scenarios besides Windows Hello.
IR cameras used for face login should support either KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_ALTERNATIVE_FRAME_ILLUMINATION or KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_BACKGROUND_SUBTRACTION capability they should only support one of these flags not both.
The following table contains the descriptions and requirements for the KSCAMERA_EXTENDEDPROP_HEADER structure fields when using the control.
Member | Description |
---|---|
Version |
This must be 1. |
PinId |
Must be advertised on only one pin on the filter. The pin must be type PINNAME_VIDEO_CAPTURE or PINNAME_VIDEO_PREVIEW, must produce IR sensor data, and be marked shareable for FrameServer. |
Size |
This must be sizeof(KSCAMERA_EXTENDEDPROP_HEADER) + sizeof(KSCAMERA_EXTENDEDPROP_VIDEOPROCSETTING). |
Result |
Indicates the error results of the last SET operation. If no SET operation has taken place, this must be 0. |
Capability |
Must be a bit wise OR of the supported KSCAMERA_EXTENDEDPROP_ FACEAUTH_MODE_xxx flags as defined above. The driver should not advertise both KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_ALTERNATIVE_FRAME_ILLUMINATION and KSCAMERA_EXTENDEDPROP_FACEAUTH_MODE_BACKGROUND_SUBTRACTION |
Flags |
This is a read/write field. This can be any one of the KSCAMERA_EXTENDEDPROP_ FACEAUTH_MODE_xxx flags defined above. |
Requirements
Header |
Ksmedia.h |