ios

CocoaPods

CocoaPods packages

To start using Banuba SDK with CocoaPods, add a custom repository and desired packages to your Podfile:

Podfile

loading...

Then install pods:

pod install --repo-update

See banuba-sdk-podspecs repo for the list of all available packages and versions.

The complete example, configured for CocoaPods usage, can be found in our Objective-C quickstart example.

Swift Package Manager

SPM packages

Banuba SDK provides Swift Package Manager packages in the custom repositories.

Add Banuba SDK packages, to your Xcode project:

1. File > Add Package Dependencies...
2. Search for the package, for example https://github.com/sdk-banuba/BNBSdkApi
3. Press the Add Package button. After verifying the package, press Add Package again.

See the sdk-banuba repositories for the list of all available packages and versions.

The complete example, configured for SPM usage, can be found in our Beauty-iOS quickstart example.

How to choose required packages

warning

Only use the packages with the same version! Packages with different versions (even minor) may conflict or work incorrectly with each other.

tip

If feature or effect works incorrect, see application logs, to figure out which package is missed.

Add packages depends on the specific features or effects, which your app will use. It is your responsibility to include everything required for the desired behaviour.
See detailed packages description in the table below.

Example of the packages set for Face Tracking and Background Separation:

• BNBSdkApi
• BNBFaceTracker
• BNBBackground

See detailed packages description in the table below.

List of all available packages

Package name	Description
BNBSdkApi	platform-specific API, like Player, Input, Output, etc
BNBSdkCore	provides the functionality of the native EffectPlayer.
BNBEffectPlayer	contains the necessary shaders, used by sdk_core package and provides the following features: math utilities, texture utilities, morphing, beautification, etc.
BNBScripting	includes the basic functionality used by the effect api, see Effects.
BNBFaceTracker	package consists of neural network models used to track face and its features: lips, eyes, etc. Include it whenever you deal with tracking. See more about Face Tracking.
BNBLips	provides neural network models for lips segmentation. See more about Lips Segmentation.
BNBHair	provides neural network models for hair segmentation. See more about Hair Segmentation.
BNBHands	provides neural network models for hand, nail, and finger segmentation.
BNBOcclusion	provides the occlusion neural network. It is used to detect face collisions with different objects in the screen.
BNBEyes	provides neural network models for eyes segmentation. See more about Eye Segmentation.
BNBSkin	provides neural network models for skin segmentation. See more about Skin Segmentation.
BNBBackground	provides neural network models for background separation. See more about Background Separation.
BNBBody	provides neural network model to recognize the human body in full and separate it from the background in images and videos.
BNBAcneEyebagsRemoval	provides neural network models for acne removal and eye bag removal.
BNBNeck	provides neural network models for neck segmentation.
BNBResources	includes all the resources of the all packages. Use it when you don't care about the size or you need all the features!
BNBPoseEstimation	private
BanubaSdk	depends on the all the packages for the operation of all available features. Use it when you don't care about the size or you need all the features!