Installation with Swift Package Manager
The following guide is compatible with the VE SDK v1.31.3 and newer. If you are looking for a way to install v1.31.2 or older with SPM, please, visit the legacy docs
Learn the SPM Getting Started Guide if you are new to SPM.
The integration of the VE SDK via SPM is demonstrated in the spm branch of our native sample.
Complete the following steps to get the Video Editor SDK dependencies using SPM:
- open
App projectand navigate to thePackage Dependenciestab; - for every package that needs to be installed click the
plusbutton and type its repo url; - choose
Exact Versionand type the newest SDK version.
Mandatory modules
The following modules must be installed in all cases:
| Package name | GitHub link |
|---|---|
| BanubaLicenseServicingSDK | https://github.com/Banuba/BanubaLicenseServicingSDK |
| BanubaSDKServicing-iOS | https://github.com/Banuba/BanubaSDKServicing-iOS |
| BanubaUtilities-iOS | https://github.com/Banuba/BanubaUtilities-iOS |
| BanubaVideoEditorSDK-iOS | https://github.com/Banuba/BanubaVideoEditorSDK-iOS |
| BNBLicenseUtils-iOS | https://github.com/Banuba/BNBLicenseUtils-iOS |
| VEEffectsSDK-iOS | https://github.com/Banuba/VEEffectsSDK-iOS |
| VEExportSDK-iOS | https://github.com/Banuba/VEExportSDK-iOS |
| VEPlaybackSDK-iOS | https://github.com/Banuba/VEPlaybackSDK-iOS |
| VideoEditor-iOS | https://github.com/Banuba/VideoEditor-iOS |
If you are not using the Face AR SDK together with the VE, you must add one additional module:
| Package name | GitHub link |
|---|---|
| BanubaSDKSimple-IOS | https://github.com/Banuba/BanubaSDKSimple-IOS |
Face AR interoperation modules
If your license includes the Face AR SDK, please, add the additional modules listed below:
| Package name | GitHub link |
|---|---|
| BanubaSDK-iOS | https://github.com/Banuba/BanubaSDK-iOS |
| BNBSdkCore | https://github.com/sdk-banuba/BNBSdkCore |
| BNBSdkApi | https://github.com/sdk-banuba/BNBSdkApi |
| BNBEffectPlayer | https://github.com/sdk-banuba/BNBEffectPlayer |
| BNBScripting | https://github.com/sdk-banuba/BNBScripting |
| BNBLips | https://github.com/sdk-banuba/BNBLips |
| BNBHair | https://github.com/sdk-banuba/BNBHair |
| BNBEyes | https://github.com/sdk-banuba/BNBEyes |
| BNBBackground | https://github.com/sdk-banuba/BNBBackground |
| BNBSkin | https://github.com/sdk-banuba/BNBSkin |
| BNBVisualClip | https://github.com/sdk-banuba/BNBVisualClip |
The Face AR packages (BNB***) hosted by the sdk-banuba account follow their own versioning. The following table specifies the mapping between the compatible VE and Face AR versions. Please, make sure that you specify the correct Face AR version, otherwise run-time incompatibilities may arise leading to crashes:
| Video Editor SDK versions | Compatible FaceAR SDK version |
|---|---|
| 1.39.0 | 1.16.1 |
| 1.38.1 | 1.15.2 |
| 1.38.0, 1.37.0, 1.36.6 | 1.14.2 |
| 1.36.2 | 1.14.1 |
| 1.36.0 | 1.14.0 |
| 1.35.1 | 1.12.0 |
| 1.35.0 | 1.11.1 |
| 1.34.1, 1.34.0, 1.33.3, 1.33.2, 1.33.1 | 1.10.1 |
| 1.33.0 | 1.9.3 |
| 1.32.2, 1.32.1, 1.32.0 | 1.9.1 |
If your license includes AR Cloud, please, also add the following package:
| Package name | GitHub link |
|---|---|
| BanubaARCloudSDK-IOS | https://github.com/Banuba/BanubaARCloudSDK-IOS |
Optional modules
You may skip the two modules listed below only if your app provides custom implementations of Audio Browser and Gallery. Otherwise make sure to add them to your project:
| Package name | GitHub link |
|---|---|
| BanubaVideoEditorGallerySDK | https://github.com/Banuba/BanubaVideoEditorGallerySDK |
| BanubaAudioBrowserSDK-iOS | https://github.com/Banuba/BanubaAudioBrowserSDK-iOS |