API 下架说明

  • macOS

更新时间不可用

本页介绍 SDK 中已废弃和删除的 API。

已废弃 API

废弃后的 API 预计会在 1 年左右正式下架。声网建议你尽快使用推荐的 API 进行替换,以免影响线上业务。

API描述替代 API废弃版本
setDirectCdnStreamingAudioConfiguration:设置直接向 CDN 推流的音频配置。请改用服务端旁路推流功能。v4.6.0
setDirectCdnStreamingVideoConfiguration:设置直接向 CDN 推流的视频配置。请改用服务端旁路推流功能。v4.6.0
startDirectCdnStreaming:publishUrl:mediaOptions:开始直接向 CDN 推流。请改用服务端旁路推流功能。v4.6.0
stopDirectCdnStreaming停止直接向 CDN 推流。请改用服务端旁路推流功能。v4.6.0
AgoraDirectCdnStreamingMediaOptions直接向 CDN 推流的媒体选项。请改用服务端旁路推流功能。v4.6.0
AgoraDirectCdnStreamingStats直接向 CDN 推流的统计信息。请改用服务端旁路推流功能。v4.6.0
AgoraDirectCdnStreamingState直接向 CDN 推流的状态。请改用服务端旁路推流功能。v4.6.0
AgoraDirectCdnStreamingReason直接向 CDN 推流状态变化的原因。请改用服务端旁路推流功能。v4.6.0
startRhythmPlayer:sound2:config:启用虚拟节拍器。-v4.6.0
configRhythmPlayer:配置虚拟节拍器。-v4.6.0
rtcEngine:didRhythmPlayerStateChanged:reason:当虚拟节拍器状态发生变化时触发的回调。-v4.6.0
addVideoWatermarkEx:options:connection:向本地视频添加水印图像。请改用 addVideoWatermarkEx:connection:v4.6.0
pushExternalAudioFrameSampleBuffer:推送外部 CMSampleBuffer 音频帧。pushExternalAudioFrameSampleBuffer:sampleRate:channels:trackId:v4.3.1
enableDualStreamMode:在发送端启用或关闭不同质量层级的视频流模式。setDualStreamMode:v4.2.0
enableDualStreamMode:streamConfig:设置发送端的不同质量层级的视频流模式及视频小流配置。setDualStreamMode:streamConfig:v4.2.0
enableDualStreamModeEx:streamConfig:connection:在发送端启用或关闭不同质量层级的视频流。setDualStreamModeEx:streamConfig:connection:v4.2.0
enableWebSdkInteroperability:启用或关闭与声网 Web SDK 的互通功能。-v4.0.0
setExternalAudioSource:sampleRate:channels:设置外部音频源。createCustomAudioTrack:config:v4.0.0
setExternalAudioSource:sampleRate:channels:localPlayback:publish:设置外部音频源参数。createCustomAudioTrack:config:v4.0.0
createDataStreamEx:reliable:ordered:connection:创建一个数据流。createDataStreamEx:config:connection:v4.0.0
setLocalVideoMirrorMode:设置本地视频镜像模式。setupLocalVideo: 或 setLocalRenderMode:mirror:v4.0.0
setLocalRenderMode:mode:设置本地视频显示模式。setLocalRenderMode:mirror:v4.0.0
setLogFileSize:设置 agorasdk.log 文件的大小。使用 sharedEngineWithConfig:delegate: 中的 config 参数v4.0.0
setLogFilter:设置 SDK 的日志输出等级。使用 sharedEngineWithConfig:delegate: 中的 config 参数v4.0.0
setLogFile:设置 SDK 输出日志文件。使用 sharedEngineWithConfig:delegate: 中的 config 参数v4.0.0
setLogLevel:设置 SDK 的输出日志等级。使用 sharedEngineWithConfig:delegate: 中的 config 参数v4.0.0
setVideoResolution:andFrameRate:bitrate:手动设置视频编码配置。setVideoEncoderConfiguration:v4.0.0
setAudioProfile:scenario:设置音频配置和音频场景。setAudioProfile: 或 setAudioScenario:v4.0.0
startAudioMixing:loopback:cycle:开始播放音乐文件。startAudioMixing:loopback:cycle:startPos:v4.0.0
addVideoWatermark:向本地视频添加水印图像。addVideoWatermark:options:v4.0.0
rtcEngineLocalAudioMixingDidFinish:本地音乐文件播放结束时的回调。rtcEngine:audioMixingStateChanged:reasonCode:v4.0.0
audioQualityBlock:报告每个远端用户发送音频流的统计信息。rtcEngine:remoteAudioStats:v4.0.0
rtcEngineConnectionDidBanned:连接被声网服务器封禁时触发的回调。rtcEngine:connectionChangedToState:reason:v4.0.0
rtcEngineConnectionDidInterrupted:连接中断回调。rtcEngine:connectionChangedToState:reason:v4.0.0
rtcEngine:firstRemoteAudioFrameOfUid:elapsed:远端用户的第一帧音频被接收并解码时触发。rtcEngine:remoteAudioStateChangedOfUid:state:reason:elapsed:v4.0.0
rtcEngine:firstRemoteAudioFrameDecodedOfUid:elapsed:当 SDK 解码来自某个远端用户的首帧音频时触发回调。rtcEngine:remoteAudioStateChangedOfUid:state:reason:elapsed:v4.0.0
rtcEngine:audioTransportStatsOfUid:delay:lost:rxKBitRate:报告每个远端音频流的传输层统计信息。rtcEngine:remoteAudioStats:v4.0.0
rtcEngine:videoTransportStatsOfUid:delay:lost:rxKBitRate:上报每个远端视频流的传输层统计信息。rtcEngine:remoteVideoStats:v4.0.0
rtcEngine:didLocalVideoEnabled:byUid:当指定的远端用户启用或关闭本地视频采集功能时触发。rtcEngine:remoteVideoStateChangedOfUid:state:reason:elapsed:v4.0.0
rtcEngineVideoDidStop:视频停止播放时的回调。rtcEngine:localVideoStateChangedOfState:reason:sourceType:v4.0.0
表格内容超出当前宽度,可横向滚动查看更多列。

