Engine Adapter Functions
An engine adapter generates biometric templates from captured samples, matches samples to existing templates, and indexes templates. The following functions must be implemented by the adapter developer. They are called by the Windows Biometric service.
In this section
| Topic | Description |
|---|---|
| EngineAdapterCreateKey |
Called by the Windows Biometric Framework to push an HMAC key to the sensor. The returned key identifier will be passed back to the biometric unit when the framework calls EngineAdapterIdentifyFeatureSetSecure. |
| EngineAdapterAcceptSampleData |
Accepts a raw biometric sample and extracts a feature set. |
| EngineAdapterActivate |
Gives the Engine Adapter the chance to perform any work needed to bring the sensor component out of an idle state. |
| EngineAdapterAttach |
Adds an engine adapter to the processing pipeline of the biometric unit. |
| EngineAdapterCheckForDuplicate |
Determines whether a new template in the pipeline duplicates any template already saved in the database regardless of the identity associated with the templates. |
| EngineAdapterClearContext |
Prepares the processing pipeline of the biometric unit for a new operation. |
| EngineAdapterCommitEnrollment |
Finalizes the enrollment object, converts it to a template, and saves the template in the database. |
| EngineAdapterControlUnit |
Performs a vendor-defined control operation that does not require elevated privilege. |
| EngineAdapterControlUnitPrivileged |
Performs a vendor-defined control operation that requires elevated privilege. |
| EngineAdapterCreateEnrollment |
Initializes the enrollment object in the biometric unit pipeline. |
| EngineAdapterDeactivate |
Gives the Engine Adapter the chance to perform any work needed to put the sensor component into an idle state. |
| EngineAdapterDetach |
Releases adapter-specific resources attached to the pipeline. |
| EngineAdapterDiscardEnrollment |
Deletes intermediate enrollment state information from the pipeline. |
| EngineAdapterExportEngineData |
Retrieves a copy of the most recently processed feature set or template from the engine in a standard biometric information record. |
| EngineAdapterGetEnrollmentHash |
Retrieves the hash of the completed enrollment template in the pipeline. |
| EngineAdapterGetEnrollmentStatus |
Determines whether the enrollment object is ready to be committed to the pipeline. |
| EngineAdapterIdentifyAll |
Determines the identities of any people who are currently in camera frame. |
| EngineAdapterIdentifyFeatureSet |
Builds a template from the current feature set and locates a matching template in the database. |
| EngineAdapterIdentifyFeatureSetSecure |
Called by the Windows Biometric Framework to build a template from the current feature set and locate a matching template in the database. If a match can be found, the engine adapter must fill the Identity, SubFactor, Authorization, and AuthorizationSize fields. |
| EngineAdapterNotifyPowerChange |
Receives notification about a change in the computer power state and prepares the engine adapter accordingly. |
| EngineAdapterPipelineCleanup |
Gives the Engine Adapter the chance to perform any cleanup that requires help from the Storage Adapter. |
| EngineAdapterPipelineInit |
Gives the Engine Adapter the chance to perform any initialization that remains incomplete. |
| EngineAdapterQueryCalibrationData |
Gets a set of post-capture calibration data from the engine adapter. |
| EngineAdapterQueryExtendedEnrollmentStatus |
Queries the WINBIO_PROPERTY_EXTENDED_ENROLLMENT_STATUS property. |
| EngineAdapterQueryExtendedInfo |
Determines the capabilities and limitations of the biometric engine component. |
| EngineAdapterQueryHashAlgorithms |
Retrieves an array of object identifiers that represent the hash algorithms supported by the engine adapter. |
| EngineAdapterQueryIndexVectorSize |
Retrieves the size of the index vector used by the engine adapter. |
| EngineAdapterQueryPreferredFormat |
Determines the input data format preferred by the engine adapter. |
| EngineAdapterQuerySampleHint |
Retrieves the number of correct samples required by the engine adapter to construct an enrollment template. |
| EngineAdapterRefreshCache |
Notifies the Engine Adapter that it should discard any cached templates that it may be keeping in memory. |
| EngineAdapterSelectCalibrationFormat |
Called by the Windows Biometric Framework to determine which of the Sensor Adapter s calibration formats the Engine Adapter wants to use. |
| EngineAdapterSetAccountPolicy |
Sets the extended default and per-user antispoofing policies used by the engine adapter. |
| EngineAdapterSetEnrollmentParameters |
Gives the engine adapter additional information about an enrollment operation. |
| EngineAdapterSetEnrollmentSelector |
Tells the Engine Adapter which person to track for the current enrollment operation. |
| EngineAdapterSetHashAlgorithm |
Selects a hash algorithm for use in subsequent operations. |
| EngineAdapterUpdateEnrollment |
Adds the current feature set to the enrollment object. |
| EngineAdapterVerifyFeatureSet |
Compares the template in the current feature set with a specific template in the database. |
| WbioQueryEngineInterface |
Retrieves a pointer to the WINBIO_ENGINE_INTERFACE structure for the engine adapter. |