Overview¶

Naming conventions¶

For the sake of clarity in this multi-language documentation, the following naming conventions have been adopted.

Class, struct and enumeration names are written in PascalCase. Example: License.
Class and struct member names are written in lowerCamelCase. Example: activateSerialKey
Enumeration fields are written in lowerCamelCase. Example : LicenseError.invalidLicense.

Warning

The naming convention adopted in this documentation does not necessarily reflect the convention for a given programming language. More information is given below.

Examples¶

Python

Class name: License
Function name: activate_serial_key
Structure: FingerPoint
Enumeration field: LicenseError.INVALID_LICENSE

Dart

Class name: License
Function name: activateSerialKey
Structure: FingerPoint
Enumeration field: LicenseError.invalidLicense

Class name: License
Function name: ActivateSerialKey
Structure: FingerPoint
Enumeration field: LicenseError.InvalidLicense

Java

Class name: License
Function name: activateSerialKey
Structure: FingerPoint
Enumeration field: LicenseError.INVALID_LICENSE

Kotlin

Class name: License
Function name: activateSerialKey
Structure: FingerPoint
Enumeration field: LicenseError.INVALID_LICENSE

Swift

Class name: License
Function name: activateSerialKey
Structure: FingerPoint
Enumeration field: LicenseError.invalidLicense

Class name: id3License_
Function name: id3License_ActivateSerialKey
Structure: id3FingerPoint
Enumeration field: id3LicenseError_InvalidLicense

Note

The C API implements pseudo object-oriented programming concepts where the object is passed explicitly to a member function as first parameter.

Adding the SDK to your project¶

Windows

The SDK relies on native libraries that must be copied to a bin subdirectory within your project’s target directory.

The following libraries are necessary:

Library	Description
`id3Finger.dll`	The main library for fingerprint processing and operations.
`id3FingerCapture.dll`	Facilitates the capture of fingerprint images from devices.
`id3Devices.dll`	Handles communication with capture devices.

To automate the process within Visual Studio, add a pre-build event to your project:

Right-click on your project in the Solution Explorer and select Properties.
Go to the Build Events tab.

In the Pre-build event command line box, enter the following command:

mkdir $(TargetDir)bin
mkdir $(TargetDir)devices

xcopy /e /y $(SolutionDir)..\..\bin\*.dll $(TargetDir)\bin
xcopy /e /y $(SolutionDir)..\..\devices\* $(TargetDir)\devices

This command copies all DLL files from the SDK’s native library directory to the bin subdirectory of your project’s target directory every time the project is built.

Ensure the path $(SolutionDir)..\..\ is correctly adjusted to point to the location where the SDK’s native libraries are stored.

Linux

Add one of the following native library:

/bin/linux/x64/libid3Finger.so, or
/bin/linux/x64_gpu/libid3Finger.so for CUDA support.

Android

Include the AAR package to your project:

/bin/android/eu.id3.finger.aar

Apple

Include the package in your project:

Unzip the Framework:
Unzip the /bin/apple/id3Finger.xcframework.zip package to access the id3Finger.xcframework directory.
Add the Framework to Xcode:
Open your Xcode project and drag the id3Finger.xcframework directory into the “Frameworks, Libraries, and Embedded Content” section.
Update Build Settings:
Ensure that id3Finger.xcframework is listed under “Link Binary with Libraries” in your target’s “Build Phases”. Set the “Framework Search Paths” in your target’s “Build Settings” to include the path to id3Finger.xcframework.
Configure Code Signing:
Adjust the code signing settings in Xcode to allow the app to run with the included framework.
Handle Runtime Dependencies:
Ensure any additional runtime dependencies required by id3Finger.xcframework are included.

Using the SDK in your project¶

Python

import id3finger

Dart

import 'package:id3_finger/id3_finger.dart';

using id3.Finger;

Java

import eu.id3.finger;

#include "id3Finger.h"

Initializing the SDK¶

Before using any functions of the id3 Finger SDK, it is crucial to perform the following initialization steps:

1. Validate the License: Ensure that a valid license file is present before calling any SDK functions. Refer to the License Handling section for detailed instructions on how to verify the license file.

2. Load the AI Models: After validating the license, load the necessary AI models required by the SDK. For more information on loading AI models, see the AI Models section.

By following these initialization steps, you ensure that the SDK is properly set up and ready for use.

Implementing Key Features¶

The id3 Finger SDK provides a comprehensive set of functionalities for biometric applications. The following sections will guide you through the implementation of essential features:

Feature	Description
Finger Capture	Learn how to initialize and use the SDK to capture high-quality fingerprint images from various sources, including finger scanners, files, and data buffers.
Finger Detection	Discover how to detect and identify fingerprints within captured images, ensuring accurate and reliable biometric data processing.
Feature Extraction	Understand the process of extracting unique biometric features from fingerprint images, which are essential for subsequent identification and verification processes.
One-to-One Comparison	Implement techniques for comparing two fingerprint templates to verify if they belong to the same individual, providing robust authentication mechanisms.
On-Card Comparison	Explore the methods for performing fingerprint comparisons directly on smart cards, enhancing security and efficiency in biometric verification systems.
One-To-Many Search	Master the process of searching a fingerprint template against a database of stored templates to identify the individual, enabling effective biometric identification.

Each section will provide detailed instructions, code examples, and best practices to help you effectively utilize the id3 Finger SDK for these critical biometric operations.