Integrate the ZIM Audio SDK
This topic describes how to integrate the ZIM Audio SDK.
Prerequisites
Before you integrate the ZIM Audio SDK, make sure that the following conditions are met:
- Development environment:
- Xcode 13 or later is installed.
- The iOS system is in version 11.0 or later and supports real iOS devices with the audio feature.
Import the ZIM Audio SDK
You can integrate the ZIM Audio SDK by using the following method.
Copy the ZIM Audio SDK file for manual integration
- Download the ZIM Audio SDK of the latest version. For more information, see SDK downloads.
- Decompress the ZIM Audio SDK to the project directory, for example, the "libs" folder.
- Select your project under TARGETS. Then, choose General > Frameworks, Libraries, and Embedded Content, add the
ZIMAudio.xcframeworkfile, and set Embed to Embed & Sign.
Grant permission
The ZIM Audio SDK requires the microphone permission to collect audio data.
- In Xcode, select your project under TARGETS. Then, choose Info > Custom iOS Target Properties.
- Click the plus icon (+) and select
Privacy - Microphone Usage Descriptionto grant the microphone permission.
FAQ
Due to the configuration inconsistency between Express SDK and ZIM Audio SDK, the audio session on iOS is repeatedly modified, resulting in abnormal phenomena.
To solve this problem, you need to call setAdvancedConfigWithKey of ZIM Audio SDK to align the audio_session_mix_with_others、audio_session_do_nothing configuration items with the Express SDK.
If the Express SDK sets the bluetooth_capture_only_voip configuration item, the bluetooth_capture_only_voip configuration item of ZIM Audio SDK also needs to be aligned with the Express SDK.