API 下架说明

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

已废弃 API

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

API	描述	替代 API	废弃版本
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:	设置 SDK 输出的日志文件的大小。	使用 sharedEngineWithConfig:delegate: 中的 config 参数	v4.0.0
setLogFilter:	设置日志输出等级。	使用 sharedEngineWithConfig:delegate: 中的 config 参数	v4.0.0
setLogFile:	设置日志文件	使用 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:connectionStateChanged:reason:	v4.0.0
rtcEngineConnectionDidInterrupted:	网络连接中断回调。	rtcEngine:connectionStateChanged:reason:	v4.0.0
rtcEngine:firstRemoteAudioFrameOfUid:elapsed:	已接收远端音频首帧回调。	rtcEngine:remoteAudioStateChangedOfUid:state:reason:elapsed:	v4.0.0
rtcEngine:firstRemoteAudioFrameDecodedOfUid:elapsed:	已解码远端音频首帧的回调。	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	删除版本
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