API Sunset Notice
This page introduces the deprecated and deleted APIs in the SDK.
Deprecated APIs
The deprecated APIs are expected to be officially deleted in approximately one year. Agora recommends that you promptly replace them with the recommended APIs to avoid any impact on your online services.
| API | Description | Alternative API | Deprecated version |
|---|---|---|---|
| enableDualStreamMode [1/2] | Enables or disables dual-stream mode on the sender side. | setDualStreamMode [1/2] | v4.2.0 |
| enableDualStreamMode [2/2] | Sets the dual-stream mode on the sender side and the low-quality video stream. | setDualStreamMode [2/2] | v4.2.0 |
| enableDualStreamModeEx | Enables or disables dual-stream mode on the sender side. | setDualStreamModeEx | v4.2.0 |
| enableWebSdkInteroperability | Enables interoperability with the Agora Web SDK (applicable only in the live streaming scenarios). | - | v4.0.0 |
| setExternalAudioSource | Sets the external audio source parameters. | createCustomAudioTrack | v4.0.0 |
| createDataStreamEx [1/2] | Creates a data stream. | createDataStreamEx [2/2] | v4.0.0 |
| setLocalVideoMirrorMode | Sets the local video mirror mode. | setupLocalVideo or setLocalRenderMode [2/2] | v4.0.0 |
| startScreenCaptureByScreenRect | Captures the whole or part of a screen by specifying the screen rect. | startScreenCaptureByDisplayId | v4.0.0 |
| setLocalRenderMode [1/2] | Sets the local video display mode. | setLocalRenderMode [2/2] | v4.0.0 |
| setLogFileSize | Sets the log file size. | Use the context parameter in initialize. | v4.0.0 |
| setLogFilter | Sets the log output level of the SDK. | Use the context parameter in initialize. | v4.0.0 |
| setLogFile | Sets the log file. | Use the context parameter in initialize. | v4.0.0 |
| setLogLevel | Sets the output log level of the SDK. | Use the context parameter in initialize. | v4.0.0 |
| setAudioProfile [1/2] | Sets the audio profile and audio scenario. | setAudioProfile [2/2] or setAudioScenario | v4.0.0 |
| startAudioMixing [1/2] | Starts playing the music file. | startAudioMixing [2/2] | v4.0.0 |
| v4.0.0 | |||
| addVideoWatermark [1/2] | Adds a watermark image to the local video. | addVideoWatermark [2/2] | v4.0.0 |
| onAudioMixingFinished | Occurs when the playback of the local music file finishes. | onAudioMixingStateChanged | v4.0.0 |
| onAudioQuality | Reports the statistics of the audio stream sent by each remote user. | onRemoteAudioStats | v4.0.0 |
| onConnectionBanned | Occurs when the connection is banned by the Agora server. | onConnectionStateChanged | v4.0.0 |
| onConnectionInterrupted | Occurs when the connection between the SDK and the server is interrupted. | onConnectionStateChanged | v4.0.0 |
| onFirstRemoteAudioFrame | Occurs when the SDK receives the first audio frame from a specific remote user. | onRemoteAudioStateChanged | v4.0.0 |
| onFirstRemoteAudioDecoded | Occurs when the SDK decodes the first remote audio frame for playback. | onRemoteAudioStateChanged | v4.0.0 |
| onRemoteAudioTransportStats | Reports the transport-layer statistics of each remote audio stream. | onRemoteAudioStats | v4.0.0 |
| onRemoteVideoTransportStats | Reports the transport-layer statistics of each remote video stream. | onRemoteVideoStats | v4.0.0 |
| onUserEnableLocalVideo | Occurs when a specific remote user enables/disables the local video capturing function. | onRemoteVideoStateChanged | v4.0.0 |
| onVideoStopped | Occurs when the video stops playing. | onLocalVideoStateChanged | v4.0.0 |
Deleted APIs
The APIs have been deleted from the SDK. Use the recommended alternative APIs to implement the related functionality.
| API | Description | Alternative API | Deleted version |
|---|---|---|---|
| openWithCustomSource | Opens the custom media resource file. | openWithMediaSource | v4.4.0 |
| startEchoTest() | Starts an audio call test. | startEchoTest | v4.4.0 |
| startEchoTest(intervalInSeconds) | Starts an audio call test. | startEchoTest | v4.4.0 |
| setEncryptionMode | Sets the built-in encryption mode. | enableEncryption | v4.4.0 |
| setEncryptionSecret | Enables built-in encryption with an encryption password before users join a channel. | enableEncryption | v4.4.0 |
| onExtensionEvent | The event callback of the extension. | onExtensionEventWithContext | v4.4.0 |
| onExtensionStarted | Occurs when the extension is enabled. | onExtensionStartedWithContext | v4.4.0 |
| onExtensionStopped | Occurs when the extension is disabled. | onExtensionStoppedWithContext | v4.4.0 |
| onExtensionError | Occurs when the extension runs incorrectly. | onExtensionErrorWithContext | v4.4.0 |