Development Guide

This page contains the information of Usage, Configuration, Result of OkayDoc for Android and iOS

Android

Usage

For Android, a valid license key is required to start the process.

Configuration

Build the configuration object with the following Config properties listed below:

Config	Possible Input Range	Default
path	String	null
faceThreshold	between 0.0 and 1.0	0.9
eyeThreshold	between 0.0 and 1.0	0.5

Config config = new Config.Builder()
                .setImagePath(imagePath)
                .setFaceThreshold(0.9f)
                .setEyeThreshold(0.5f)
                .build();

SDK Initialization

Start the process by calling startDetection on FaceDetectorSDK as shown below. You must also pass a valid license string and a config into it.

FaceDetectorSDK.startDetection(this, licenseKey, config, new FaceDetectorResultListener() {
    @Override
    public void onResultReceived(boolean successful, int errorCode, FaceAttr result) {

        if (successful) {
            // handle result
        }
        else {
            // handle error
        }
    }
});

Result

Name	Description
getFaceImage	face image
isFaceDetected	returns true if face detected
isEye1Detected	returns true if first eye is detected
isEye2Detected	return true if second eye is detected

Error Code

errorCode is an int which can have the following values:

Error Code	Constant Name	Description
-1	FaceError.NO_ERROR	Face is successfully detected
1	FaceError.ERROR_INVALID_LICENSE_KEY	The license is invalid
2	FaceError.ERROR_PERMISSION_DENIED	The user did not grant the permission to access camera
3	FaceError.ERROR_USER_CANCEL_ACTION	The user canceled during the scanning process
4	FaceError.ERROR_TIME_OUT	10 seconds timer is triggered when face is detected

iOS

React-Native