Header

fpstypes.h File Reference


Detailed Description

Fingerprint Scanner Api module constants

The Fingerprint Scanner is a software product by ADAPTIVE RECOGNITION, which is for capturing and handling live fingerprints from ten fingers and it bases on the GX system. The fpstypes.h contains the descriptions of constants of the api module.

Go to the source code of this file.

Enumerations

enum  FPS_USAGEMODE {
  FPS_UMODE_DISCONNECT = 0,
  FPS_UMODE_NORMAL_USE = 1,
  FPS_UMODE_FULL_CONTROL = 2
}
 Device connection modes in the fpsapi. More...
enum  FPS_FREERUNMODE {
  FPS_FRMODE_NULL = 0x0000,
  FPS_FRMODE_PREVIEWLIGHT = 0x0001,
  FPS_FRMODE_TESTPRESENCE = 0x0004,
  FPS_FRMODE_HQPREVIEW = 0x0010,
  FPS_FRMODE_ROLLPREVIEW = 0x0020
}
 Device freerun light controlling modes. More...
enum  FPS_TESTPRESENCE {
  FPS_TP_ABSENT = 0,
  FPS_TP_DEFAULT = 2,
  FPS_TP_DIRTY = 3,
  FPS_TP_PRESENT = 4
}
 Result of the finger presence detection module. More...
enum  FPS_IMAGE_TYPE {
  FPS_IT_PREVIEW = 2,
  FPS_IT_FINGER = 3
}
 Image types of the fpsapi functions (get-, save-, drawimage). More...
enum  FPS_EVENT {
  FPS_ET_CAPTURE = 2,
  FPS_ET_IO = 4,
  FPS_EV_CAPTUREFINISHED = 101,
  FPS_EV_IMAGECAPTURED = 102,
  FPS_EV_FGCAP = 106,
  FPS_EV_PREVIEWCAPTURED = 107,
  FPS_EV_FINGERDETECTION = 201,
  FPS_EV_BUTTON = 202,
  FPS_EV_POWER = 203,
  FPS_EV_CONNECTION = 204
}
 The event types and the events of the fpsapi module. More...
enum  FPS_POWER_STATE {
  FPS_PWR_MASK = 0x000f,
  FPS_PWR_UNKNOWN = 0x0000,
  FPS_PWR_OFF = 0x0001,
  FPS_PWR_ON = 0x0002,
  FPS_BATTERY_MASK = 0x00f0,
  FPS_BATTERY_UNAVAILABLE = 0x0000,
  FPS_BATTERY_AVAILABLE = 0x0010,
  FPS_BATTERY_UNKNOWN = 0x0020
}
 Power state codes of devices. More...
enum  FPS_STATUS_LED_COLOR {
  FPS_SLC_OFF = 0x00,
  FPS_SLC_GREEN = 0x81,
  FPS_SLC_RED = 0x82,
  FPS_SLC_ORANGE = 0x83,
  FPS_SLC_BLUE = 0x84,
  FPS_SLC_AUTO = 0xac,
  FPS_SLC_ANY = 0xff
}
 Status led color codes of FPS devices. More...
enum  FPS_BUZZER { FPS_SLC_BUZZER = 0xc0 }
 Id of the buzzer. More...
enum  FPS_KEY_STATE {
  FPS_KEY_UNKNOWN = 0,
  FPS_KEY_PRESSED = 1,
  FPS_KEY_RELEASED = 2,
  FPS_KEY_NOKEY = 3
}
 Button state codes of FPS devices. More...
enum  FPS_KEY_CODE {
  FPS_KEY_POWER = 0x10101,
  FPS_KEY_START = 0x10110
}
 Button codes of FPS devices. More...
enum  FPS_VAR_ID {
  FPSV_ROOT = 0,
  FPSV_PAGELIST = FPSV_ROOT | 1,
  FPSV_CONFIDENCE = 0xD0000005,
  FPSV_IMAGE = 0xD0100000,
  FPSV_IMAGELIST = FPSV_IMAGE | 1,
  FPSV_IMAGEFRAME = FPSV_IMAGE | 2,
  FPSV_DEVICE_INFO = 0xD0200000,
  FPSV_DEVICE_ID = FPSV_DEVICE_INFO | 1,
  FPSV_CAPTIME = FPSV_DEVICE_INFO | 3,
  FPSV_COMMON = 0xD0700000,
  FPSV_PROCTIME = FPSV_COMMON | 1,
  FPSV_PROCPERIOD = FPSV_COMMON | 2,
  FPSV_WARNLIST = FPSV_COMMON | 3,
  FPSV_TASK = FPSV_COMMON | 4,
  FPSV_FINGER = 0xD0800000,
  FPSV_FINGER_TYPE = FPSV_FINGER | 1,
  FPSV_NIST_QUALITY = FPSV_FINGER | 2,
  FPSV_DRYWET = FPSV_FINGER | 3,
  FPSV_FRACTION = FPSV_FINGER | 4
}
 Variant IDs used. More...
