Comment on page
SybrinLivenessDetectionConfiguration.Builder
import com.sybrin.livenessdetection.SybrinLivenessDetectionConfiguration
Public constructors |
Public methods | ​ |
​ | |
​ Sets whether the SDK should save all captured images to the device upon completion of the liveness detection process. | |
​ Sets the direction of the camera that is used for the scanning process. | |
​ Specifies a custom authorization token to be used during the online calls within the SDK. | |
​ Sets key that defines the SDK's internal environment variables. | |
​ Sets the thickness of the overlay cutout border. | |
​ Sets the text color of the branding subtitle. | |
​ Sets the text of the branding subtitle. | |
​ Sets the text color of the branding title. | |
​ Sets the text of the branding title. | |
​ Sets the color of the overlay sub-label text. | |
public Builder (String license)
Returns | ​ |
This value cannot be null . |
​
public
SybrinLivenessDetectionConfiguration.Builder
cloneConfiguration(
SybrinLivenessDetectionConfiguration
configuration)
Parameters | ​ |
configuration |
Returns | ​ |
This value cannot be null . |
public
SybrinLivenessDetectionConfiguration.Builder
enableOfflinePassiveLiveness (boolean offlinePassiveLiveness)
Default value:
true
Sets the visibility of the torch button.Parameters | ​ |
offlinePassiveLiveness | boolean: true enables passive liveness, false disables offline passive liveness. |
​
Returns | ​ |
This value cannot be null . |
Default value:
true
Sets the visibility of the torch button.Parameters | ​ |
enableTorchButton | boolean: true if torch button is visible, false if torch button is invisible. |
Returns | ​ |
This value cannot be null . |
Default | Configured - Torch button disabled |
​ ![]() | ​ ![]() |
Default value:
false
Sets whether the SDK should save all captured images to the device upon completion of the liveness detection process.Parameters | ​ |
saveImages | boolean: true if captured images should be saved, false if captured images should not be saved. |
Returns | ​ |
This value cannot be null . |
Default value:
CameraFacing.Back
Sets the direction of the camera that is used for the scanning process.Parameters | ​ |
cameraFacing | ​CameraFacing: CameraFacing.Back if the camera to be used during the scanning process is at the back of the device.​ CameraFacing.Front if the camera to be used during the scanning process is at the front of the device. |
Returns | ​ |
This value cannot be null . |
​
Sets a unique value that is associated with the scan. Can be used to associate different SDK components in the back-end.
Parameters | ​ |
setCorrelationId | String: Unique string identitying scan. Value cannot be null . |
Returns | ​ |
This value cannot be null . |
​
public
SybrinLivenessDetectionConfiguration.Builder
setCustomAuthorizationToken (String customAuthorizationToken)
Specifies a custom authorization token to be used during the online calls within the SDK.
Parameters | ​ |
customAuthorizationToken | String: The custom authorization token |
Returns | ​ |
This value cannot be null . |
​
Sets key that defines the SDK's internal environment variables.
Parameters | ​ |
setEnvironmentKey | String: Key that defines SDK environment variables. Value cannot be null . |
Returns | ​ |
This value cannot be null . |
Sets the language to be used within the SDK.
Parameters | ​ |
language | Language: The language that is to be used within the SDK |
Returns | ​ |
This value cannot be null . |
​
Default value:
Color.WHITE
Sets the color of the overlay cutout border.Parameters | |
setOverlayBorderColor | int |
Returns | ​ |
This value cannot be null . |
Default | Configured - Border color green |
​ ![]() | ​ ![]() |
public
SybrinLivenessDetectionConfiguration.Builder
setOverlayBorderThickness (int overlayBorderThickness)
Default value:
7
Sets the thickness of the overlay cutout border.Parameters | |
setOverlayBorderThickness | int |
Returns | ​ |
This value cannot be null . |
Default | Configured - Border thickness 20 | Configured - Border thickness 0 |
​ ![]() | ​ ![]() | ​ ![]() |
public
SybrinLivenessDetectionConfiguration.Builder
setOverlayBrandingSubtitleColor (int overlayBrandingSubtitleColor)
Default value:
Color.WHITE
Sets the text color of the branding subtitle.Parameters | |
setOverlayBrandingSubtitleColor | int |
Returns | ​ |
This value cannot be null . |
Default | Configured - Branding subtitle color green |
​ ![]() | ​ ![]() |
public
SybrinLivenessDetectionConfiguration.Builder
setOverlayBrandingSubtitleText (String overlayBrandingSubtitleText)
Default value:
"A DIVISION OF SYBRIN"
Sets the text of the branding subtitle.Parameters | ​ |
setOverlayBrandingSubtitleText | String: Text that is shown as the branding subtitle. Value cannot be null . |
Returns | ​ |
This value cannot be null . |
Default | Configured - Branding subtitle text |
​ ![]() | ​ ![]() |
public
SybrinLivenessDetectionConfiguration.Builder
setOverlayBrandingTitleColor (int overlayBrandingTitleColor)
Default value:
Color.WHITE
Sets the text color of the branding title.Parameters | |
setOverlayBrandingTitleColor | int |
Returns | ​ |
This value cannot be null . |
Default | Configured - Branding title color green |
​ ![]() | ​ ![]() |
public
SybrinLivenessDetectionConfiguration.Builder
setOverlayBrandingTitleText (String overlayBrandingTitleText)
Default value:
"INNOVATIONS LAB"
Sets the text of the branding title.Parameters | ​ |
setOverlayBrandingTitleText | String: Text that is shown as the branding title. Value cannot be null . |
Returns | ​ |
This value cannot be null . |
Default | Configured - Branding title text |
​ ![]() | ​ ![]() |
Default value:
Color.argb(80, Color.red(Color.BLACK), Color.green(Color.BLACK), Color.blue(Color.BLACK))
Sets the color of the overlay.Parameters | |
setOverlayColor | int |
Returns | ​ |
This value cannot be null . |
Default | Configured - Overlay color green | Configured - Overlay color green with opacity |
​ ![]() | ​ ![]() | ​ ![]() |
public
SybrinLivenessDetectionConfiguration.Builder
setOverlayLabelTextColor (int overlayLabelTextColor)
Default value:
Color.WHITE
Sets the color of the overlay label text.Parameters | |
setOverlayLabelTextColor | int |
Returns | ​ |
This value cannot be null . |
Default | Configured - Label text color green |
​ ![]() | ​ ![]() |
public
SybrinLivenessDetectionConfiguration.Builder
setOverlaySubLabelTextColor (int overlaySubLabelTextColor)
Default value:
Color.WHITE
Sets the color of the overlay sub-label text.Parameters | |
setOverlaySubLabelTextColor | int |
Returns | ​ |
This value cannot be null . |
Default | Configured - Sub-label color green |
​ ![]() | ​ ![]() |
Default value:
Color.WHITE
Sets the color of the torch button.Parameters | |
setTorchButtonColor | int |
Returns | ​ |
This value cannot be null . |
Default | Configured - Torch button color green |
​ ![]() | ​ ![]() |
Last modified 1yr ago