Upgrade Guide for Version 3.0.0 and Above

2023-09-25

Warning

If your current SDK is lower than version 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 check the change notes between the two versions in the Release Notes based on your current version number and target upgrade version number, and check your business-related interfaces.

This article will introduce the instructions and precautions for upgrading the Express Flutter SDK to version 3.0.0 and above.

Deprecation Notes

Deprecated the [General], [Communication], and [Live] scenarios in the ZegoScenario scenario enumeration. For details, please refer to the Scenario-based Audio and Video Configuration document for adaptation.
Starting from this version, Express iOS SDK no longer supports bitcode.

Please refer to the description about deprecating bitcode in Apple Xcode 14 Release Notes.

Adaptation 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" in ZegoEngineConfig > advancedConfig. Please use the setAudioDeviceMode interface instead.

The following interfaces that were deprecated in previous versions have been removed.

Method Name	Description
setDebugVerbose	Set debug verbose information switch and language. This function was deprecated in version 2.3.0. Please use enableDebugAssistant to implement the original functionality.
loginMultiRoom	Login 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 multi-room mode before initializing the engine, then use loginRoom to log in to multiple rooms. If calling the loginRoom function to log in to multiple rooms, please ensure that the same user information is passed in.
setPlayStreamVideoLayer	Set the selected video layer for playing streams. This function was deprecated after version 2.3.0. Please use setPlayStreamVideoType instead.
enableAudioDataCallback	Enable callback for receiving additional audio data. This function was deprecated after version 2.7.0. Please use startAudioDataObserver and stopAudioDataObserver instead.
setReverbParam	Set specific reverb parameters. 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.
onDeviceError	Device exception notification. This function was deprecated in version 2.15.0 and above. Please use onLocalDeviceExceptionOccurred instead.