enum  FPS_POSITION {
  FPS_POS_UNKNOWN = 0,
  FPS_POS_RIGHT_THUMB = 1,
  FPS_POS_RIGHT_INDEX = 2,
  FPS_POS_RIGHT_MIDDLE = 3,
  FPS_POS_RIGHT_RING = 4,
  FPS_POS_RIGHT_LITTLE = 5,
  FPS_POS_LEFT_THUMB = 6,
  FPS_POS_LEFT_INDEX = 7,
  FPS_POS_LEFT_MIDDLE = 8,
  FPS_POS_LEFT_RING = 9,
  FPS_POS_LEFT_LITTLE = 10,
  FPS_POS_PLAIN_RIGHT_THUMB = 11,
  FPS_POS_PLAIN_LEFT_THUMB = 12,
  FPS_POS_PLAIN_RIGHT_4FINGERS = 13,
  FPS_POS_PLAIN_LEFT_4FINGERS = 14,
  FPS_POS_PLAIN_THUMBS = 15,
  FPS_POS_BOTH_INDEXES = 46
}
 Finger storage IDs. More...
enum  FPS_SCAN_OBJECT {
  FPS_SCAN_LEFT_HAND = 1,
  FPS_SCAN_RIGHT_HAND = 2,
  FPS_SCAN_SAME_FINGER = 3
}
 The target object of fingerprint scanning. More...
enum  FPS_IMPRESSION_TYPE {
  FPS_SCAN_LIVE = 0,
  FPS_SCAN_ROLLED = 1,
  FPS_SCAN_ACCUMULATED = 0x1000
}
 The capturing mode of the finger capture process. More...
enum  FPS_PRESENCE {
  FPS_NO_INFO = 0,
  FPS_AMPUTATION = 1,
  FPS_NO_PRINT = 2,
  FPS_AVAILABLE = 3
}
 Finger existence IDs. More...
enum  FPS_FAILURE {
  FPS_FAIL_LEFT = 1,
  FPS_FAIL_RIGHT = 2,
  FPS_FAIL_TOP = 4,
  FPS_FAIL_BOTTOM = 8,
  FPS_FAIL_MISSING = 0x10,
  FPS_FAIL_EXTRA = 0x20,
  FPS_FAIL_HAND = 0x40,
  FPS_FAIL_UPRIGHT = 0x80
}
 Warnings about finger capture. More...


Enumeration Type Documentation

Device connection modes in the fpsapi.

Enumerator:
FPS_UMODE_DISCONNECT  Disconnect the actually used device.
FPS_UMODE_NORMAL_USE  Connect the device with restricted abilities.
FPS_UMODE_FULL_CONTROL  Connect the device with all the abilities.

Device freerun light controlling modes.

Not all of the modes can be used at the same time. The system can override the control settings.

Enumerator:
FPS_FRMODE_NULL  Disable freerun activity.
FPS_FRMODE_PREVIEWLIGHT  Direct controlled lights for real-time preview image capturing.
FPS_FRMODE_TESTPRESENCE  Lights controlled by the finger presence detection algorithm.
FPS_FRMODE_HQPREVIEW  High quality preview.
FPS_FRMODE_ROLLPREVIEW  Roll mode preview.

Result of the finger presence detection module.

Enumerator:
FPS_TP_ABSENT  Fingers are out of the scan area.
FPS_TP_DEFAULT  The test is starting.
FPS_TP_DIRTY  Platen needs cleaning.
FPS_TP_PRESENT  Fingers are on the scan area.

Image types of the fpsapi functions (get-, save-, drawimage).

Enumerator:
FPS_IT_PREVIEW  Low resolution real-time captured image.
FPS_IT_FINGER  Captured finger image.

enum FPS_EVENT

The event types and the events of the fpsapi module.

Enumerator:
FPS_ET_CAPTURE  Capture events.
FPS_ET_IO  Input events.
FPS_EV_CAPTUREFINISHED  Capture process finished (Capture event).
FPS_EV_IMAGECAPTURED  Image captured (Capture event).
FPS_EV_FGCAP  Fingers captured (Capture event).
FPS_EV_PREVIEWCAPTURED  Preview captured (Capture event).
FPS_EV_FINGERDETECTION  Finger detection state changed (Input event).
FPS_EV_BUTTON  Button state changed (Input event).
FPS_EV_POWER  Power state or battery level changed (Input event).
FPS_EV_CONNECTION  Device list changes (Input event), occures when no device is used and a new device is connected or the used device is disconnected.

Power state codes of devices.

Enumerator:
FPS_PWR_MASK  Mask for power data.
FPS_PWR_UNKNOWN  The power state is unknown (cannot be tested).
FPS_PWR_OFF  The power is off.
FPS_PWR_ON  The power is on.
FPS_BATTERY_MASK  Mask for battery data.
FPS_BATTERY_UNAVAILABLE  The battery is unavailbe.
FPS_BATTERY_AVAILABLE  The battery is availbe.
FPS_BATTERY_UNKNOWN  The state of the battery is unavailbe.

