Skip to content

Flutter

This is a Flutter-specific Face SDK installation guide. Before proceeding further, make sure you've read the Installation page and have selected the Core type to install.

Requirements

  • The latest stable version of Flutter
  • For iOS, the minimum target is iOS 11.0
  • For Android, the minimum Android API level is 21

Installation

The Face SDK is available on pub.dev.

1. Add flutter_face_api as a dependency in your pubspec.yaml file:

dependencies:
  flutter_face_api: ^6.1.1
  flutter_face_core_basic: ^6.1.0

dependencies:
  flutter_face_api: ^6.1.1
  flutter_face_core_match: ^6.1.0

Alternatively, run this command:

flutter pub add flutter_face_api
flutter pub add flutter_face_core_basic

flutter pub add flutter_face_api
flutter pub add flutter_face_core_match

2. Install the packages using the following command:

flutter pub get

3. To use Core Match, it's necessary to include the uncompressed faceSdkResource.dat file in the APK. When integrating the Face SDK into a multi-module project, remember to add the code snippet to the android section at the end of the app's Gradle file, rather than within the module itself. If you use Core Basic, skip this step.

Simply add the following configuration into android section of your android/app/build.gradle:

    aaptOptions {
        noCompress "Regula/faceSdkResource.dat"
    }

Android permisions

Most likely You will need to add internet permission(except some rare cases). Permissions are added to the top section of android/app/src/main/AndroidManifest.xml like this: 

<manifest xmlns:android="http://schemas.android.com/apk/res/android">
    <uses-permission android:name="android.permission.INTERNET" />
    ...
</manifest>

Import the Face SDK

You should now be able to import face_api:

import 'package:flutter_face_api/flutter_face_api.dart';

Info

You can always use our demo application on GitHub.

Next Step