RFSLivenessConfiguration
Objective-C
@interface RFSLivenessConfiguration
: RFSBaseConfiguration <RFSLivenessConfigurationBuilder *> <NSObject>
Swift
class LivenessConfiguration : BaseConfiguration<LivenessConfigurationBuilder>, NSObjectProtocol
Configuration for the Liveness processing.
This class is used as a parameters for -[RFSFaceSDK startLivenessFrom:animated:configuration:onLiveness:completion:]
.
The configuration provides convenient properties to change the behavior and the appearance of the Liveness UI module.
-
Defines, whether the logo is visible on the bottom of Liveness UI screens. Defaults to
true
.Declaration
Objective-C
@property (nonatomic, readonly, getter=isCopyright) BOOL copyright;
Swift
var isCopyright: Bool { get }
-
Defines which steps of the user interface can be omitted. See RFSLivenessStepSkip enum for details.
Declaration
Objective-C
@property (nonatomic, readonly) RFSLivenessStepSkip stepSkippingMask;
Swift
var stepSkippingMask: RFSLivenessStepSkip { get }
-
The number of attempts to pass the Liveness before completing with error. Defaults to
0
. When set to0
the Liveness will always ask to retry on error. When set to1
or more the Liveness will end withRFSLivenessError.RFSLivenessErrorProcessingAttemptsEnded
error when the number of attemps exceeds.Declaration
Objective-C
@property (nonatomic, readonly) NSInteger attemptsCount;
Swift
var attemptsCount: Int { get }
-
Defines whether the liveness request sends a location of a device. Defaults to
true
. When set totrue
the liveness request to web service will contain thelocation
object within the jsonmetadata
object. The location is used only when permissions are granted and the location is available.Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readonly, getter=isLocationTrackingEnabled) BOOL locationTrackingEnabled;
Swift
var isLocationTrackingEnabled: Bool { get }
-
Defines whether the liveness recording video of processing. Defaults to
true
.Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readonly, getter=isRecordingProcessEnabled) BOOL recordingProcessEnabled;
Swift
var isRecordingProcessEnabled: Bool { get }
-
Defines session ID that can be used in Liveness processing. Defaults to
nil
.Declaration
Objective-C
@property (nonatomic, strong, readonly, nullable) NSString *sessionId;
Swift
var sessionId: String? { get }
-
Defines, whether the camera’s toolbar close button is available on the Liveness UI. Defaults to
true
. When set tofalse
the CameraToolbarView won’t contain a button to close a moduleDeclaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readonly, getter=isCloseButtonEnabled) BOOL closeButtonEnabled;
Swift
var isCloseButtonEnabled: Bool { get }