SybrinLivenessDetectionConfiguration.Builder

import com.sybrin.livenessdetection.SybrinLivenessDetectionConfiguration

Builder for the immutable SybrinLivenessDetectionConfiguration class

Summary

Public constructors

Builder

public Builder (String license)

Creates a new Builder using a Sybrin Biometrics Android License.

Public methods

build

public SybrinLivenessDetectionConfiguration build ()

Creates and returns a built SybrinLivenessDetectionConfiguration object.

cloneConfiguration

public SybrinLivenessDetectionConfiguration.Builder cloneConfiguration(SybrinLivenessDetectionConfiguration configuration)

Clones the properties from an already created SybrinLivenessDetectionConfiguration object.

enableTorchButton

public SybrinLivenessDetectionConfiguration.BuilderenableTorchButton (boolean enableTorchButton)

Default value: true Sets the visibility of the torch button.

Visual Example:

saveImages

public SybrinLivenessDetectionConfiguration.BuildersaveImages (boolean saveImages)

Default value: false Sets whether the SDK should save all captured images to the device upon completion of the liveness detection process.

setCameraFacing

public SybrinLivenessDetectionConfiguration.BuildersetCameraFacing (CameraFacing cameraFacing)

Default value: CameraFacing.Back Sets the direction of the camera that is used for the scanning process.

setCorrelationId

public SybrinLivenessDetectionConfiguration.Builder setCorrelationId(String correlationId)

Sets a unique value that is associated with the scan. Can be used to associate different SDK components in the back-end.

setEnvironmentKey

public SybrinLivenessDetectionConfiguration.Builder setEnvironmentKey(String environmentKey)

Sets key that defines the SDK's internal environment variables.

setOverlayBorderColor

public SybrinLivenessDetectionConfiguration.BuildersetOverlayBorderColor (int overlayBorderColor)

Default value: Color.WHITE Sets the color of the overlay cutout border.

Visual Example:

setOverlayBorderThickness

public SybrinLivenessDetectionConfiguration.BuildersetOverlayBorderThickness (int overlayBorderThickness)

Default value: 7 Sets the thickness of the overlay cutout border.

Visual Example:

setOverlayBrandingSubtitleColor

public SybrinLivenessDetectionConfiguration.BuildersetOverlayBrandingSubtitleColor (int overlayBrandingSubtitleColor)

Default value: Color.WHITE Sets the text color of the branding subtitle.

Visual Example:

setOverlayBrandingSubtitleText

public SybrinLivenessDetectionConfiguration.BuildersetOverlayBrandingSubtitleText (String overlayBrandingSubtitleText)

Default value: "A DIVISION OF SYBRIN" Sets the text of the branding subtitle.

Visual Example:

setOverlayBrandingTitleColor

public SybrinLivenessDetectionConfiguration.BuildersetOverlayBrandingTitleColor (int overlayBrandingTitleColor)

Default value: Color.WHITE Sets the text color of the branding title.

Visual Example:

setOverlayBrandingTitleText

public SybrinLivenessDetectionConfiguration.BuildersetOverlayBrandingTitleText (String overlayBrandingTitleText)

Default value: "INNOVATIONS LAB" Sets the text of the branding title.

Visual Example:

setOverlayColor

public SybrinLivenessDetectionConfiguration.BuildersetOverlayColor (int overlayColor)

Default value: Color.argb(80, Color.red(Color.BLACK), Color.green(Color.BLACK), Color.blue(Color.BLACK)) Sets the color of the overlay.

Visual Example:

setOverlayLabelTextColor

public SybrinLivenessDetectionConfiguration.BuildersetOverlayLabelTextColor (int overlayLabelTextColor)

Default value: Color.WHITE Sets the color of the overlay label text.

Visual Example:

setOverlaySubLabelTextColor

public SybrinLivenessDetectionConfiguration.BuildersetOverlaySubLabelTextColor (int overlaySubLabelTextColor)

Default value: Color.WHITE Sets the color of the overlay sub-label text.

Visual Example:

setTorchButtonColor

public SybrinLivenessDetectionConfiguration.BuildersetTorchButtonColor (int torchButtonColor)

Default value: Color.WHITE Sets the color of the torch button.

Visual Example: