Onyx Flutter Package

This is not free software. This plugin uses the Onyx software development kits (SDKs) for Android and iOS. It requires a license agreement with:Diamond Fortress Technologies, Inc.

Package Requirements

Example Project

Before running the example project, check that your local.properties contains flutter.sdk path and sdk.dir are pointed to the correct locations for flutter and android sdk respectively.


The example also uses a .env file to hold the license key, instead of hard coding it. You can obtain a license key from Telos if you do not have one.

If this is your first time running the flutter project you may have to do a flutter pub get

To run the example project, run Example/lib/main.dart. The sample app load to a screen that shows all of the onyx camera settings, and provides the ability to start the onyx camera with any of the settings on the initial screen.

Onyx controls

The OnyxCamera class's options contains all of onyx camera options, including the license key. please see the documentation for a complete list of the configuration options.

Once the settings are configured, simply call OnyxCamera.configureOnyx to set the onyx configurations

Listen for changes to the OnyxCamera state to determine when the onyx package is configured (state=configured), is returning results(state=success), or has an error (state=error). It is possible to configure and start Onyx separately, but this example project will start ONYX as soon as ONYX is ocnfigured.

Here's a bare bones implementation for getting started
OnyxCamera.state.addListener(() {
   if (OnyxCamera.state.status == OnyxStatuses.configured) {
       //starts onyx after it's configured
   if (OnyxCamera.state.isError) {
       //handle any onyx related errors.  error messages are stored in the OnyxCamera.state.resultMessage variable.
   if (OnyxCamera.state.status == OnyxStatuses.success) {
       //do something when the onyx camera sends back results.  OnyxCamera.Results holds the onyx results.
//sets the license key
OnyxCamera.options.licenseKey = "xxxx";
//starts the onyx camera.

Android setup

The minimum android version supported is 21. More details for installing the plugin can be found at pub.dev.

Add the Onyx native package's repository and dependency references below to your app's android/app/build.gradle file.

android {
    lintOptions {
        disable 'InvalidPackage'
repositories {
    maven {
        url 'http://nexus.diamondfortress.com/nexus/content/repositories/releases/'
    maven {
        url 'http://nexus.diamondfortress.com/nexus/content/repositories/snapshots/'
dependencies {
    implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
    implementation 'com.google.android.gms:play-services-base:17.6.0'
    implementation 'com.dft.android:onyx-camera:8.3.0'

The plugin also needs permission to write to external storage, so in the app's AndroidManifest.xml, make sure to add the line below.

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

iOS setup

Onyx must Run on a device, and will NOT run on an emulator!

Add the OnyxCamera specs repo to your CocoaPods installation

pod repo add gitlab-telosid-plugins https://gitlab.com/telosid/plugins/specs.git
pod install --repo-udpate

Add the Gitlab source specs repository to your PodFile

  • Insure that the ./iOS/PodFile specifies the following sources:
  • source 'https://gitlab.com/telosid/plugins/specs.git'
  • source 'https://cdn.cocoapods.org'

Set the iOS version to 11.

  • Insure that the ./iOS/PodFile specifies ios version 11 or later.
# Uncomment the next line to define a global platform for your project
platform :ios, '11.0'

Adjust iOS project properties from XCode

  • Disable Bitcode
    • Select the root directory and go to Build Settings
    • Search for bitcode
    • Set Enable Bitcode to No

Adjust the app permissions

  • Open the project's Info.plist file, and paste the following lines at the bottom of the <dict> element.

    <string>Capture fingerprint image</string>
    <string>Save Onyx Image Results</string>
    <string>Save Pictures</string>

Add the navigation controller to the iOS/Runner/AppDelegate file

#import "AppDelegate.h"
#import "GeneratedPluginRegistrant.h"
#import "OnyxPlugin.h"
@implementation AppDelegate

- (BOOL)application:(UIApplication *)application
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [GeneratedPluginRegistrant registerWithRegistry:self];
    //New Code
    FlutterViewController *flutterViewController =(FlutterViewController*)self.window.rootViewController;
    UINavigationController *navigationController = [[UINavigationController alloc] initWithRootViewController:flutterViewController];
    [navigationController setNavigationBarHidden:YES];    
    self.window = [[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]];
    self.window.rootViewController = navigationController;
    [self.window makeKeyAndVisible];
  // Override point for customization after application launch.
  return [super application:application didFinishLaunchingWithOptions:launchOptions];


the onyx fingerprint plugin.