co.blustor.gatekeepersdk.biometrics

Class GKFaces

java.lang.Object

co.blustor.gatekeepersdk.biometrics.GKFaces

public class GKFaces
extends java.lang.Object

GKFaces is a Service for handling facial biometrics.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GKFaces.OnCameraCompletionListener Interface of camera completion results
static class	GKFaces.Template A Template contains captured facial biometric data.

Constructor Summary

Constructors

Constructor and Description
GKFaces() Create a GKFaces instance.

Method Summary

Modifier and Type	Method and Description
void	captureImage() Captures results from the current camera thread when thread is active No-op when there is no camera capture thread
GKFaces.Template	createTemplateFromBitmap(android.graphics.Bitmap bitmap) Extract a face Template from the given Bitmap.
GKFaces.Template	createTemplateFromImage(java.io.File file) Extract a face Template from the given image File.
GKFaces.Template	createTemplateFromStream(java.io.InputStream inputStream) Retrieve a face Template from the given InputStream.
void	finishCameraCapture() Cancels the current camera capture thread No-op when there is no camera capture thread
NFaceView	setFaceCaptureView(android.content.Context context, android.view.ViewGroup container) Set up view for face capturing
void	startCapturing(NFaceView faceView, GKFaces.OnCameraCompletionListener listener) Start the camera for face capturing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GKFaces

public GKFaces()

Create a GKFaces instance.

Method Detail

createTemplateFromBitmap

public GKFaces.Template createTemplateFromBitmap(android.graphics.Bitmap bitmap)

Extract a face Template from the given Bitmap.

Parameters:

bitmap - a Bitmap image of a face to extract

Returns:

a Template with facial capture data

Since:

0.5.0

createTemplateFromImage

public GKFaces.Template createTemplateFromImage(java.io.File file)
                                         throws java.io.IOException

Extract a face Template from the given image File.

Parameters:

file - an image File of a face to extract

Returns:

a Template with facial capture data

Throws:

java.io.IOException - when a template fails to be created

Since:

0.6.0

createTemplateFromStream

public GKFaces.Template createTemplateFromStream(java.io.InputStream inputStream)
                                          throws java.io.IOException

Retrieve a face Template from the given InputStream.

Parameters:

inputStream - stream data of a capture Template

Returns:

a Template created from the stream data

Throws:

java.io.IOException - when the stream could not be read successfully

Since:

0.5.0

setFaceCaptureView

public NFaceView setFaceCaptureView(android.content.Context context,
                                    android.view.ViewGroup container)

Set up view for face capturing

Parameters:

context - application/activity context.

container - ViewGroup where the camera is going to be displayed

Returns:

the attached NFaceView

Since:

0.13.0

startCapturing

public void startCapturing(NFaceView faceView,
                           GKFaces.OnCameraCompletionListener listener)

Start the camera for face capturing

Parameters:

faceView - the View where the camera will be displayed

listener - OnCameraCompletionListener for success/failure responses

Since:

0.13.0

captureImage

public void captureImage()

Captures results from the current camera thread when thread is active No-op when there is no camera capture thread

Since:

0.13.0

finishCameraCapture

public void finishCameraCapture()

Cancels the current camera capture thread No-op when there is no camera capture thread

Since:

0.13.0