iOS

Faceplugin Face Liveness Detection iOS SDK. On-premise PAD against photos, screens, masks, and deepfakes. Xcode frameworks, setActivation, initSDK, detectImage.

Fully on-premise Face Liveness SDK for iOS. Native class: FaceLivenessSDK.

What

iOS demo app (Xcode PRODUCT_BUNDLE_IDENTIFIER)

com.faceplugin.faceliveness.app

Android demo package name

com.faceplugin.faceliveness

SDK class / framework

FaceLivenessSDK in facelivenessdk.framework

Keep the iOS demo bundle com.faceplugin.faceliveness.app so the included license works. Request a new license key if you change it.

Code

GitHub - Faceplugin-ltd/FaceLivenessDetection-iOS: Liveness detection SDK iOS- iBeta level 2 certified passive liveness detection engine which can detect printed photos, video replay, 3D masks, and deepfake threatsGitHub

Setup

Unzip the frameworks from Google Drive: facelivenessdk.framework, FaceLivenessEngine.framework, onnxruntime.framework.
Add the SDK frameworks to the project in Xcode (Embed & Sign).
Add FaceLivenessSDK-Bridging-Header.h to Build Settings.

Status codes: 0 Success, 1 Invalid license, 2 Expired, 3 Not activated, 4 Init failed.

APIs

setActivation: This API is used to activate the SDK

+(int)setActivation:(NSString*)license;

Input

license (NSString*): The license string (license key)

Return value

The SDK activation status code.

0: Success
1: Invalid license
2: Expired
3: Not activated
4: Init failed

initSDK: This API is used to initialize the SDK

+(int)initSDK;

getMachineCode: This API is used to retrieve the machine code

+(NSString*)getMachineCode;

getLicenseStatus: This API is used to read license status

+(NSString*)getLicenseStatus;
+(BOOL)allowsLiveness;
+(NSString*)lastLicenseError;

detectImage: This API is used to detect faces and determine if the faces are real or fake

+(NSString*)detectImage:(UIImage*)image crop:(BOOL)crop flags:(int)flags;

Input

image (UIImage*): The input image

Return value

JSON string with detected faces and liveness scores.

The liveness score ranges from 0.0 to 1.0. If it's greater than the threshold, it's real face. Demo default threshold is 0.5.

VideoWorker: This API is used for the live camera HUD

+(int)startVideoWorkerWithMatchThreshold:(float)threshold;
+(int)addVideoWorkerFrame:(UIImage*)image;
+(int)addVideoWorkerSampleBuffer:(CMSampleBufferRef)sampleBuffer;
+(void)stopVideoWorker;

The liveness demo does not enroll a match database.

deinitSDK: This API is used to unload the engine

+(int)deinitSDK;

Run the demo

Place facelivenessdk, FaceLivenessEngine, and onnxruntime frameworks (see Setup).
Keep the Xcode bundle id com.faceplugin.faceliveness.app.
Run on a physical iPhone. Home tiles: Liveness, Settings, About. The demo does not enroll a match database.