API 下架说明
本页介绍 SDK 中已废弃和删除的 API。
已废弃 API
废弃后的 API 预计会在 1 年左右正式下架。声网建议你尽快使用推荐的 API 进行替换，以免影响线上业务。
| API | 描述 | 替代 API | 废弃版本 |
|---|---|---|---|
| setDirectCdnStreamingAudioConfiguration | 设置直接向 CDN 推流的音频配置。 | 请改用 服务端旁路推流功能。 | v4.6.0 |
| setDirectCdnStreamingVideoConfiguration | 设置直接向 CDN 推流的视频配置。 | 请改用 服务端旁路推流功能。 | v4.6.0 |
| startDirectCdnStreaming | 开始直接向 CDN 推流。 | 请改用 服务端旁路推流功能。 | v4.6.0 |
| stopDirectCdnStreaming | 停止直接向 CDN 推流。 | 请改用 服务端旁路推流功能。 | v4.6.0 |
| DirectCdnStreamingMediaOptions | 直接向 CDN 推流的媒体选项。 | 请改用 服务端旁路推流功能。 | v4.6.0 |
| DirectCdnStreamingStats | 直接向 CDN 推流的统计信息。 | 请改用 服务端旁路推流功能。 | v4.6.0 |
| DIRECT_CDN_STREAMING_STATE | 直接向 CDN 推流的状态。 | 请改用 服务端旁路推流功能。 | v4.6.0 |
| DIRECT_CDN_STREAMING_REASON | 直接向 CDN 推流状态变化的原因。 | 请改用 服务端旁路推流功能。 | v4.6.0 |
| startRhythmPlayer | 启用虚拟节拍器。 | - | v4.6.0 |
| configRhythmPlayer | 配置虚拟节拍器。 | - | v4.6.0 |
| onRhythmPlayerStateChanged | 虚拟节拍器状态发生变化时的回调。 | - | v4.6.0 |
| addVideoWatermarkEx [1/2] | 向本地视频添加水印图像。 | 请改用 addVideoWatermarkEx [2/2] | v4.6.0 |
| enableDualStreamMode [1/2] | 启用或关闭发送端的双流模式。 | setDualStreamMode [1/2] | v4.2.0 |
| enableDualStreamMode [2/2] | 设置发送端的双流模式和视频小流。 | setDualStreamMode [2/2] | v4.2.0 |
| enableDualStreamModeEx | 在发送端启用或关闭不同质量层级的视频流。 | setDualStreamModeEx | v4.2.0 |
| enableWebSdkInteroperability | 启用与声网 Web SDK 的互通功能（仅适用于直播场景）。 | - | v4.0.0 |
| setExternalAudioSource | 设置外部音频源参数。 | createCustomAudioTrack | v4.0.0 |
| createDataStreamEx [1/2] | 创建一个数据流。 | createDataStreamEx [2/2] | v4.0.0 |
| setLocalVideoMirrorMode | 设置本地视频镜像模式。 | setupLocalVideo 或 setLocalRenderMode [2/2] | v4.0.0 |
| startScreenCaptureByScreenRect | 通过指定屏幕区域采集整个屏幕或部分屏幕。 | startScreenCaptureByDisplayId | v4.0.0 |
| setLocalRenderMode [1/2] | 更新本地视频画面的显示模式。 | setLocalRenderMode [2/2] | v4.0.0 |
| setLogFileSize | 设置日志文件大小。 | 使用 initialize 中的 context 参数 | v4.0.0 |
| setLogFilter | 设置 SDK 的日志输出等级。 | 使用 initialize 中的 context 参数 | v4.0.0 |
| setLogFile | 设置 SDK 输出日志文件路径。 | 使用 initialize 中的 context 参数 | v4.0.0 |
| setLogLevel | 设置 SDK 的输出日志等级。 | 使用 initialize 中的 context 参数 | v4.0.0 |
| setAudioProfile [1/2] | 设置音频配置和音频场景。 | setAudioProfile [2/2] 或 setAudioScenario | v4.0.0 |
| startAudioMixing [1/2] | 开始播放音乐文件。 | startAudioMixing [2/2] | v4.0.0 |
| preload [1/2] | 预加载音乐资源。 | preload [2/2] | v4.0.0 |
| addVideoWatermark [1/3] | 向本地视频流添加 PNG 格式的水印图像。 | addVideoWatermark [2/3] | v4.0.0 |
| onAudioMixingFinished | 本地音乐文件播放结束时触发的回调。 | onAudioMixingStateChanged | v4.0.0 |
| onAudioQuality | 报告每个远端用户发送的音频流的统计信息。 | onRemoteAudioStats | v4.0.0 |
| onConnectionBanned | 连接被声网服务器封禁时触发的回调。 | onConnectionStateChanged | v4.0.0 |
| onConnectionInterrupted | onConnectionInterrupted 回调。 | onConnectionStateChanged | v4.0.0 |
| onFirstRemoteAudioFrame | 远端用户音频首帧到达回调。 | onRemoteAudioStateChanged | v4.0.0 |
| onFirstRemoteAudioDecoded | 首帧远端音频解码完成回调。 | onRemoteAudioStateChanged | v4.0.0 |
| onRemoteAudioTransportStats | 报告每个远端音频流的传输层统计信息回调。 | onRemoteAudioStats | v4.0.0 |
| onRemoteVideoTransportStats | 报告每个远端视频流的传输层统计信息。 | onRemoteVideoStats | v4.0.0 |
| onUserEnableLocalVideo | 远端用户启用或关闭本地视频采集功能回调。 | onRemoteVideoStateChanged | v4.0.0 |
| onVideoStopped | 视频停止播放时触发的回调。 | onLocalVideoStateChanged | v4.0.0 |
已删除 API
API 已在 SDK 中删除。请使用推荐的替代 API 实现相关功能。
| API | 描述 | 替代 API | 删除版本 |
|---|---|---|---|
| setLocalPublishFallbackOption | 设置弱网条件下发布的音视频流回退选项。 | - | v4.6.0 |
| onLocalPublishFallbackToAudioOnly | 本地发布流已回退为音频流回调。 | - | v4.6.0 |
| onDownlinkNetworkInfoUpdated | 下行网络信息变化回调。 | - | v4.6.0 |
| enableWirelessAccelerate | 开启或关闭 Wi-Fi 加速功能。 | - | v4.6.0 |
| onWlAccStats | 报告 Wi-Fi 加速效果。 | - | v4.6.0 |
| onWlAccMessage | 报告 Wi-Fi 加速消息。 | - | v4.6.0 |
| WLACC_MESSAGE_REASON | Wi-Fi 加速消息原因。 | - | v4.6.0 |
| WLACC_SUGGEST_ACTION | Wi-Fi 加速建议操作。 | - | v4.6.0 |
| WlAccStats | Wi-Fi 加速统计信息。 | - | v4.6.0 |
| openWithCustomSource | 打开自定义媒体资源文件。 | openWithMediaSource | v4.4.0 |
| startEchoTest() | 开始语音通话回路测试。 | startEchoTest | v4.4.0 |
| startEchoTest(intervalInSeconds) | 开始语音通话回路测试。 | startEchoTest | v4.4.0 |
| setEncryptionMode | 启用内置的加密方案。 | enableEncryption | v4.4.0 |
| setEncryptionSecret | 启用内置加密，并设置数据加密密码。 | enableEncryption | v4.4.0 |
| onExtensionEvent | 插件事件回调。 | onExtensionEventWithContext | v4.4.0 |
| onExtensionStarted | 插件启用回调。 | onExtensionStartedWithContext | v4.4.0 |
| onExtensionStopped | 插件禁用回调。 | onExtensionStoppedWithContext | v4.4.0 |
| onExtensionError | 插件出错回调。 | onExtensionErrorWithContext | v4.4.0 |