CocoaPods trunk is moving to be read-only. Read more on the blog, there are 17 months to go.

Faceguard 1.0.2

Faceguard 1.0.2

×

Maintained by Bureau-Inc.

Faceguard 1.0.2

  • By
  • BureauID

Quick Start

Step 1 - Add Dependency

  1. SDK is available through CocoaPods. To install it, simply add the following line to your Podfile:
# Podfile
pod 'Faceguard'

#Add below lines to end of your pod file
post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      if target.name == "Sentry" || target.name == "SwiftProtobuf" then
        config.build_settings["BUILD_LIBRARY_FOR_DISTRIBUTION"] = 'YES'
      end
    end
  end
end

Step 2 - Initialise SDK

The SDK is initialized in the client app.

let config = FaceguardConfiguration(credentialId: <<CREDENTIAL-ID>>, basicAuthKey: <<BASICAUTHKEY>>, cypherKey: <<CYPHER-KEY>>, userId: <<USER-ID>>, environment: <<ENVIRONMENT>>, thresholdConfig: <<THRESHOLD-OBJ>>, theme: <<THEME-OBJ>>, servicesConfiguration: <<ServicesConfiguratio>>)

// Init SDK
let faceguardSDK = FaceguardSDK.initialize(with configuration: Faceguard.FaceguardConfiguration, delegate: Faceguard.FaceguardDelegate) -> Faceguard.FaceguardSDK?


//Create helper congiguration objects
<<THRESHOLD-OBJ>>
let thresholdConfig = FaceguardThresholdConfig(hijab: Double, mask: Double, headgear: Double, clothing: Double, glasses: Double, skinOrChest: Double)

values of hijab, mask, headgear, clothing, glasses & skinOrChest would be between 0-1


<<THEME-OBJ>>
let theme = FaceguardTheme(primaryTextColor: <<CUSTOM-PRIMARY-COLOER>>, secondaryTextColor: <<CUSTOM-PRIMARY-COLOER>>, primaryBackgroundColor: <<CUSTOM-BG-COLOER>>, fontName: <<CUSTOM-FONT-NAME>>)


<<ServicesConfiguratio>>
let serviceConfig = FaceguardServicesConfiguration(retryEnabled: Bool, statusScreenRequired: Bool, enableFaceMatch: Bool, enableFaceAnalyser: Bool, enableFaceDedupe: Bool, enableFaceEntityEnrollment: Bool, imageURL: String?)

Step 3 - Start the faceguard process

faceguardSDK.start(from: self)

Response returned from the SDK

To get the response from liveness you need to confirm to 'FaceguardDelegate'. ex-

extension ViewController: FaceguardDelegate {
    func faceguardProcessDidCompleteWith(success: Bool, error: Faceguard.NetworkError?, image: UIImage?, faceguardResponse: FaceguardResponse?) {
        //Handle the result here
   }
}