Skip to main content

LiveIDScannerHelper

public class LiveIDScannerHelper extends Object

↳ package com.onekosmos.blockid.sdk.cameramodule.liveID

The LiveIDScannerHelper class is a helper class to work with Live ID feature.

Constructors​

public LiveIDScannerHelper(@NonNull Context context, @NonNull ILiveIDResponseListener liveIDResponseListener)

  • Creates an object of LiveIDScannerHelper.
Parameters
contextContext: Application's context on top of which the Live ID scanning feature will start.
liveIDResponseListenerILiveIDResponseListener: The block to execute after the response is received.

public LiveIDScannerHelper(@NonNull Context context, @NonNull BIDScannerView bidLiveIDScannerView, View scannerOverlay, boolean shouldResetOnWrongExpression, @NonNull ILiveIDResponseListener liveIDResponseListener)

  • Creates an object of LiveIDScannerHelper. It has an additional parameter to indicate if the complete Live ID scanning feature must be reset or not if any of the expression goes wrong. The default value for shouldResetOnWrongExpression is true.
Parameters
contextContext: Application's context on top of which the Live ID scanning feature will start.
bidLiveIDScannerViewBIDScannerView: A custom view to be provided by application. This is generally used for UI customization.
scannerOverlayView: An overlay to be placed on top of BIDScannerView object.
shouldResetOnWrongExpressionboolean: A flag to indicate if the Live ID scanning feature must be reset or not if wrong expression detected.
liveIDResponseListenerILiveIDResponseListener: The block to execute after the response is received.

public LiveIDScannerHelper(@NonNull Context context, @NonNull ILiveIDResponseListener liveIDResponseListener, @NonNull BIDScannerView bidLiveIDScannerView, View scannerOverlay)

  • Creates an object of LiveIDScannerHelper.
Parameters
contextContext: Application's context on top of which the Live ID scanning feature will start.
liveIDResponseListenerILiveIDResponseListener: The block to execute after the response is received.
bidLiveIDScannerViewBIDScannerView: A custom view to be provided by application. This is generally used for UI customization.
scannerOverlayView: An overlay to be placed on top of BIDScannerView object.

Method Summary​

Parameters
voidstartLiveIDScanning()Starts the LiveID scanning in default mode.
voidstartLiveIDScanning(String dvcID)Starts the Live ID scanning based on the given dvcID (Document Verification Connector Identifier). This method additionally performs a liveness check of a given Live ID.
voidstopLiveIDScanningStops Live ID scanning.

Method Detail​

startLiveIDScanning​

public void startLiveIDScanning()

  • Starts the LiveID scanning in default mode.

startLiveIDScanning​

public void startLiveIDScanning(String dvcID)

  • Starts the Live ID scanning based on the given dvcID (Document Verification Connector Identifier). This method additionally performs a liveness check of a given Live ID.

stopLiveIDScanning​

public void stopLiveIDScanning()

  • Stops Live ID scanning.

Interface Summary​

Parameters
ILiveIDResponseListenerCallback for the event when Live ID is captured, face expressions are changed, or face is out of focus.
ILivenessCheckListenerAn optional listener. Called when the Live ID scanner has started liveness check.

Method Summary​

Parameters
voidexpressionDidReset()Called when a Live ID expression is wrong. The listener must implement this method to update the UI as appropriate.
voidonFaceFocusChanged(boolean isFocused, String expression)Called when if the user's face is in focus area for an expression to be performed.
voidonLiveIDCaptured(Bitmap liveIdBitmap, String token, ErrorManager.ErrorResponse error)Called when Live ID scanning is successful based on given expression checks.
voidonLivenessCheckStarted()Called when the Live ID scanner has started liveness check.

expressionDidReset​

default void expressionDidReset(String message)

  • Called when a Live ID expression is wrong. The listener must implement this method to update the UI as appropriate.
Parameters
messageString: A message passed to the listener.

onFaceFocusChanged​

default void onFaceFocusChanged(boolean isFocused, String expression)

  • Called when if the user's face is in the focus area for an expression to be performed.
Parameters
isFocusedboolean: A flag that indicates if the user's face is in the focus area.
expressionString: An expression to be performed.

onLiveIDCaptured​

void onLiveIDCaptured(Bitmap liveIdBitmap, String token, ErrorManager.ErrorResponse error)

  • Called when Live ID scanning is successful based on given expression checks.
Parameters
liveIdBitmapBitmap: An image of a person's face.
tokenString: A token that carries information about Live ID. This is used to verify if the user's Live ID is modified before storing it on the BlockID blockchain platform.
errorErrorManager.ErrorResponse: An object of ErrorResponse.

onLivenessCheckStarted​

default void onLivenessCheckStarted()

  • Called when the Live ID scanner started the liveness check.