WINBIO_SENSOR_INTERFACE structure

The WINBIO_SENSOR_INTERFACE structure contains pointers to your custom sensor adapter functions. The Windows Biometric Framework uses this structure to locate the functions.

Syntax


typedef struct _WINBIO_SENSOR_INTERFACE {
  WINBIO_ADAPTER_INTERFACE_VERSION          Version;
  WINBIO_ADAPTER_TYPE                       Type;
  SIZE_T                                    Size;
  GUID                                      AdapterId;
  PIBIO_SENSOR_ATTACH_FN                    Attach;
  PIBIO_SENSOR_DETACH_FN                    Detach;
  PIBIO_SENSOR_CLEAR_CONTEXT_FN             ClearContext;
  PIBIO_SENSOR_QUERY_STATUS_FN              QueryStatus;
  PIBIO_SENSOR_RESET_FN                     Reset;
  PIBIO_SENSOR_SET_MODE_FN                  SetMode;
  PIBIO_SENSOR_SET_INDICATOR_STATUS_FN      SetIndicatorStatus;
  PIBIO_SENSOR_GET_INDICATOR_STATUS_FN      GetIndicatorStatus;
  PIBIO_SENSOR_START_CAPTURE_FN             StartCapture;
  PIBIO_SENSOR_FINISH_CAPTURE_FN            FinishCapture;
  PIBIO_SENSOR_EXPORT_SENSOR_DATA_FN        ExportSensorData;
  PIBIO_SENSOR_CANCEL_FN                    Cancel;
  PIBIO_SENSOR_PUSH_DATA_TO_ENGINE_FN       PushDataToEngine;
  PIBIO_SENSOR_CONTROL_UNIT_FN              ControlUnit;
  PIBIO_SENSOR_CONTROL_UNIT_PRIVILEGED_FN   ControlUnitPrivileged;
#ifdef WINBIO_SENSOR_INTERFACE_VERSION_2
  PIBIO_STORAGE_NOTIFY_POWER_CHANGE_FN      NotifyPowerChange;
#endif 
#ifdef WINBIO_SENSOR_INTERFACE_VERSION_3
  PIBIO_SENSOR_PIPELINE_INIT_FN             PipelineInit;
  PIBIO_SENSOR_PIPELINE_CLEANUP_FN          PipelineCleanup;
  PIBIO_SENSOR_ACTIVATE_FN                  Activate;
  PIBIO_SENSOR_DEACTIVATE_FN                Deactivate;
  PIBIO_SENSOR_QUERY_EXTENDED_INFO_FN       QueryExtendedInfo;
  PIBIO_SENSOR_QUERY_CALIBRATION_FORMATS_FN QueryCalibrationFormats;
  PIBIO_SENSOR_SET_CALIBRATION_FORMAT_FN    SetCalibrationFormat;
  PIBIO_SENSOR_ACCEPT_CALIBRATION_DATA_FN   AcceptCalibrationData;
#endif 
} WINBIO_SENSOR_INTERFACE, *PWINBIO_SENSOR_INTERFACE;

Members

Version

Version number of this structure.

Windows 10:  The version number must be WINBIO_SENSOR_INTERFACE_VERSION_3.

Windows Server 2012 R2, Windows 8.1, Windows Server 2012 and Windows 8:  The version number must be WINBIO_SENSOR_INTERFACE_VERSION_2.

Windows Server 2008 R2 and Windows 7:  The version number must be WINBIO_SENSOR_INTERFACE_VERSION_1.

Type

The type of adapter. This must be WINBIO_ADAPTER_TYPE_SENSOR.

Size

The size, in bytes, of this structure. Set this value to the size of the WINBIO_SENSOR_INTERFACE structure.

AdapterId

A GUID that uniquely identifies the sensor adapter. You must generate this value.

Attach

A pointer to your implementation of the SensorAdapterAttach function.

Detach

A pointer to your implementation of the SensorAdapterDetach function.

ClearContext

A pointer to your implementation of the SensorAdapterClearContext function.

QueryStatus

A pointer to your implementation of the SensorAdapterQueryStatus function.

Reset

A pointer to your implementation of the SensorAdapterReset function.

SetMode

A pointer to your implementation of the SensorAdapterSetMode function.

SetIndicatorStatus

A pointer to your implementation of the SensorAdapterSetIndicatorStatus function.

GetIndicatorStatus

A pointer to your implementation of the SensorAdapterGetIndicatorStatus function.

StartCapture

A pointer to your implementation of the SensorAdapterStartCapture function.

FinishCapture

A pointer to your implementation of the SensorAdapterFinishCapture function.

ExportSensorData

A pointer to your implementation of the SensorAdapterExportSensorData function.

Cancel

A pointer to your implementation of the SensorAdapterCancel function.

PushDataToEngine

A pointer to your implementation of the SensorAdapterPushDataToEngine function.

ControlUnit

A pointer to your implementation of the SensorAdapterControlUnit function.

ControlUnitPrivileged

A pointer to your implementation of the SensorAdapterControlUnitPrivileged function.

NotifyPowerChange

A pointer to your implementation of the SensorAdapterNotifyPowerChange function. This member is supported starting in Windows 8.

PipelineInit

A pointer to your implementation of the SensorAdapterPipelineInit function. This member is supported starting in Windows 10.

PipelineCleanup

A pointer to your implementation of the SensorAdapterPipelineCleanup function. This member is supported starting in Windows 10.

Activate

A pointer to your implementation of the SensorAdapterActivate function. This member is supported starting in Windows 10.

Deactivate

A pointer to your implementation of the SensorAdapterDeactivate function. This member is supported starting in Windows 10.

QueryExtendedInfo

A pointer to your implementation of the SensorAdapterQueryExtendedInfo function. This member is supported starting in Windows 10.

QueryCalibrationFormats

A pointer to your implementation of the SensorAdapterQueryCalibrationFormats function. This member is supported starting in Windows 10.

SetCalibrationFormat

A pointer to your implementation of the SensorAdapterSetCalibrationFormat function. This member is supported starting in Windows 10.

AcceptCalibrationData

A pointer to your implementation of the SensorAdapterAcceptCalibrationData function. This member is supported starting in Windows 10.

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Winbio_adapter.h

See also

Plug-in Functions
Plug-in Structures
WbioQuerySensorInterface

 

 

Show: