RFSFaceCaptureConfiguration

Objective-C


@interface RFSFaceCaptureConfiguration
    : RFSBaseConfiguration <RFSFaceCaptureConfigurationBuilder *> <NSObject>

Swift

class FaceCaptureConfiguration : BaseConfiguration<FaceCaptureConfigurationBuilder>, NSObjectProtocol

Configuration for the FaceCapture.

This class is used as a parameters for -[RFSFaceSDK presentFaceCaptureViewControllerFrom:animated:configuration:onCapture:completion:]. The configuration provides convenient properties to change the behavior and the appearance of the FaceCapture UI module.

  • Defines whether the RFSHintView idle animation is enabled or not. Defaults to true. When set to false the RFSHintView will not play the animation that is triggered when hint statuses remain the same for some time.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
          getter=isHintAnimationEnabled) BOOL enableHintAnimation;

    Swift

    var isHintAnimationEnabled: Bool { get }

Camera

  • Defines, whether the camera’s toolbar switch camera button is available on the FaceCapture UI. Defaults to false. When set to true the CameraToolbarView will contain a button to change current cameraPosition.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
          getter=isCameraSwitchButtonEnabled) BOOL cameraSwitchButtonEnabled;

    Swift

    var isCameraSwitchButtonEnabled: Bool { get }

  • Defines, whether the camera’s toolbar torch button is available on the FaceCapture UI. Defaults to true. When set to false the CameraToolbarView won’t contain a button to toggle camera’s flashlight.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
          getter=isTorchButtonEnabled) BOOL torchButtonEnabled;

    Swift

    var isTorchButtonEnabled: Bool { get }

  • Defines, whether the camera’s toolbar close button is available on the FaceCapture UI. Defaults to true. When set to false the CameraToolbarView won’t contain a button to close a module

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
          getter=isCloseButtonEnabled) BOOL closeButtonEnabled;

    Swift

    var isCloseButtonEnabled: Bool { get }

  • Selected camera device position. Defaults to .front.

    Declaration

    Objective-C

    @property (nonatomic, readonly) RFSCameraPosition cameraPosition;

    Swift

    var cameraPosition: CameraPosition { get }