Upgrade Guide for Version 3.0.0 and Above
- If your current SDK version is lower than 3.0.0 and you need to upgrade to any SDK version 3.0.0 or above, please be sure to read this article.
- In addition, it is recommended that you refer to the change notes between the two versions in the Release Notes based on your current version number and target upgrade version number, and check the interfaces related to your business.
This article will introduce the instructions and precautions for upgrading Express SDK to version 3.0.0 and above.
Deprecation Notes
-
Deprecated the three scenarios
General,Communication, andLivein the ZegoScenario scenario enumeration. Please refer to the Scenario-based Audio and Video Configuration document for adaptation. -
Starting from version 3.0.0, Express iOS SDK no longer supports bitcode. For details, please refer to the instructions about deprecating bitcode in the Xcode 14 Release Notes.
NoteAdaptation method: Open the configuration page of the Xcode project, find the "Enable Bitcode" option in the "Build Settings" page of the App Target, and set it to "No".
-
Deprecated the configuration item "audio_device_mode" of ZegoEngineConfig > advancedConfig. Please use the setAudioDeviceMode interface instead.
Removal Notes
The following interfaces that were deprecated in previous versions have been removed.
| Method Name | Description |
|---|---|
| setDebugVerbose | Sets the debug verbose switch and language. This function was deprecated in version 2.3.0. Please use enableDebugAssistant to implement the original functionality. |
| loginMultiRoom | Logs in to multiple rooms. This method was deprecated after version 2.9.0. If you need to implement multi-room functionality, please call the setRoomMode function to set the multi-room mode before initializing the engine, and then use loginRoom to log in to multiple rooms. If you call the loginRoom function to log in to multiple rooms, please ensure that the same user information is passed in. |
| setPlayStreamVideoLayer | Sets the selection of playing stream video layers. This function was deprecated after version 2.3.0. Please use setPlayStreamVideoType instead. |
| enableAudioDataCallback | Enables callback for additionally receiving audio data. This function was deprecated after version 2.7.0. Please use startAudioDataObserver and stopAudioDataObserver instead. |
| setReverbParam | Sets the specific parameters of reverb. This function was deprecated after version 1.18.0. Please use setReverbPreset or setReverbAdvancedParam instead. |
| setBuiltInSpeakerOn | Whether to use the built-in speaker to play sound. This function was deprecated after version 2.3.0. Please use setAudioRouteToSpeaker instead. |
| onRoomStreamUpdate | Notification of increase or decrease of streams published by other users in the same Room. This callback function has been deprecated since 1.18.0. Please use the onRoomStreamUpdate function with the [extendedData] parameter. |
| onDeviceError | Device exception notification. This function was deprecated in version 2.15.0 and 3.0.0 and above. Please use onLocalDeviceExceptionOccurred instead. |
| onNetworkQuality | Reports the network quality of streams in the Room. This callback function was deprecated in version 2.10.0 and 3.0.0 and above. Please use the onNetworkQuality function with the ZegoStreamQualityLevel enumeration parameter. |
| onProcessCapturedAudioData | Custom audio processing callback for locally captured PCM audio frames. This callback function was deprecated in version 2.13.0 and 3.0.0 and above. Please use the onProcessCapturedAudioData function with the [timestamp] parameter. |
| onProcessRemoteAudioData | Custom audio processing callback for remotely played stream PCM audio frames. This callback function was deprecated in version 2.13.0 and 3.0.0 and above. Please use the onProcessRemoteAudioData function with the [timestamp] parameter. |
| onProcessPlaybackAudioData | Custom audio processing callback for SDK playing PCM audio frames. This callback function was deprecated in version 2.13.0 and 3.0.0 and above. Please use the onProcessPlaybackAudioData function with the [timestamp] parameter. |
Change Example Code
You can refer to the following example code for interface changes.