Package: android.hardware.biometrics.fingerprint@2.1

types

Properties

FingerprintEnumerated

typedef FingerprintIterator FingerprintEnumerated

FingerprintRemoved

typedef FingerprintIterator FingerprintRemoved

RequestStatus

enum RequestStatus: int32_t

Request status indicates whether the request is accepted by the vendor implementation or not.These values are taken from the errno set, except for the SYS_UNKNOWN

Details
Members
SYS_UNKNOWN = 1
SYS_OK = 0
SYS_ENOENT = -2
SYS_EINTR = -4
SYS_EIO = -5
SYS_EAGAIN = -11
SYS_ENOMEM = -12
SYS_EACCES = -13
SYS_EFAULT = -14
SYS_EBUSY = -16
SYS_EINVAL = -22
SYS_ENOSPC = -28
SYS_ETIMEDOUT = -110

FingerprintError

enum FingerprintError: int32_t

Fingerprint errors are meant to tell the framework to terminate the current operation and ask for the user to correct the situation.These will almost always result in messaging and user interaction to correct the problem.

For example, ERROR_CANCELED should follow any acquisition message that results in a situation where the current operation can't continue without user interaction.For example, if the sensor is dirty during enrollment and no further enrollment progress can be made, send ACQUIRED_IMAGER_DIRTY followed by ERROR_CANCELED.

Details
Members
ERROR_NO_ERROR = 0
Used for testing, no error returned
ERROR_HW_UNAVAILABLE = 1
The hardware has an error that can't be resolved.
ERROR_UNABLE_TO_PROCESS = 2
Bad data;operation can't continue
ERROR_TIMEOUT = 3
The operation has timed out waiting for user input.
ERROR_NO_SPACE = 4
No space available to store a template
ERROR_CANCELED = 5
The current operation has been canceled
ERROR_UNABLE_TO_REMOVE = 6
Unable to remove a template
ERROR_LOCKOUT = 7
The hardware is in lockout due to too many attempts
ERROR_VENDOR = 8
Vendor-specific error message

FingerprintAcquiredInfo

enum FingerprintAcquiredInfo: int32_t

Fingerprint acquisition info is meant as feedback for the current operation.Anything but ACQUIRED_GOOD must be shown to the user as feedback on how to take action on the current operation.For example, ACQUIRED_IMAGER_DIRTY may be used to tell the user to clean the sensor if it is detected to be dirty.If this causes the current operation to fail, an additional ERROR_CANCELED must be sent to stop the operation in progress(e.g.enrollment). In general, these messages will result in a "Try again" message.

Details
Members
ACQUIRED_GOOD = 0
ACQUIRED_PARTIAL = 1
sensor needs more data, i.e.longer swipe.
ACQUIRED_INSUFFICIENT = 2
image doesn't contain enough detail for recognition
ACQUIRED_IMAGER_DIRTY = 3
sensor needs to be cleaned
ACQUIRED_TOO_SLOW = 4
mostly swipe-type sensors;not enough data collected
ACQUIRED_TOO_FAST = 5
vendor-specific acquisition messages start here
ACQUIRED_VENDOR = 6
vendor-specific acquisition messages

FingerprintMsgType

enum FingerprintMsgType: int32_t

Run time type identification for the notify() call payload.

Details
Members
ERROR = -1
ACQUIRED = 1
TEMPLATE_ENROLLING = 3
TEMPLATE_REMOVED = 4
AUTHENTICATED = 5
TEMPLATE_ENUMERATING = 6

FingerprintFingerId

struct FingerprintFingerId {uint32_t gid; uint32_t fid}
Details
Members
gid
Group ID
fid
Fingerprint template ID

FingerprintEnroll

struct FingerprintEnroll {FingerprintFingerId finger; uint32_t samplesRemaining; uint64_t msg}
Details
Members
finger
Template ID
samplesRemaining
samplesRemaining goes from N(no data collected, but N scans needed)to 0(no more data is needed to build a template).
msg
Vendor specific message.Used for user guidance

FingerprintIterator

struct FingerprintIterator {FingerprintFingerId finger; uint32_t remainingTemplates}
Details
Members
finger
Template ID
remainingTemplates
How many templates remain to iterate through

FingerprintAcquired

struct FingerprintAcquired {FingerprintAcquiredInfo acquiredInfo}
Details
Members
acquiredInfo
information about the image

FingerprintAuthenticated

struct FingerprintAuthenticated {FingerprintFingerId finger; uint8_t hat}
Details
Members
finger
Matched template ID
hat
Authentication result from the keymaster