已删除 API

API 已在 SDK 中删除。请使用推荐的替代 API 实现相关功能。

API描述替代 API删除版本
setLocalPublishFallbackOption设置弱网条件下发布的音视频流回退选项。-v4.6.0
didLocalPublishFallbackToAudioOnly本地发布流已回退为音频流回调。-v4.6.0
downlinkNetworkInfoUpdate下行网络信息变化回调。-v4.6.0
AgoraRtcRemoteVideoStats 删除 receivedFrameRate(上次统计后)接收到的帧率 (fps)。-v4.6.0
enableWirelessAccelerate开启或关闭 Wi-Fi 加速功能。-v4.6.0
onWlAccStats报告 Wi-Fi 加速效果。-v4.6.0
wlAccMessage报告 Wi-Fi 加速消息。-v4.6.0
AgoraWlAccReasonWi-Fi 加速消息原因。-v4.6.0
AgoraWlAccActionWi-Fi 加速建议操作。-v4.6.0
AgoraWlAccStatsWi-Fi 加速统计信息。-v4.6.0
setVideoProfile:profile:swapWidthAndHeight:设置视频编码配置。setVideoEncoderConfiguration:v4.4.0
setRemoteRenderMode:uid:mode:设置远端视图显示模式。setRemoteRenderMode:mode:mirror:v4.4.0
openWithCustomSourceAtStartPos打开自定义媒体资源文件。openWithMediaSource:v4.4.0
setVideoQualityParameters设置视频优化选项(仅适用于直播)。使用 AgoraVideoEncoderConfiguration 类中的 degradationPreference 参数v4.4.0
startEchoTest开始语音通话回路测试。startEchoTestWithConfig:v4.4.0
startEchoTestWithInterval开始语音通话回路测试。startEchoTestWithConfig:v4.4.0
setEncryptionMode启用内置的加密方案。enableEncryption:encryptionConfig:v4.4.0
setEncryptionSecret启用内置加密,并设置数据加密密码。enableEncryption:encryptionConfig:v4.4.0
onEvent插件事件回调。onEventWithContext:key:value:v4.4.0
onExtensionStarted插件启用回调。onExtensionStartedWithContext:v4.4.0
onExtensionStopped插件禁用回调。onExtensionStoppedWithContext:v4.4.0
onExtensionError插件出错回调。onExtensionErrorWithContext:error:message:v4.4.0
表格内容超出当前宽度,可横向滚动查看更多列。