fpi_image_device_session_error ()

void
fpi_image_device_session_error (FpImageDevice *self,
                                GError *error);

Report an error while interacting with the device. This effectively aborts the current ongoing action. Note that doing so will result in the deactivation handler to be called and this function must not be used to report an error during deactivation.

fpi_image_device_open_complete ()

void
fpi_image_device_open_complete (FpImageDevice *self,
                                GError *error);

Reports completion of open operation.

fpi_image_device_close_complete ()

void
fpi_image_device_close_complete (FpImageDevice *self,
                                 GError *error);

Reports completion of close operation.

fpi_image_device_activate_complete ()

void
fpi_image_device_activate_complete (FpImageDevice *self,
                                    GError *error);

Reports completion of device activation.

fpi_image_device_deactivate_complete ()

void
fpi_image_device_deactivate_complete (FpImageDevice *self,
                                      GError *error);

Reports completion of device deactivation.

fpi_image_device_report_finger_status ()

void
fpi_image_device_report_finger_status (FpImageDevice *self,
                                       gboolean present);

Reports from the driver whether the user's finger is on the sensor.

fpi_image_device_image_captured ()

void
fpi_image_device_image_captured (FpImageDevice *self,
                                 FpImage *image);

Reports an image capture. Only use this function if the image was captured successfully. If there was an issue where the user should retry, use fpi_image_device_retry_scan() to report the retry condition.

In the event of a fatal error for the operation use fpi_image_device_session_error(). This will abort the entire operation including e.g. an enroll operation which captures multiple images during one session.

fpi_image_device_retry_scan ()

void
fpi_image_device_retry_scan (FpImageDevice *self,
                             FpDeviceRetry retry);

Reports a scan failure to the user. This may or may not abort the current session. It is the equivalent of fpi_image_device_image_captured() in the case of a retryable error condition (e.g. short swipe).

fpi_image_device_set_bz3_threshold ()

void
fpi_image_device_set_bz3_threshold (FpImageDevice *self,
                                    gint bz3_threshold);

Dynamically adjust the bz3 threshold. This is only needed for drivers that support devices with different properties. It should generally be called from the probe callback, but is acceptable to call from the open callback.

enum FpiImageDeviceState

The state of an imaging device while doing a capture. The state is passed through to the driver using the ::activate() or ::change_state() vfuncs.

The driver needs to call fpi_image_device_report_finger_status() to move between the different states. Note that the capture state might be entered unconditionally if the device supports raw capturing.

A usual run would look like:

Raw mode is currently not supported (not waiting for finger), but in that case the following transitions are valid:

Also valid are these transitions in case of errors or cancellations:

FpImageDeviceClass

typedef struct {
  FpDeviceClass parent_class;

  gint          bz3_threshold;
  gint          img_width;
  gint          img_height;

  void          (*img_open)     (FpImageDevice *dev);
  void          (*img_close)    (FpImageDevice *dev);
  void          (*activate)     (FpImageDevice *dev);
  void          (*change_state) (FpImageDevice      *dev,
                                 FpiImageDeviceState state);
  void          (*deactivate)   (FpImageDevice *dev);
} FpImageDeviceClass;

These are the main entry points for drivers to implement. Drivers may not implement all of these entry points if they do not support the operation (or a default implementation is sufficient).

Drivers *must* eventually call the corresponding function to finish the operation. It is also acceptable to call the generic fpi_device_action_error() function but doing so is not recommended in most usecases.

Image drivers must expect a deactivate call to happen at any point during image capture.

This API is solely intended for drivers. It is purely internal and neither API nor ABI stable.