Reduce the App Size

This page describes how to reduce the app size after integrating the Agora RTC Native SDK.

Use the Voice SDK

The Video SDK supports both audio and video functions, so the package size is larger. If you only need to use the audio functions, Agora recommends integrating the Voice SDK.

Remove unnecessary extension libraries

As of v3.3.0, the SDK provides extension libraries, which are dynamic libraries that can be optionally integrated into a project. Extension libraries are named with the extension suffix, and information on the functionality and size of extension libraries is provided in Extension libraries. If you do not need to use the functions provided by some extension libraries, you can reduce the size of the app by not integrating these extension libraries as described in the following sections.

Remove extension libraries during manual integration

When you integrate the SDK by using the SDK download link on the official website, you can directly remove the unnecessary extension library files.

Remove extension libraries when using CocoaPods

This method applies to iOS/macOS SDKs v3.6.2 and later.

When you integrate the iOS/macOS SDK with CocoaPods, you can reduce the size of your app after integrating the SDK by using the subspecs field in the Podfile to specify the desired dynamic libraries and exclude unnecessary extension libraries. See The subspecs fields for details on how dynamic libraries correspond to the subspecs fields.

Sample code

Example 1: When you integrate the iOS Video SDK v3.6.2 and use all extension libraries, the Podfile is as follows:

# platform :ios, '9.0'
target 'Your App' do
    pod 'AgoraRtcEngine_iOS', '3.6.2'
end

Example 2: When you integrate the iOS Video SDK v3.6.2 without any extension libraries, the Podfile is as follows:

# platform :ios, '9.0'
target 'Your App' do
    pod 'AgoraRtcEngine_iOS', '3.6.2', :subspecs => ['RtcBasic']
end

Example 3: When you integrate the iOS Video SDK v3.6.2 and use only the deep-learning noise reduction and super resolution extension libraries, the Podfile is as follows:

# platform :ios, '9.0'
target 'Your App' do
    pod 'AgoraRtcEngine_iOS', '3.6.2', :subspecs => ['RtcBasic', 'AINS', 'SuperResolution']
end

When you fill in the pod command, make sure that the SDK with the specified version has the extension library that you specify and that the subspecs field of the extension library is correct; otherwise, an error is reported when you enter pod install. For example, if you fill in pod 'AgoraRtcEngine_iOS', '3.6.2', :subspecs => ['RtcBasic', 'AgoraRtcAINS'], an error is reported when you enter pod install.

Remove extension libraries when using Maven Central

This method applies to Android SDKs v3.6.2 and later.

When you integrate the Android SDK with Maven Central, you can reduce the size of your app after integrating the SDK by modifying the implementation field in dependencies in the /Gradle Scripts/build.gradle(Module: <projectname>.app) file to specify the desired dynamic libraries and exclude unnecessary extension libraries. See The implementation fields for details on how each file in the Android SDK corresponds to the implementation field.

Sample code

Example 1: When you integrate the Android Video SDK v3.6.2 and use all extension libraries, dependencies is as follows:

dependencies {
 implementation 'io.agora.rtc:full-sdk:3.6.2'
 ...
}

Example 2: When you integrate the Android Video SDK v3.6.2 without any extension libraries, dependencies is as follows:

dependencies {
 implementation 'io.agora.rtc:full-rtc-basic:3.6.2'
 ...
}

Example 3: When you integrate the Android Video SDK v3.6.2 and use only the deep-learning noise reduction and super resolution extension libraries, dependencies is as follows:

dependencies {
 def agora_sdk_version = "3.6.2"
 // The following code contains $, so you must use "", not ''
 implementation "io.agora.rtc:full-rtc-basic:${agora_sdk_version}"
 implementation "io.agora.rtc:full-ains:${agora_sdk_version}"
 implementation "io.agora.rtc:full-super-resolution:${agora_sdk_version}"
 ...
}

Load .so files dynamically

This method applies to Android SDKs v3.6.2 and later.

This method applies to manual integration of the SDK only; it does not apply to integrations using Maven Central or JitPack.

Normally, you need to package required .so files when compiling the app, and the SDK loads .so files from the app's nativeLibraryPath.

As of v3.6.2, the SDK provides the setAgoraLibPath method, which enables the app to dynamically load required .so files from its private directory when the app runs. This can reduce the app package size. Refer to the following steps to implement this function:

Go to SDK Downloads, download the latest version of the Agora Voice or Video SDK, and extract the files from the downloaded SDK package.
Integrate agora-rtc-sdk.jar into your project.
Upload the .so files for all architectures to your server, and ensure your app can download the .so files for its target architecture over the network.
The app checks if the .so files for its target architecture exist when running. If not, the app downloads the appropriate .so files over the network and saves them to the app's private directory.
Call setAgoraLibPath, and set path as the app's private directory where the .so files are stored.
When calling create to initialize an RtcEngine instance, the SDK automatically loads the .so files according to the specified path.

Reference

This section provides reference information for reducing the size of the app after integrating the SDK.

Extension libraries

The SDK provides extension libraries, which are dynamic libraries that can be optionally integrated into a project. Extension libraries are named with the extension suffix, and information on the functionality and size of extension libraries is provided in the following tables.

If you are using a version of the macOS SDK earlier than v3.6.2, extension libraries have the framework suffix, not xcframework as in the following tables. See v3.6.2 Release Notes.

Currently, the JND library, virtual background library, and super resolution library are only available on Android for the arm64-v8a and armeabi-v7a architectures; they are not available on Android for the x86 or x86_64 architectures.

Deep-learning noise reduction library

The SDK enables traditional noise reduction by default to reduce most of the stationary background noise. Deep-learning noise reduction adds non-stationary background noise reduction based on the traditional noise reduction. After integrating the deep-learning noise reduction library, you can call enableDeepLearningDenoise to enable the deep-learning noise reduction. See v3.3.0 Release Notes.