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 direct CDN streaming by the host. | Use Media Push instead. | v4.6.0 |
| setDirectCdnStreamingVideoConfiguration | Sets the video property configuration for direct CDN streaming 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 media streams directly to the CDN. | Use Media Push instead. | v4.6.0 |
| Use Media Push instead. | v4.6.0 | ||
| DirectCdnStreamingMediaOptions | Used to set media publishing options for the host. | Use Media Push instead. | v4.6.0 |
| DirectCdnStreamingStats | Statistics of the current CDN stream. | 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 |
| setRemoteSubscribeFallbackOption [1/2] | Sets the fallback option for the subscribed video stream based on network conditions. | setRemoteSubscribeFallbackOption [2/2] | v4.4.0 |
| setRemoteVideoStreamType [1/2] | Sets the type of video stream to subscribe to. | setRemoteVideoStreamType [2/2] | v4.4.0 |
| setRemoteDefaultVideoStreamType [1/2] | Sets the default video stream type to subscribe to. | setRemoteDefaultVideoStreamType [2/2] | v4.4.0 |
| setRemoteVideoStreamTypeEx [1/2] | Sets the type of video stream to subscribe to. | setRemoteVideoStreamTypeEx [2/2] | v4.4.0 |
| enableDualStreamMode [1/2] | Enables or disables dual-stream mode at the sender. | setDualStreamMode [1/2] | v4.2.0 |
| enableDualStreamMode [2/2] | Sets the dual-stream mode and low-quality stream at the sender. | setDualStreamMode [2/2] | v4.2.0 |
| enableDualStreamModeEx | Enables or disables dual-stream mode on the sending side. | setDualStreamModeEx | v4.2.0 |
| enableWebSdkInteroperability | Enables or disables interoperability with Agora Web SDK, only applicable in Live Broadcast Low Latency mode. | - | v4.0.0 |
| setExternalAudioSource [1/2] | Sets the external audio source. | createCustomAudioTrack | v4.0.0 |
| setExternalAudioSource [2/2] | Sets external audio source parameters. | createCustomAudioTrack | v4.0.0 |
| createDataStreamEx [1/2] | Creates a data stream to improve reliability and ordering of data transmission. | createDataStreamEx [2/2] | v4.0.0 |
| pushExternalVideoFrameById [1/2] | Pushes external raw video frame to the SDK via video track. | pushExternalVideoFrameById [2/2] | v4.0.0 |
| pushExternalVideoFrame [1/2] | Pushes external raw video frame to the SDK. | pushExternalVideoFrame [2/2] | v4.0.0 |
| setLocalVideoMirrorMode | Sets the local video mirror mode. | setupLocalVideo or setLocalRenderMode [2/2] | v4.0.0 |
| setLocalRenderMode [1/2] | Sets the display mode of the local video. | setLocalRenderMode [2/2] | v4.0.0 |
| setLogFileSize | Sets the size of the SDK log file. | Use the config parameter in create [2/2]. | v4.0.0 |
| setLogFilter | Sets the SDK log output level. | Use the config parameter in create [2/2]. | v4.0.0 |
| setLogFile | Sets the SDK log output file. | Use the config parameter in create [2/2]. | v4.0.0 |
| setLogLevel | Sets the SDK log output level. | Use the config parameter in create [2/2]. | 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 watermark image to the local video. | addVideoWatermark [2/3] | v4.0.0 |
| getBlue | Gets the blue component of the background color. | - | v4.0.0 |
| getGreen | Gets the green component of the background color. | - | v4.0.0 |
| getRed | Gets the red component of the background color. | - | v4.0.0 |
| setBlue | Sets the blue component of the background color. | - | v4.0.0 |
| setGreen | Sets the green component of the background color. | - | v4.0.0 |
| setRed | Sets the red component value of the background color. | - | v4.0.0 |
| onAudioMixingFinished | Callback for when local music file playback ends. | onAudioMixingStateChanged | v4.0.0 |
| onAudioQuality | Callback that reports statistics of the audio stream 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 is received. | onRemoteAudioStateChanged | v4.0.0 |
| onFirstRemoteAudioDecoded | Callback when the first remote audio frame is decoded. | onRemoteAudioStateChanged | v4.0.0 |
| onRemoteAudioTransportStats | Reports transport-layer statistics of each remote audio stream. | onRemoteAudioStats | v4.0.0 |
| onRemoteVideoTransportStats | Callback for transport-layer statistics of remote video stream. | onRemoteVideoStats | v4.0.0 |
| onUserEnableLocalVideo | Callback triggered when a specified 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 |
| WlAccStats | Wi-Fi acceleration statistics. | - | v4.6.0 |
| setVideoProfile | Sets the video encoder configuration. | setVideoEncoderConfiguration | v4.4.0 |
| setRemoteRenderMode(userId, renderMode) | Sets the video display mode of a specified remote user. | setRemoteRenderMode | v4.4.0 |
| CreateRendererView | Creates a RendererView. | The Android native method . | v4.4.0 |
| CreateTextureView | Creates a TextureView. | The Android native method . | v4.4.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 |
| onEvent | The event callback of the extension. | onEventWithContext | v4.4.0 |
| onStarted | Occurs when the extension is enabled. | onStartedWithContext | v4.4.0 |
| onStopped | Occurs when the extension is disabled. | onStoppedWithContext | v4.4.0 |
| onError | Occurs when the extension runs incorrectly. | onErrorWithContext | v4.4.0 |