<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@digitalpersona/devices](./devices.md) &gt; [FingerprintReader](./devices.fingerprintreader.md)

## FingerprintReader class

A fingerprint reader API. An instance of this class allows to subscribe to finerprint reader events and read fingerprint data. The fingerprint reader API uses DigitalPersona WebSDK to communicate with fingerprint reader drivers and hardware.

<b>Signature:</b>

```typescript
export declare class FingerprintReader extends MultiCastEventSource 
```

## Constructors

|  Constructor | Modifiers | Description |
|  --- | --- | --- |
|  [(constructor)(options)](./devices.fingerprintreader.(constructor).md) |  | Constructs a new fingerprint reader API object. |

## Properties

|  Property | Modifiers | Type | Description |
|  --- | --- | --- | --- |
|  [onAcquisitionStarted](./devices.fingerprintreader.onacquisitionstarted.md) |  | <code>Handler&lt;AcquisitionStarted&gt;</code> | An event handler for the [AcquisitionStarted](./devices.acquisitionstarted.md) event. |
|  [onAcquisitionStopped](./devices.fingerprintreader.onacquisitionstopped.md) |  | <code>Handler&lt;AcquisitionStopped&gt;</code> | An event handler for the [AcquisitionStopped](./devices.acquisitionstopped.md) event. |
|  [onCommunicationFailed](./devices.fingerprintreader.oncommunicationfailed.md) |  | <code>Handler&lt;CommunicationFailed&gt;</code> | An event handler for the [CommunicationFailed](./devices.communicationfailed.md) event. |
|  [onDeviceConnected](./devices.fingerprintreader.ondeviceconnected.md) |  | <code>Handler&lt;DeviceConnected&gt;</code> | An event handler for the [DeviceConnected](./devices.deviceconnected.md) event. |
|  [onDeviceDisconnected](./devices.fingerprintreader.ondevicedisconnected.md) |  | <code>Handler&lt;DeviceDisconnected&gt;</code> | An event handler for the [DeviceDisconnected](./devices.devicedisconnected.md) event. |
|  [onErrorOccurred](./devices.fingerprintreader.onerroroccurred.md) |  | <code>Handler&lt;ErrorOccurred&gt;</code> | An event handler for the [ErrorOccurred](./devices.erroroccurred.md) event. |
|  [onQualityReported](./devices.fingerprintreader.onqualityreported.md) |  | <code>Handler&lt;QualityReported&gt;</code> | An event handler for the [QualityReported](./devices.qualityreported.md) event. |
|  [onSamplesAcquired](./devices.fingerprintreader.onsamplesacquired.md) |  | <code>Handler&lt;SamplesAcquired&gt;</code> | An event handler for the [SamplesAcquired](./devices.samplesacquired.md) event. |

## Methods

|  Method | Modifiers | Description |
|  --- | --- | --- |
|  [enumerateDevices()](./devices.fingerprintreader.enumeratedevices.md) |  | Lists all connected fingerprint readers. |
|  [getDeviceInfo(deviceUid)](./devices.fingerprintreader.getdeviceinfo.md) |  | Reads a fingerprint reader device information. |
|  [off(event, handler)](./devices.fingerprintreader.off.md) |  | Deletes an event handler for the event. |
|  [on(event, handler)](./devices.fingerprintreader.on.md) |  | Adds an event handler for the event. This is a multicast subscription, i.e. many handlers can be registered at once. |
|  [startAcquisition(sampleFormat, deviceUid)](./devices.fingerprintreader.startacquisition.md) |  | Activate a fingerprint acquisition mode. This call will produce a [AcquisitionStarted](./devices.acquisitionstarted.md) event if activation was successful. After that the reader will wait for a finger placed on the reader. When a finger is placed, a [QualityReported](./devices.qualityreported.md) event will report a scan quality, and a [SamplesAcquired](./devices.samplesacquired.md) event will return a scanned sample in case of a successful scan. |
|  [stopAcquisition(deviceUid)](./devices.fingerprintreader.stopacquisition.md) |  | Deactivates a fingerprint acquisition mode. This call will produce a [AcquisitionStopped](./devices.acquisitionstopped.md) event if deactivation was successful. After that the reader will stop waiting for a finger. |

