iOS
This is an iOS-specific Face SDK installation guide. Before proceeding further, make sure you've read the Installation page and have selected the Core type to install.
Requirements
- The latest stable version of Xcode
- The minimum target is iOS 11.0
Installation
CocoaPods
To add the Face SDK using CocoaPods, include the following lines in your Podfile file:
pod 'FaceSDK'
pod 'FaceCoreBasic'
pod 'FaceSDK'
pod 'FaceCoreMatch'
And then run:
pod install
Swift Package Manager (SPM)
Swift Package Collection
Swift Package Collection is a set of all Regula products in one place.
To add Regula Swift Package Collection to your project, run the following command in Terminal:
swift package-collection add https://pods.regulaforensics.com/SPM/PodsCollection-signed.json
or in Xcode:
1. Naviate to File > Add Package Dependencies.
2. In the prompt that appears, click plus.
3. Select Add Package Collection.
4. In the prompt that appears, enter the collection URL:
https://pods.regulaforensics.com/SPM/PodsCollection-signed.json
5. Click Load and then Add Collection.
6. Select the package you want to add.
7. Select the version you want to use. For new projects, we recommend using the newest version.
8. Select the project you want to add the package.
9. Click Add Package.
Once you're finished, Xcode will begin downloading and resolving dependencies.
Add Packages Separately
You can add each package individually instead of using the collection. To do so, follow these steps:
1. In Xcode, naviate to File > Add Package Dependencies.
2. In the prompt that appears, enter the API package URL:
https://github.com/regulaforensics/FaceSDK-Swift-Package
3. Select the version you want to use. For new projects, we recommend using the newest version.
4. Select the project you want to add the package.
5. Click Add Package.
6. Now add the Core package of interest by performing steps 2-5 again for the following URL:
https://github.com/regulaforensics/FaceCoreBasic-Swift-Package
https://github.com/regulaforensics/FaceCoreMatch-Swift-Package
Once you're finished, Xcode will begin downloading and resolving dependencies.
Migration from CocoaPods to SPM
If migrating from a CocoaPods-based project, run pod deintegrate to remove CocoaPods from your Xcode project. The CocoaPods-generated .xcworkspace file can safely be deleted afterward.
If you're adding the Face SDK Swift Packages to a project for the first time, ignore this notice.
Manual Integration
1. Download the latest API framework.
2. Download the latest Common framework.
3. Get the latest Core version:
4. Build and run the project.