Face Capture - Selphi

Version: 2.3.X

Introduction

Face Capture is performed with the Selphi Plugin.

This component is responsible for capturing a user's selfie and subsequently extracting the most important facial features. Its main processes are:

• Internal management of cameras and permissions.

• Assistant in the user's face capture processes.

• Generation of the templates with the facial features and the user's image.

---

Dependencies

Cordova:

cordova plugin add @facephi/sdk-selphi-cordova@<version>

Android - Gradle:

implementation "com.facephi.androidsdk:selphi_component:$version"

iOS - CocoaPods:

pod 'FPHISDKSelphiComponent', '~> $version'

Available methods

This component contains several methods that execute different functionalities:

Method	Description
launchSelphi	Main controller of Facial Recognition

launchSelphi method

Once the SDK has been started and a new operation has been created, the component can be launched. Any of its controllers can be used to execute its functionality.

Face Capture launch:

exports.launchSelphi = function (cfg) {
    return new Promise((resolve, reject) => {
        var config = [];
        try {
            config = [{
                config: cfg
            }];
        } catch (e) {
            console.log(e);
        }

        exec(resolve, reject, 'SdkSelphi', 'launchSelphi', config);
    });
};

Basic configuration

To launch the current component, an object SelphiFaceConfiguration must be created, which will be the configuration of the component controller.

The basic configuration needed for this is as follows:

export interface SelphiFaceConfiguration {
    resourcesPath: string;
    debug?: boolean;
    cropPercent?: boolean;
    stabilizationMode?: boolean;
    templateRawOptimized?: boolean;
    compressFormat?: SelphiCompressFormat;
    jpgQuality?: number;
    logImages?: boolean;
    livenessMode?: SelphiFaceLivenessMode;
    enableGenerateTemplateRaw?: boolean;
    showDiagnostic?: boolean;
    showTutorial?: boolean;
    showResultAfterCapture?: boolean;
    fullscreen?: boolean;
    qrMode?: boolean;
    translationsContent?: string;
    viewsContent?: string;
    cameraId?: number;
    params?: any;
    cameraFlashEnabled?: boolean;
    showPreviousTip?: boolean;
    extractionDuration?: SelphiExtractionDuration;
    cameraPreferred?: SelphiCamera;
    vibrationEnabled?: boolean;
    moveSuccessfulAttempts?: number;
    moveFailedAttempts?: number;   
}

Advanced component configuration

Below are all the fields that are part of this class.

Selphi Configuration

---

Result reception

The launch will return the information in SelphiFaceResult format. It will be possible to distinguish between a successful launch and an unsuccessful one:

export interface SelphiFaceResult {
    finishStatus: number;
    finishStatusDescription: string;
    errorType: string;
    errorMessage?: string;
    template?: string;
    templateRaw?: string;
    eyeGlassesScore?: number;
    templateScore?: number;
    qrData?: string;
    images?: [string];
    bestImage?: string;
    bestImageCropped?: string;
    livenessDiagnostic?: string;
    iad?: string;
}

Advanced component configuration

Below are all the fields that are part of this class.

Selphi Result

Component Customization

In addition to the changes that can be made at the SDK level (which are explained in the document of Advanced settings), this specific component allows its own Customization.

Selphi - Component Customization