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 |
|---|---|---|---|
| setDirectCdnStreamingAudioConfiguration | Sets the audio configuration for audio streams directly pushed to the CDN by the host. | Use Media Push instead. | v4.6.0 |
| setDirectCdnStreamingVideoConfiguration | Sets the video properties for streams directly pushed to the CDN by the host. | Use Media Push instead. | v4.6.0 |
| startDirectCdnStreaming | Starts pushing media streams directly to the CDN. | Use Media Push instead. | v4.6.0 |
| stopDirectCdnStreaming | Stops pushing streams to the CDN. | Use Media Push instead. | v4.6.0 |
| Use Media Push instead. | v4.6.0 | ||
| DirectCdnStreamingMediaOptions | Used to configure media streaming options. | Use Media Push instead. | v4.6.0 |
| DirectCdnStreamingStats | Used to retrieve the current CDN streaming statistics. | Use Media Push instead. | v4.6.0 |
| Use Media Push instead. | v4.6.0 | ||
| Use Media Push instead. | v4.6.0 | ||
| addVideoWatermarkEx [1/2] | Adds a watermark image to the local video. | Use addVideoWatermarkEx [2/2] instead. | v4.6.0 |
| 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 and low-quality stream on the sender side. | setDualStreamMode [2/2] | v4.2.0 |
| enableDualStreamModeEx | Enables or disables video streams with different quality levels on the sender side. | setDualStreamModeEx | v4.2.0 |
| enableWebSdkInteroperability | Enables interoperability with the Agora Web SDK (for Live Streaming only). | - | v4.0.0 |
| v4.0.0 | |||
| createDataStreamEx [1/2] | Creates a data stream. | createDataStreamEx [2/2] | v4.0.0 |
| setLocalVideoMirrorMode | Sets the mirror mode of the local video. | setupLocalVideo or setLocalRenderMode [2/2] | v4.0.0 |
| startScreenCaptureByScreenRect | Captures the entire screen or a portion of it by specifying a screen region. | startScreenCaptureByDisplayId | v4.0.0 |
| setLocalRenderMode [1/2] | Updates the display mode of the local video view. | setLocalRenderMode [2/2] | v4.0.0 |
| setLogFileSize | Sets the log file size. | Use the context parameter in initialize. | v4.0.0 |
| setLogFilter | Sets the SDK log output level. | Use the context parameter in initialize. | v4.0.0 |
| setLogFile | Sets the SDK log output file path. | Use the context parameter in initialize. | v4.0.0 |
| setLogLevel | Sets the SDK log level. | Use the context parameter in initialize. | v4.0.0 |
| setAudioProfile [1/2] | Sets the audio profile and scenario. | setAudioProfile [2/2] or setAudioScenario | v4.0.0 |
| startAudioMixing [1/2] | Starts playing a music file. | startAudioMixing [2/2] | v4.0.0 |
| preload [1/2] | Preloads music resources. | preload [2/2] | v4.0.0 |
| addVideoWatermark [1/3] | Adds a PNG format watermark image to the local video stream. | addVideoWatermark [2/3] | v4.0.0 |
| onAudioMixingFinished | Callback triggered when the local music file finishes playing. | onAudioMixingStateChanged | v4.0.0 |
| onAudioQuality | Reports statistics of audio streams sent by each remote user. | onRemoteAudioStats | v4.0.0 |
| onConnectionBanned | Callback triggered when the connection is banned by the Agora server. | onConnectionStateChanged | v4.0.0 |
| onConnectionInterrupted | onConnectionInterrupted callback. | onConnectionStateChanged | v4.0.0 |
| onFirstRemoteAudioFrame | Callback when the first audio frame from a remote user arrives. | onRemoteAudioStateChanged | v4.0.0 |
| onFirstRemoteAudioDecoded | Callback when the first remote audio frame is decoded. | onRemoteAudioStateChanged | v4.0.0 |
| onRemoteAudioTransportStats | Callback to report transport layer statistics for each remote audio stream. | onRemoteAudioStats | v4.0.0 |
| onRemoteVideoTransportStats | Reports transport-layer statistics of each remote video stream. | onRemoteVideoStats | v4.0.0 |
| onUserEnableLocalVideo | Callback when a remote user enables or disables local video capture. | onRemoteVideoStateChanged | v4.0.0 |
| onVideoStopped | Callback triggered 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 |
|---|---|---|---|
| setLocalPublishFallbackOption | Sets the fallback option for the published video stream based on the network conditions. | - | v4.6.0 |
| onLocalPublishFallbackToAudioOnly | Occurs when the published media stream falls back to an audio-only stream. | - | v4.6.0 |
| onDownlinkNetworkInfoUpdated | Occurs when the downlink network information changes. | - | v4.6.0 |
| enableWirelessAccelerate | Enables or disable Wi-Fi acceleration. | - | v4.6.0 |
| onWlAccStats | Report on Wi-Fi acceleration effect. | - | v4.6.0 |
| onWlAccMessage | Report on Wi-Fi acceleration effect. | - | v4.6.0 |
| WLACC_MESSAGE_REASON | Wi-Fi acceleration message. | - | v4.6.0 |
| WLACC_SUGGEST_ACTION | Wi-Fi acceleration recommended operation. | - | v4.6.0 |
| WlAccStats | Wi-Fi acceleration statistics. | - | v4.6.0 |
| 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 |