FaceSDK class
Entry point of the Regula Face SDK.
Properties
- customization ↔ Customization
-
getter/setter pair
- env ↔ String?
-
Environment type.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- locale ↔ String?
-
Custom language locale code of DocumentReaderSDK.
If empty or doesn't exist - app language is used. Format "en-US" or "en".
getter/setter pair
-
localizationDictionary
↔ Map<
String, String> ? -
A localization dictionary to override default localization logic.
Allows to replace any string of FaceSDK with an arbitrary string.
getter/setter pair
- personDatabase → PersonDatabase
-
no setter
-
requestHeaders
↔ Map<
String, String> ? -
Unmodifiable property. Use setter instead of
.remove(),.addAll(), etc.getter/setter pair - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serviceUrl ↔ String?
-
getter/setter pair
- tenant ↔ String?
-
Customer name.
getter/setter pair
- version → FaceSDKVersion?
-
Information about the SDK.
no setter
- videoEncoderCompletion ← VideoEncoderCompletion
-
Allows user to receive a video file of current session
no getter
Methods
-
deinitialize(
) → void - Used to deinitialize FaceSDK and free up RAM as a consequence of this.
-
detectFaces(
DetectFacesRequest request) → Future< DetectFacesResponse> -
initialize(
{InitConfig? config}) → Future< (bool, InitException?)> - Allows you to initialize FaceSDK.
-
isInitialized(
) → Future< bool> - Checks if FaceSDK is initialized.
-
matchFaces(
MatchFacesRequest request, {MatchFacesConfig? config}) → Future< MatchFacesResponse> -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
splitComparedFaces(
List< ComparedFacesPair> facesPairs, double similarityThreshold) → Future<ComparedFacesSplit> -
startFaceCapture(
{FaceCaptureConfig? config, CameraSwitchCallback? cameraSwitchCallback}) → Future< FaceCaptureResponse> -
startLiveness(
{LivenessConfig? config, LivenessNotificationCompletion? notificationCompletion, CameraSwitchCallback? cameraSwitchCallback}) → Future< LivenessResponse> -
stopFaceCapture(
) → void -
stopLiveness(
) → void -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited