App size optimization
Updated
Reduce the size of apps that integrate Agora SDK
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.
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_macOS', '4.3.1'
endDon
# platform :ios, '9.0'
target 'Your App' do
pod 'AgoraRtcEngine_macOS', '4.3.1', :subspecs => ['RtcBasic']
endUse some extensions
# platform :ios, '9.0'
target 'Your App' do
pod 'AgoraRtcEngine_macOS', '4.3.1', :subspecs => ['RtcBasic', 'AINS', 'AudioBeauty']
endWhen using the above pod command, make sure that the SDK version you specify includes the extension you have selected, and that the subspecs field is correct, otherwise a pod installation error is reported. For example, if you use pod 'AgoraRtcEngine_iOS', '4.0.0', :subspecs => ['RtcBasic', 'AgoraRtcAINS'], an error is reported.
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.
The information in this section is based on version 4.4.0 of the Video SDK.
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:
| Dynamic Library | Category | subspecs field |
|---|---|---|
| Required | RtcBasic |
AgoraAiNoiseSuppressionExtension.xcframework | Optional | AINS |
AgoraAiNoiseSuppressionLLExtension.xcframework | Optional | AINSLL (≥ v4.4.0) |
AgoraAudioBeautyExtension.xcframework | Optional | AudioBeauty |
AgoraClearVisionExtension.xcframework | Optional | ClearVision |
AgoraContentInspectExtension.xcframework | Optional | ContentInspect |
AgoraPvcExtension.xcframework | Optional | PVC (< v4.1.0) |
AgoraSpatialAudioExtension.xcframework | Optional | SpatialAudio |
AgoraVideoSegmentationExtension.xcframework | Optional | VirtualBackground |
AgoraAiEchoCancellationExtension.xcframework | Optional | AIAEC (≥ v4.1.0) |
AgoraAiEchoCancellationLLExtension.xcframework | Optional | AIAECLL (≥ v4.4.0) |
AgoraDrmLoaderExtension.xcframework | Optional | DRM (≥ v4.1.0) |
AgoraFaceDetectionExtension.xcframework | Optional | FaceDetection (≥ v4.1.1) |
AgoraFaceCaptureExtension.xcframework | Optional | FaceCapture (≥ v4.3.0) |
AgoraVideoQualityAnalyzerExtension.xcframework | Optional | VQA (≥ v4.1.0) |
AgoraScreenCaptureExtension.xcframework | Optional | ScreenCapture (≥ v4.2.0) |
| Optional | VideoCodecEnc (≥ v4.2.0) |
| Optional | VideoCodecDec (v4.2.0 to v4.6.1) |
AgoraVideoAv1EncoderExtension.xcframework | Optional | VideoAv1CodecEnc (≥ v4.3.0) |
AgoraVideoAv1DecoderExtension.xcframework | Optional | VideoAv1CodecDec (v4.3.0 to v4.6.1) |
AgoraLipSyncExtension.xcframework | Optional | LipSync (≥ v4.3.1) |
