Load and check the license

Before calling any function of the SDK, you need to check a valid license file first.

Python

try:
    id3.FaceLicense.check_license(license_path)
    print(f"License name    : {id3.FaceLicense.get_license_name()}")
    print(f"License owner   : {id3.FaceLicense.get_license_owner()}")
    print(f"License serial  : {id3.FaceLicense.get_license_file_serial()}")
    print(f"License type    : {id3.FaceLicense.get_license_type().name}")
    print(f"Hardware code   : {id3.FaceLicense.get_license_file_hardware_code()}")
except id3.FaceException as ex:
    print(ex.message)

C#

try
{
    FaceLicense.CheckLicense("id3Face.lic");
}
catch (FaceException ex)
{
    Console.WriteLine(ex.Message);
}

Dart

try {
    FaceLicense.checkLicense("id3Face.lic");
}
catch (FaceException ex)
{
    print(ex.message);
}

Java

try {
    FaceLicense.checkLicense("id3Face.lic");
} catch (FaceException ex) {
    System.out.println(ex.getMessage());
}

Kotlin

try {
    FaceLicense.checkLicense("id3Face.lic")
} catch (ex: FaceException) {
    println(ex.message)
}

C

int err;

err = id3FaceLicense_CheckLicense("id3Face.lic", NULL);

if (err == id3FaceError_Success)
{
}

License modules

A license module gives access to some functionalities of the SDK as described below:

Module	Description
Face	Main module
FaceAttributes	Provides access to the FaceAnalyser Class
FaceEncoder	Provides access to the FaceEncoder Class
FaceGPU	Provides access to the GPU.
FaceMatcher	Provides access to the FaceMatcher Class
FaceIndexer	Provides access to the FaceIndexer Class with a maximum user count.
FacePAD	Provides access to the FacePad Class
ServerEdition	Identifies the server edition (Windows, Linux, Mac)
MobileEdition	Identifies the mobile edition (Android, iOS)
EdgeEdition	Identifies the edge edition (Raspberry PI)

Hint

In your application, call the FaceLicense.checkModule Method to find out whether a particular module is enabled in your license.