VerIDSessionSettings

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

Settings common to registration, authentication and liveness detection sessions

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

    Declaration

    Swift

    @Clamped
@objc
public var faceCaptureCount: Int { get set }

  • Time the user has to complete the session

    Declaration

    Swift

    @objc
public var maxDuration: TimeInterval

  • 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

    @Clamped
@objc
public var yawThreshold: CGFloat { get set }

  • 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

    @Clamped
@objc
public var pitchThreshold: CGFloat { get set }

  • Constructor

    Declaration

    Swift

    @objc
public init(maxDuration: TimeInterval = 30.0, faceCaptureCount: 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