LCLunaConfiguration

Objective-C

@interface LCLunaConfiguration : NSObject

Swift

class LCLunaConfiguration : NSObject

Luna ID SDK main configuration object.

  • Returns the default configuration.

    Declaration

    Objective-C

    + (nonnull LCLunaConfiguration *)userDefaults;

    Swift

    class func userDefaults() -> LCLunaConfiguration

  • Creates configuration bject from plist file

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPlistFilePath:(nonnull NSString *)plistFilePath;

    Swift

    init(plistFilePath: String)

  • Resets license cache. Deletes all the cache that it has about license for reactivation process

    Declaration

    Objective-C

    + (void)resetLicenseCache;

    Swift

    class func resetLicenseCache()

  • Current version of LunaSDK(C++ basis of LunaID)

    Declaration

    Objective-C

    - (nonnull NSString *)lunaSDKVersion;

    Swift

    func lunaSDKVersion() -> String

  • This one will save all the setting into UserDefaults

    Declaration

    Objective-C

    - (void)save;

    Swift

    func save()

  • Best shot configuration.

    Declaration

    Objective-C

    @property (nonatomic, strong) LCBestShotConfiguration *_Nonnull bestShotConfiguration;

    Swift

    var bestShotConfiguration: LCBestShotConfiguration { get set }

  • Config for interactions

    Declaration

    Objective-C

    @property (nonatomic, strong) LCInteractionsConfig *_Nonnull interactionsConfig;

    Swift

    var interactionsConfig: LCInteractionsConfig { get set }

  • If true then allows to send multiple frames to the backend for aggregation

    Declaration

    Objective-C

    @property (nonatomic) BOOL multipartBestShotsEnabled;

    Swift

    var multipartBestShotsEnabled: Bool { get set }

  • If true then checks if the face in frame has glasses on

    Declaration

    Objective-C

    @property (nonatomic) BOOL glassesCheckEnabled;

    Swift

    var glassesCheckEnabled: Bool { get set }

  • If true then all checks should use aggregation approach aka make a decision on the basis of few frames not single one

    Declaration

    Objective-C

    @property (nonatomic) BOOL aggregationEnabled;

    Swift

    var aggregationEnabled: Bool { get set }

  • A flag to include OCR in authorization processes. Used only for LunaExample demo application

    Declaration

    Objective-C

    @property (nonatomic) BOOL ocrEnabled;

    Swift

    var ocrEnabled: Bool { get set }

  • If true then interactions stage will be used

    Declaration

    Objective-C

    @property (nonatomic) BOOL interactionEnabled;

    Swift

    var interactionEnabled: Bool { get set }

  • If true then only video with face will be saved. If face is not found in video then such video will not be saved

    Declaration

    Objective-C

    @property (nonatomic) BOOL saveOnlyFaceVideo;

    Swift

    var saveOnlyFaceVideo: Bool { get set }

  • If true then primary face functionality will be enabled, to be sure that the same person always in frame

    Declaration

    Objective-C

    @property (nonatomic) BOOL trackFaceIdentity;

    Swift

    var trackFaceIdentity: Bool { get set }

  • Enables check for occlusion of lower face by medical mask using MedicalMaskEstimator

    Declaration

    Objective-C

    @property (nonatomic) BOOL occludeCheck;

    Swift

    var occludeCheck: Bool { get set }

  • Enables check for occlusion of mouth using MouthOcclusionEstimator

    Declaration

    Objective-C

    @property (nonatomic) BOOL mouthCheck;

    Swift

    var mouthCheck: Bool { get set }

  • Enables check for occlusion of lower face using FaceOcclusionEstimator

    Declaration

    Objective-C

    @property (nonatomic) BOOL faceOcclusionEstimatorEnabled;

    Swift

    var faceOcclusionEstimatorEnabled: Bool { get set }

  • If true then alternative thresholds for sunglasses estimator will be applied

    Declaration

    Objective-C

    @property (nonatomic) BOOL advancedSunglasses;

    Swift

    var advancedSunglasses: Bool { get set }

  • Eye check adjustment. If the flag is set to false, this means that need to make sure that both eyes are open and frames only with all eyes open should be included in the bestshot.

    Declaration

    Objective-C

    @property (nonatomic) BOOL eyeInjury;

    Swift

    var eyeInjury: Bool { get set }

  • This property regulates delay before the face detection starts

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval startDelay;

    Swift

    var startDelay: TimeInterval { get set }

  • Number of seconds the face should stay in frame before any search of bestshots begin

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval faceTime;

    Swift

    var faceTime: TimeInterval { get set }

  • Quality of the image sent on the server. Value from 0 to 1. Value 0 is maximum compression, value 1 is no compression. 0.8 by default.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat compressionQuality;

    Swift

    var compressionQuality: CGFloat { get set }

  • Verification threshold of a document with a best shot. 0.7 by default. It is used in LunaExample demo application

    Declaration

    Objective-C

    @property (nonatomic) CGFloat documentVerificationMatch;

    Swift

    var documentVerificationMatch: CGFloat { get set }

  • Degree of match between faces in case trackFaceIdentity is set to true, 0.7 by default

    Declaration

    Objective-C

    @property (nonatomic) CGFloat primaryFaceMatching;

    Swift

    var primaryFaceMatching: CGFloat { get set }

  • plist-license file name which should be found in application bundle

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull plistLicenseFileName;

    Swift

    var plistLicenseFileName: String { get set }

  • Duration of video in seconds which will be saved, by default 5 seconds. If equal to zero then entire video session will be saved

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval videoRecordLength;

    Swift

    var videoRecordLength: TimeInterval { get set }

  • This timer fires at start of camera. And in case there will be no face found you will get error FACE_NOT_FOUND

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval emptyFrameTime;

    Swift

    var emptyFrameTime: TimeInterval { get set }

  • Current version of LunaID

    Declaration

    Swift

    @objc
public func lunaIDSDKVersion() -> String

    Return Value

    String representation of LunaID version number

  • Sha256 of LunaID string version

    Declaration

    Swift

    @objc
public func lunaIDSDKVersionData() -> Data

    Return Value

    Data of sha256

  • Current version of LunaID