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.

  • Undocumented

    Declaration

    Objective-C

    @property(readonly, nonatomic, nullable) NSNumber *timeoutInterval

    Swift

    var timeoutInterval: NSNumber? { get }

  • Undocumented

    Declaration

    Objective-C

    @property(readonly, nonatomic, nullable) NSNumber *holdStillDuration

    Swift

    var holdStillDuration: NSNumber? { get }

Camera

  • Defines, whether the logo is visible on the bottom of Face Capture UI screens. Defaults to true.

    Declaration

    Objective-C

    @property (nonatomic, readonly, getter=isCopyright) BOOL copyright;

    Swift

    var isCopyright: Bool { get }

  • 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 }

  • Enables vibration during Face Capture processing. Defaults to true.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL vibrateOnSteps;

    Swift

    var vibrateOnSteps: Bool { get }

  • Enables ‘remove occlusion’ animation & hint. Defaults to true.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL detectOcclusion;

    Swift

    var detectOcclusion: Bool { get }

  • Enables global face hint animation. Defaults to true.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL showFaceAnimation;

    Swift

    var showFaceAnimation: Bool { get }

  • Allows you to specify an orientation of the camera view controller. Defaults to RFSScreenOrientationPortrait.

    Declaration

    Objective-C

    @property (nonatomic, readonly) RFSScreenOrientation screenOrientation;

    Swift

    var screenOrientation: RFSScreenOrientation { get }