App size optimization

Reducing the app size is of great significance in improving user experience. A smaller package size means that users consume less bandwidth and time to download the app. Consider the following use-cases where app size optimization is critical:

• There are strict requirements on the size of the app. For example, running the app on smart wearable devices with limited storage space.

• The target user group of the app is located in underdeveloped areas. The poor network connectivity causes the app download time to be too long.

This page shows you how to optimize the size of apps with integrated Video SDK.

Use the Lite SDK

Since version 4.4.0, Agora offers a Lite SDK that provides basic audio and video call functions in a smaller package size. If you only need to implement basic audio and video call functions, integrate the Lite SDK. For details see SDKs.

The Lite SDK includes only the following extensions:

• Video encoding extension
• Video decoding extension

Other extensions and related functions in the Extension list are not supported.

Use the Voice SDK

Video SDK supports both audio and video functions, and the package size is large. If you only need to use audio features, best practice is to integrate the Voice SDK. For details, see Voice SDK Quickstart.

Remove unnecessary extensions

Video SDK provides optional extension dynamic libraries. The name of the extension is suffixed with extension. See the extension list for details on the function and size of the extensions. Refer to the following ways to exclude these extensions to reduce the size of the app.

Delete extensions when integrating using CocoaPods

When integrating the iOS or macOS SDK through CocoaPods, use the subspecs field in the Podfile to specify the dynamic libraries you need to integrate. This excludes extensions you do not need. For details about the corresponding relationship between dynamic libraries and subspecs field, see subspecs field.

Refer to the following samples to use all, none, or some extensions:

Use all extensions

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

Don

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

Use some extensions

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

Reference

This section contains content that completes the information in this page, or points you to documentation that explains other aspects to this product.

Extension list

Refer to the following information for an introduction to each Video SDK extension and the increase in the size of your app after integration.

Integrating extensions into your project

When integrating the iOS/macOS SDK through CocoaPods, you can use the subspecs field in the Podfile to specify the dynamic libraries you need to integrate to exclude the extensions you don't need to use. The correspondence between dynamic libraries and subspecs fields is detailed in the following table:

iOS Video SDK

iOS Voice SDK

Frequently asked questions

• Why are dynamic libraries preferred over static libraries in the Video SDK