Comment on page

SybrinFacialRecognitionConfiguration

import com.sybrin.facialrecognition.SybrinFacialRecognitionConfiguration
Provides an immutable reference to a configuration module used to control the look, feel, and behavior of the Sybrin Biometrics Android SDK Facial Recognition component.
In depth explanations and examples of how the SybrinFacialRecognitionConfiguration impacts the look, feel, and behavior of the Sybrin Identity Android SDK can be found within its Builder class.
Summary
Nested classes
​
class
​SybrinFacialRecognitionConfiguration.Builder​
​
Builder for the immutable SybrinFacialRecognitionConfiguration class.
Public methods
​
String
​getApplicationDirectory()
​CameraFacing​
​getCameraFacing()
int
​getCapturedImageCountForTraining()​
String
​getCustomAuthorizationToken()​
String
​getEnvironmentKey()
​Language​
​getLanguage()​
String
​getLicense()
int
​getOverlayBorderColor()
int
​getOverlayBorderThickness()
int
​getOverlayBrandingSubtitleColor()
String
​getOverlayBrandingSubtitleText()
int
​getOverlayBrandingTitleColor()
String
​getOverlayBrandingTitleText()
int
​getOverlayColor()
int
​getOverlayLabelTextColor()
int
​getOverlaySubLabelTextColor()
String[]
​getPermissions()
int
​getTorchButtonColor()
boolean
​isEnableTorchButton()
boolean
​saveImages()
Public methods
getApplicationDirectory
public String getApplicationDirectory()
Returns
​
String
The directory of the app consuming the SDK.
​
getCameraFacing 
public CameraFacing getCameraFacing  ()
Returns
​
​CameraFacing​
Which camera on the device is being used.
​
getCapturedImageCountForTraining
public String getCapturedImageCountForTraining()
Specifies the number of images captured for training on facial recognition.
Returns
​
int
A number indicating how many images must be captured for training
​
getCustomAuthorizationToken
public String getCustomAuthorizationToken()
Specifies a custom authorization token to be used during the online calls within the SDK.
Returns
​
String
Custom authorization token to be used during the online calls within the SDK.
​
getEnvironmentKey
public String getEnvironmentKey()
Returns
​
String
Key describing the SDK's environment variables.
​
getLanguage
public Language getLanguage()
Returns
​
​Language​
The language used by the SDK
​
getLicense
public String getLicense()
Returns
​
String
The Sybrin Biometrics Android SDK License used by the SDK.
​
getOverlayBorderColor
public boolean getOverlayBorderColor ()
Returns
​
int
The color of the overlay border.
​
getOverlayBorderThickness
public boolean getOverlayBorderThickness ()
Returns
​
int
The thickness of the overlay border.
​
getOverlayBrandingSubtitleColor
public boolean getOverlayBrandingSubtitleColor ()
Returns
​
int
Color of the branding subtitle text.
​
getOverlayBrandingSubtitleText
public boolean getOverlayBrandingSubtitleText ()
Returns
​
String
The overlay branding subtitle text.
​
getOverlayBrandingTitleColor
public boolean getOverlayBrandingTitleColor ()
Returns
​
int
Color of the overlay branding title text.
​
getOverlayBrandingTitleText
public boolean getOverlayBrandingTitleText ()
Returns
​
String
The overlay branding title text.
​
getOverlayColor
public boolean getOverlayColor ()
Returns
​
int
Color of the overlay.
​
getOverlayLabelTextColor
public boolean getOverlayLabelTextColor ()
Returns
​
int
Color of the overlay label text.
​
getOverlaySubLabelTextColor
public boolean getOverlaySubLabelTextColor ()
Returns
​
int
Color of the overlay sub-label text.
​
getPermissions
public String[] getPermissions ()
Returns
​
String[]
Array containing permissions used by the SDK.
​
getTorchButtonColor
public boolean getTorchButtonColor ()
Returns
​
int
Color of the torch button.
​
isEnableTorchButton
public boolean isEnableTorchButton ()
Returns
​
boolean
Whether the torch button is visible or not.
​
saveImages
public boolean saveImages ()
Returns
​
boolean
Whether the SDK should save all captured images after facial recognition completion.

SybrinFacialRecognition

SybrinFacialRecognitionConfiguration.Builder

Last modified 1yr ago

Nested classes
class	SybrinFacialRecognitionConfiguration.Builder Builder for the immutable SybrinFacialRecognitionConfiguration class.

Public methods
String	getApplicationDirectory()
CameraFacing	getCameraFacing()
int	getCapturedImageCountForTraining()
String	getCustomAuthorizationToken()
String	getEnvironmentKey()
Language	getLanguage()
String	getLicense()
int	getOverlayBorderColor()
int	getOverlayBorderThickness()
int	getOverlayBrandingSubtitleColor()
String	getOverlayBrandingSubtitleText()
int	getOverlayBrandingTitleColor()
String	getOverlayBrandingTitleText()
int	getOverlayColor()
int	getOverlayLabelTextColor()
int	getOverlaySubLabelTextColor()
String[]	getPermissions()
int	getTorchButtonColor()
boolean	isEnableTorchButton()
boolean	saveImages()

Returns
String	The directory of the app consuming the SDK.

Returns
CameraFacing	Which camera on the device is being used.

Returns
int	A number indicating how many images must be captured for training

Returns
String	Custom authorization token to be used during the online calls within the SDK.

Returns
String	Key describing the SDK's environment variables.

Returns
String	The Sybrin Biometrics Android SDK License used by the SDK.

Returns
String[]	Array containing permissions used by the SDK.

Returns
boolean	Whether the torch button is visible or not.

Returns
boolean	Whether the SDK should save all captured images after facial recognition completion.