VerIDSessionSettings

@objc(VerIDSessionSettings)
public class VerIDSessionSettings : NSObject, Codable

Settings common to registration, authentication and liveness detection sessions

  • True to show the result of the session to the user

    Declaration

    Swift

    @objc
public var showResult: Bool

  • Number of successful results the session must collect before it finishes

    Declaration

    Swift

    @objc
public var numberOfResultsToCollect: Int

  • Time the user has to complete the session

    Declaration

    Swift

    @objc
public var expiryTime: TimeInterval

  • Set this to record a video of the session

    Declaration

    Swift

    @objc
public var videoURL: URL?

  • How many times can the user retry before the session returns a failure

    Declaration

    Swift

    @objc
public var maxRetryCount: Int

  • Include face templates in the returned result. If you are going to use the collected faces for face recognition set this to true. Otherwise setting it to false will speed up the processing in the session. This may be useful if all you need to do is to detect liveness.

    Note

    Calling this method on registration and authentication sessions will have no effect. Both have this parameter always set to true.

    Declaration

    Swift

    @objc
public var includeFaceTemplatesInResult: Bool

  • Set to true to enable spoken prompts

    Declaration

    Swift

    @objc
public var speakPrompts: Bool

  • Horizontal (yaw) threshold where face is considered to be at an angle. For example, a value of 15 indicates that a face with yaw -15 and below is oriented left and a face with yaw 15 or above is oriented right.

    Declaration

    Swift

    @objc
public var yawThreshold: CGFloat

  • Vertical (pitch) threshold where face is considered to be at an angle. For example, a value of 15 indicates that a face with pitch -15 and below is oriented up and a face with pitch 15 or above is oriented down.

    Declaration

    Swift

    @objc
public var pitchThreshold: CGFloat

  • Fraction of the view width and height that represents the size of the face oval in the view.

    Declaration

    Swift

    @objc
public var faceBoundsFraction: CGSize

  • Use the camera located on the front of the device when collecting images for face detection

    Declaration

    Swift

    @objc
public var useFrontCamera: Bool

  • Constructor

    Declaration

    Swift

    @objc
public init(expiryTime: TimeInterval = 30.0, numberOfResultsToCollect: Int = 1)

    Parameters

    expiryTime

    Time the user has to complete the session
    numberOfResultsToCollect

    Number of successful results the session must collect before it finishes

  • Declaration

    Swift

    required public init(from decoder: Decoder) throws

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws