FpsApi

FpsApi


The FPS Api Control is a dedicated ActiveX control for controlling the fingerprint scanner devices.

The FPS Api Control is a control without display window. To visualize the captured images the best way is to connect a GxImage ActiveX control to the FPS Api Control. In this case the FPS Api Control operates as an Image source for the GxImage control.

The available values for the GxImage Controls ImageSrcParam property are the reasonable combination of the folowings:

  • Fingers: Thumb, Index, Middle, Ring, Little
  • Sides: Left, Right
  • Image type: Live, Plain, Slap

    These values can be feed to the GxImage Control in case insensitive and without order restrictions separated by commas. If any of the values are absent the control chooses the best case.

    For the ActiveX component to be capable of handling the calling convention differences introduced by the JavaScript scripting language, the runtime configuration property should be set to 1. It is necessary for example if you want to embed your application in HTML framework viewed in Internet Explorer.

    Class Diagram

    FpsApi

    Public:

    Methods:

    NameDescription
     BlinkStatusBlinks status outputs (led or buzzer).  
     CaptureScan fingers from captured images.  
     CaptureStartStarts the finger image capturing process in asynchronous mode.  
     CaptureStatusReturns the state of an image capture process started with the CaptureStart() method.  
     CaptureStopStops the capture process started with the CaptureStart() or the Capture() method before the timeout is elapsed.  
     CaptureWaitEnds the capture process started with the CaptureStart() method.  
     CloseDeviceCloses a previously opened device.  
     FingerToNistSaves the fingers to an nist file.  
     FingerToNistVSaves the fingers to a memory area as a nist file.  
     GetDeviceReturns the name of a device in the device list.  
     GetDeviceInfoGets the information about the opened device.  
     GetDeviceListCreates a list of the available Fingerprint Scanner devices.  
     GetErrorCodeReturns the error code of the control.  
     GetErrorStringReturns the error string of the control.  
     GetFingerReturns a finger data.  
     GetImageSourceReturns a binary value representing the control's class as an image source.  
     GetPropertyGets the text value of a property of the fpsapi module.  
     GetSourceHandleReturns a binary value representing the control's object as a source handle.  
     NistFingerQualityGets the NIST Finger Image Quality value from a finger.  
     ReadUDataReads the user data from the device.  
     ResetFingerListClears the internal finger image structures of the control.  
     SetIntPropertySets the integer value of a property of the fpsapi module.  
     SetPropertySets the text value of a property of the fpsapi module.  
     SetStatusLedTurns on/off the status leds.  
     SuspendSuspends the Fingerprint Scanner system.  
     UseDeviceOpens an FPS device.  
     UseDeviceNOpens an FPS device.  
     WakeUpWakes up the previously suspended Fingerprint Scanner system.  
     WriteUDataWrites the user data to the opened device.  

    Events:

    NameDescription
     ButtonEventOccurs when a button is pressed or released on the device.  
     ConnectionEventOccurs when a device is connected/disconnected.  
     FingerPresenceEventOccurs when the state of the finger presence detector module has changed.  
     FPSEventGeneral FPS event.  
     PowerEventOccurs when the power state or the power level is changed.  
     PreviewEventOccurs when a preview image is captured.  

    Private:

    Properties:

    NameDescription
     EventTypesBitmask for specifying the event types that invoke the FPSEvent event.  
     FreerunModeRepresents the light and camera control modes between two capture processes.  
     PowerLevel[Read only] The power level of devices capable of working without external power supply.  
     PowerState[Read only] The power state of the device.  
     RuntimeConfigRuntime configuration of the ActiveX component.  
     UDBlockSize[Read only] The block size of the user data space of the device.  
     UDNumberOfBlocks[Read only] The number of blocks available in the user data space of the device.  
     Version[Read only] The version of the FpsApi ActiveX control.  
    History