Skip to main content

Installation with Swift Package Manager

note

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:

  1. open App project and navigate to the Package Dependencies tab;
  2. for every package that needs to be installed click the plus button and type its repo url;
  3. choose Exact Version and type the newest SDK version.

Mandatory modules

The following modules must be installed in all cases:

Package nameGitHub link
BanubaLicenseServicingSDKhttps://github.com/Banuba/BanubaLicenseServicingSDK
BanubaSDKServicing-iOShttps://github.com/Banuba/BanubaSDKServicing-iOS
BanubaUtilities-iOShttps://github.com/Banuba/BanubaUtilities-iOS
BanubaVideoEditorSDK-iOShttps://github.com/Banuba/BanubaVideoEditorSDK-iOS
BNBLicenseUtils-iOShttps://github.com/Banuba/BNBLicenseUtils-iOS
VEEffectsSDK-iOShttps://github.com/Banuba/VEEffectsSDK-iOS
VEExportSDK-iOShttps://github.com/Banuba/VEExportSDK-iOS
VEPlaybackSDK-iOShttps://github.com/Banuba/VEPlaybackSDK-iOS
VideoEditor-iOShttps://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 nameGitHub link
BanubaSDKSimple-IOShttps://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 nameGitHub link
BanubaSDK-iOShttps://github.com/Banuba/BanubaSDK-iOS
BNBSdkCorehttps://github.com/sdk-banuba/BNBSdkCore
BNBSdkApihttps://github.com/sdk-banuba/BNBSdkApi
BNBEffectPlayerhttps://github.com/sdk-banuba/BNBEffectPlayer
BNBScriptinghttps://github.com/sdk-banuba/BNBScripting
BNBLipshttps://github.com/sdk-banuba/BNBLips
BNBHairhttps://github.com/sdk-banuba/BNBHair
BNBEyeshttps://github.com/sdk-banuba/BNBEyes
BNBBackgroundhttps://github.com/sdk-banuba/BNBBackground
BNBSkinhttps://github.com/sdk-banuba/BNBSkin
BNBVisualCliphttps://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 versionsCompatible FaceAR SDK version
1.36.21.14.1
1.36.01.14.0
1.35.11.12.0
1.35.01.11.1
1.34.1, 1.34.0, 1.33.3, 1.33.2, 1.33.11.10.1
1.33.01.9.3
1.32.2, 1.32.1, 1.32.01.9.1

If your license includes AR Cloud, please, also add the following package:

Package nameGitHub link
BanubaARCloudSDK-IOShttps://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 nameGitHub link
BanubaVideoEditorGallerySDKhttps://github.com/Banuba/BanubaVideoEditorGallerySDK
BanubaAudioBrowserSDK-iOShttps://github.com/Banuba/BanubaAudioBrowserSDK-iOS