Status led color codes of FPS devices.

Enumerator:
FPS_SLC_OFF  The led is off.
FPS_SLC_GREEN  The color of the led is green.
FPS_SLC_RED  The color of the led is red.
FPS_SLC_ORANGE  The color of the led is orange.
FPS_SLC_BLUE  The color of the led is blue.
FPS_SLC_AUTO  Automatic control.
FPS_SLC_ANY  The color of the led is one of the available lights.

enum FPS_BUZZER

Id of the buzzer.

Enumerator:
FPS_SLC_BUZZER  Buzzer.

Button state codes of FPS devices.

Enumerator:
FPS_KEY_UNKNOWN  The state or presence of the button is unknown (cannot be tested).
FPS_KEY_PRESSED  The state of the button is pressed.
FPS_KEY_RELEASED  The state of the button is released.
FPS_KEY_NOKEY  The button does not exist on the device.

Button codes of FPS devices.

Enumerator:
FPS_KEY_POWER  Code of the power button.
FPS_KEY_START  Code of the start button.

enum FPS_VAR_ID

Variant IDs used.

Enumerator:
FPSV_ROOT  The root of the document structure.
FPSV_PAGELIST  Reserved for internal use.
FPSV_CONFIDENCE  Confidence value.
FPSV_IMAGE  Image.
FPSV_IMAGELIST  List of images.
FPSV_IMAGEFRAME  Frame by image coordinates (1/16 pixel).
FPSV_DEVICE_INFO  The root of the device info structure.
FPSV_DEVICE_ID  Device id string.
FPSV_CAPTIME  Date and time of capture.
FPSV_COMMON  RFU.
FPSV_PROCTIME  Date and time of process execution.
FPSV_PROCPERIOD  Duration of process execution.
FPSV_WARNLIST  List of warning messages.
FPSV_TASK  Call code of a GX task.
FPSV_FINGER  Finger position, see FPS_POSITION.
FPSV_FINGER_TYPE  Finger impression type, see FPS_IMPRESSION_TYPE.
FPSV_NIST_QUALITY  NIST image quality value.
FPSV_DRYWET  Finger dry/wet level.
FPSV_FRACTION  Finger fraction level.

Finger storage IDs.

Enumerator:
FPS_POS_UNKNOWN  Unknown finger.
FPS_POS_RIGHT_THUMB  Right thumb.
FPS_POS_RIGHT_INDEX  Right index finger.
FPS_POS_RIGHT_MIDDLE  Right middle finger.
FPS_POS_RIGHT_RING  Right ring finger.
FPS_POS_RIGHT_LITTLE  Right little finger.
FPS_POS_LEFT_THUMB  Left thumb.
FPS_POS_LEFT_INDEX  Left index finger.
FPS_POS_LEFT_MIDDLE  Left middle finger.
FPS_POS_LEFT_RING  Left ring finger.
FPS_POS_LEFT_LITTLE  Left little finger.
FPS_POS_PLAIN_RIGHT_THUMB  Plain right thumb.
FPS_POS_PLAIN_LEFT_THUMB  Plain left thumb.
FPS_POS_PLAIN_RIGHT_4FINGERS  Plain right four fingers.
FPS_POS_PLAIN_LEFT_4FINGERS  Plain left four fingers.
FPS_POS_PLAIN_THUMBS  Plain two thumbs together.
FPS_POS_BOTH_INDEXES  Plain two index fingers together.

The target object of fingerprint scanning.

Enumerator:
FPS_SCAN_LEFT_HAND  Scan left hand fingers.
FPS_SCAN_RIGHT_HAND  Scan right hand fingers.
FPS_SCAN_SAME_FINGER  Scan same fingers of both hands.

The capturing mode of the finger capture process.

Enumerator:
FPS_SCAN_LIVE  Live scan plain.
FPS_SCAN_ROLLED  Live scan rolled.
FPS_SCAN_ACCUMULATED  Accumulated live scan.

Finger existence IDs.

Enumerator:
FPS_NO_INFO  No Information about missing finger.
FPS_AMPUTATION  Amputation.
FPS_NO_PRINT  Unable to scan.
FPS_AVAILABLE  Finger is available.

Warnings about finger capture.

Enumerator:
FPS_FAIL_LEFT  Fingers hang out at the left side of the window.
FPS_FAIL_RIGHT  Fingers hang out at the right side of the window.
FPS_FAIL_TOP  Fingers hang out at the top of the window.
FPS_FAIL_BOTTOM  Fingers hang out at the bottom of the window.
FPS_FAIL_MISSING  Some fingers missing.
FPS_FAIL_EXTRA  Some additional fingers found.
FPS_FAIL_HAND  Mismatched hand found.
FPS_FAIL_UPRIGHT  The fingers don't stand in upright position.


Generated  for Fingerprint Scanner
(c) ADAPTIVE RECOGNITION