Face Capture - Selphi

Face Capture is performed with the Selphi Component.

Face Capture is performed with the Selphi Component.

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

Flutter:

dependencies:
  fphi_sdkmobile_selphi:
    hosted:
      name: fphi_sdkmobile_selphi
      url: https://facephicorp.jfrog.io/artifactory/api/pub/pub-pro-fphi/
    version: ^<Version>

Android - Gradle:

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

iOS - CocoaPods:

s.dependency 'FPHISDKSelphiComponent', '~> $version'

Available methods

This component contains several methods that execute different functionalities:

Method	Description
startSelphiFaceWidget	Main controller of Facial Recognition

Method startSelphiFaceWidget

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:

@override
Future<Map> startSelphiFaceWidget({
  required String resourcesPath,
  required SelphiFaceConfiguration widgetConfigurationJSON
}) async {
  final Map result = await methodChannel.invokeMethod('selphi',
      {"resourcesPath": resourcesPath, "widgetConfigurationJSON": widgetConfigurationJSON.toJson()}
  );
  return result;
}

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:

class SelphiFaceConfiguration {
  bool? mDebug;
  bool? mFullscreen;
  bool? mLogImages;
  bool? mStabilizationMode;
  bool? mTemplateRawOptimized;
  bool? mQRMode;
  bool? mShowResultAfterCapture;
  bool? mShowDiagnostic;
  bool? mShowTutorial;
  bool? mShowPreviousTip;
  bool? mVibrationEnabled;
  bool mEnableGenerateTemplateRaw;
  double mCropPercent;
  double mJPGQuality;
  String? mTranslationsContent;
  String? mViewsContent;
  String? mVideoFilename;
  int? mCameraId;
  int? mMoveSuccessfulAttempts;
  int? mMoveFailedAttempts;
  dynamic mParams;
  SelphiFaceLivenessMode? mLivenessMode;
  SelphiCompressFormat mCompressFormat;
  SelphiFaceExtractionDuration? mExtractionDuration;
  SelphiCamera mCameraPreferred;   
}

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:

class SelphiFaceResult {
  final SdkFinishStatus finishStatus;
  final String finishStatusDescription;
  final String errorDiagnostic;
  final String? errorMessage;
  final String? templateRaw;
  final String? qrData;
  final String? bestImage;
  final String? bestImageCropped;
  final String? bestImageTemplateRaw;
  final String? livenessDiagnostic;
  final dynamic images;
}

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