Skip to main content

The usage of the Banuba SDK resources externally on IOS

The usage of the Banuba SDK resources externally​

By default, the SDK contains all the needed resources as a part of BanubaEffectPlayer.xcframework. But there is an option to use the Banuba SDK resources externally, in other words, separate the resources from the application. They can be external packages or downloaded resources. This allows you to reduce the size of your application.

You can request a special build of the SDK with already separated resources or you can extraсt them manually.

To extract resources manually you should find the folder bnb-resources here: BanubaEffectPlayer/bin/BanubaEffectPlayer.xcframework/ios-arm64/BanubaEffectPlayer.framework. Make a backup of the folder to use it later and delete the folder in the BanubaEffectPlayer.framework.

note

Inside BanubaEffectPlayer.xcframework you can find folders for several platforms, for example ios-arm64 and ios-arm64_x86_64-simulator. Each platform folder contains its own copy of the bnb-resources folder. In order to reduce the size of your application you should remove the resources folder for every platform.

To use external resources, please follow the steps below:

  1. Copy resource packages to application resources or implement the logic to download resources online during the application execution.

  2. Update the path to the resources that you will pass into the initialization of the BanubaSdkManager image

or the BNBUtilityManager. image

  1. Update Copy Bundle Resources section in the Xcode settings of your project to copy resources to application package if package is integrated as a part of application.
note

If you want to use both repacking and external resources, you should first repack the SDK and only then extract resources.

note

You should take care to check the resources version while using external resources.