FingerScanner Class

Namespace: id3.FingerCapture

Definition

This class represents a channel for capturing fingerprint data.

It extends the device channel capabilities and includes several events and properties specific to fingerprint capture processes, such as initiating and stopping captures, handling device status changes, and receiving image data.

Python

class FingerScanner

Dart

class FingerScanner implements Finalizable

C#

public partial class FingerScanner

C

typedef struct id3FingerCaptureFingerScanner *ID3_FINGER_CAPTURE_FINGER_SCANNER;

Usage

Python

fingerScannerInstance = FingerScanner()
# ...

Explicit destruction

# ...
del fingerScannerInstance

Dart

final fingerScannerInstance = sdk.FingerScanner();
// ...

Explicit destruction

// ...
fingerScannerInstance.dispose()

C#

using (var fingerScannerInstance = new FingerScanner())
{
   // ...
}

Explicit destruction

var fingerScannerInstance = new FingerScanner()
// ...
fingerScannerInstance.Dispose()

C

ID3_FINGER_CAPTURE_FINGER_SCANNER hFingerScanner{};
int err = id3CaptureFingerScanner_Initialize(&hFingerScanner);
if (err == ID3_SUCCESS) {
    // ...
    id3CaptureFingerScanner_Dispose(&hFingerScanner);
}

Properties

Name	Type	Description
autoCapture	bool	Indicates whether the device should automatically start capturing when conditions are met.
autoDetect	bool	Indicates whether the device is set to automatically detect the presence of a finger.
autoProcess	bool	Indicates whether the device should automatically process the captured images.
capabilities	DeviceParameterList	Lists the capabilities supported by the fingerprint device.
captureMode	FingerCaptureMode	Current capture mode set on the device. Default is ‘flat’.
captureModes	CaptureModeList	Lists the capture modes available on the device.
deviceAddedCallback	PlugAndPlayCallback	Callback invoked when a device is added to the channel.
deviceClosedCallback	DeviceSelectedCallback	Callback function for when a device is closed on this channel.
deviceEventCallback	DeviceEventCallback	(C++): Callback for generic device events.
deviceFilterList	DeviceTypeList	A list filtering the types of devices this channel will interact with.
deviceId	int	Identifier for the device associated with this channel, intended for internal or plugin use.
deviceInfo	DeviceInfo	Fetches the device object.
deviceOpenedCallback	DeviceSelectedCallback	Callback that is called when a device is opened on this channel.
deviceRemovedCallback	PlugAndPlayCallback	Callback function triggered upon the removal of a device from the channel.
deviceState	DeviceState	Reflects the current state of the device, such as connected, disconnected, etc.
deviceStatusChangedCallback	FingerCaptureStatusCallback	Callback invoked when the device’s status changes.
fingerDetector	FingerDetector	Specifies the component responsible for detecting fingers during the capture process.
fingerExtractor	FingerExtractor	Specifies the extractor component used for processing captured fingerprints.
imageCapturedCallback	CaptureCallback	Callback function called when a final image snapshot is available.
imagePreviewCallback	CaptureCallback	Callback function called when preview capture data is available.
isCapturing	bool	Indicates whether the device is currently capturing.
parameterCategoryList	id3.Devices.StringList	Lists categories of parameters relevant to the device.
previewImageFormat	VideoFormat	Defines the format of the image previews provided during capture.

Methods

Name	Description
addDeviceFilter	Adds a filter to specify the types of devices this channel should handle.
applyParameters	Applies a set of parameters to the device.
checkCaptureCapability	Checks if the specified capture capability is supported by the device, returning a boolean result.
checkCommand	(C++/dotnet): Checks if a specific command is available on the device.
checkParameter	Confirms if a parameter exists on the device.
clearDeviceFilter	Clears all set device filters, removing any type restrictions.
closeDevice	Controls closing the associated device.
getCapability	Retrieves the details of a specified capability of the device, such as resolution or supported capture modes.
getCapturedImage	Fetches the most recent image captured during the session.
getCurrentFrame	Retrieves the current live frame from the capture session.
getLastSnapshot	Retrieves the most recent snapshot taken during the capture session.
getParameter	Retrieves a device parameter’s value.
getParameterDescriptor	Fetches the descriptor of a device parameter.
getParameterList	Obtains all supported parameters, optionally filtered by category.
getParameterNameList	Retrieves names of all supported parameters, optionally filtered by category.
getParameterValueInt	Gets the integer value of a device parameter.
getPreviewImage	Obtains the most recent preview image from the ongoing capture session.
isPreviouslyDisconnectedDevice	Checks if the specified device was previously disconnected.
openDevice	Controls opening the associated device.
sendCommand	(C++/dotnet): Issues a command to the device.
sendCommandBoolean	(C++/dotnet): Issues a command with a boolean as result to the device.
sendModelCommand	(C++/dotnet): Dispatches a command to the device model.
setParameter	Sets a device parameter’s value.
setParameterValueInt	Assigns an integer value to a device parameter.
startCapture	Initiates the fingerprint capture process, specifying which fingers to capture.
stopCapture	Stops the fingerprint capture process currently underway.
takeSnapshot	Takes a snapshot during an ongoing capture session and stores it for later retrieval.
waitForCapture	Waits for a new capture to complete within a specified timeout.