# API 下架说明 (/zh-CN/api-reference/rtc/macos/rtc-api-sunset)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

## 已废弃 API [#已废弃-api]

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

| API | 描述 | 替代 API | 废弃版本 |
| --- | --- | --- | --- |
| setDirectCdnStreamingAudioConfiguration: | 设置直接向 CDN 推流的音频配置。 | 请改用[服务端旁路推流功能](/zh-CN/realtime-media/media-push)。 | v4.6.0 |
| setDirectCdnStreamingVideoConfiguration: | 设置直接向 CDN 推流的视频配置。 | 请改用[服务端旁路推流功能](/zh-CN/realtime-media/media-push)。 | v4.6.0 |
| startDirectCdnStreaming\:publishUrl\:mediaOptions: | 开始直接向 CDN 推流。 | 请改用[服务端旁路推流功能](/zh-CN/realtime-media/media-push)。 | v4.6.0 |
| stopDirectCdnStreaming | 停止直接向 CDN 推流。 | 请改用[服务端旁路推流功能](/zh-CN/realtime-media/media-push)。 | v4.6.0 |
| AgoraDirectCdnStreamingMediaOptions | 直接向 CDN 推流的媒体选项。 | 请改用[服务端旁路推流功能](/zh-CN/realtime-media/media-push)。 | v4.6.0 |
| AgoraDirectCdnStreamingStats | 直接向 CDN 推流的统计信息。 | 请改用[服务端旁路推流功能](/zh-CN/realtime-media/media-push)。 | v4.6.0 |
| AgoraDirectCdnStreamingState | 直接向 CDN 推流的状态。 | 请改用[服务端旁路推流功能](/zh-CN/realtime-media/media-push)。 | v4.6.0 |
| AgoraDirectCdnStreamingReason | 直接向 CDN 推流状态变化的原因。 | 请改用[服务端旁路推流功能](/zh-CN/realtime-media/media-push)。 | v4.6.0 |
| [startRhythmPlayer\:sound2\:config:](/zh-CN/api-reference/rtc/macos/play/rhythmplayer#api_irtcengine_startrhythmplayer) | 启用虚拟节拍器。 | - | v4.6.0 |
| [configRhythmPlayer:](/zh-CN/api-reference/rtc/macos/play/rhythmplayer#api_irtcengine_configrhythmplayer) | 配置虚拟节拍器。 | - | v4.6.0 |
| [rtcEngine\:didRhythmPlayerStateChanged\:reason:](/zh-CN/api-reference/rtc/macos/play/rhythmplayer#callback_irtcengineeventhandler_onrhythmplayerstatechanged) | 当虚拟节拍器状态发生变化时触发的回调。 | - | v4.6.0 |
| [addVideoWatermarkEx\:options\:connection:](/zh-CN/api-reference/rtc/macos/video/video-prenpro/watermark#api_irtcengineex_addvideowatermarkex) | 向本地视频添加水印图像。 | 请改用 [addVideoWatermarkEx\:connection:](/zh-CN/api-reference/rtc/macos/video/video-prenpro/watermark#api_irtcengineex_addvideowatermarkex1) | v4.6.0 |
| [pushExternalAudioFrameSampleBuffer:](/zh-CN/api-reference/rtc/macos/audio/audio-custom-capturenrendering#api_irtcengine_pushexternalaudioframesamplebuffer1) | 推送外部 `CMSampleBuffer` 音频帧。 | [pushExternalAudioFrameSampleBuffer\:sampleRate\:channels\:trackId:](/zh-CN/api-reference/rtc/macos/audio/audio-custom-capturenrendering#api_irtcengine_pushexternalaudioframesamplebuffer2) | v4.3.1 |
| [enableDualStreamMode:](/zh-CN/api-reference/rtc/macos/publishnsubscribe#api_irtcengine_enabledualstreammode) | 在发送端启用或关闭不同质量层级的视频流模式。 | [setDualStreamMode:](/zh-CN/api-reference/rtc/macos/publishnsubscribe#api_irtcengine_setdualstreammode) | v4.2.0 |
| [enableDualStreamMode\:streamConfig:](/zh-CN/api-reference/rtc/macos/publishnsubscribe#api_irtcengine_enabledualstreammode3) | 设置发送端的不同质量层级的视频流模式及视频小流配置。 | [setDualStreamMode\:streamConfig:](/zh-CN/api-reference/rtc/macos/publishnsubscribe#api_irtcengine_setdualstreammode2) | v4.2.0 |
| [enableDualStreamModeEx\:streamConfig\:connection:](/zh-CN/api-reference/rtc/macos/publishnsubscribe#api_irtcengineex_enabledualstreammodeex) | 在发送端启用或关闭不同质量层级的视频流。 | [setDualStreamModeEx\:streamConfig\:connection:](/zh-CN/api-reference/rtc/macos/publishnsubscribe#api_irtcengineex_setdualstreammodeex) | v4.2.0 |
| [enableWebSdkInteroperability:](/zh-CN/api-reference/rtc/macos/network#api_irtcengine_enablewebsdkinteroperability) | 启用或关闭与声网 Web SDK 的互通功能。 | - | v4.0.0 |
| [setExternalAudioSource\:sampleRate\:channels:](/zh-CN/api-reference/rtc/macos/audio/audio-custom-capturenrendering#api_irtcengine_setexternalaudiosource) | 设置外部音频源。 | [createCustomAudioTrack\:config:](/zh-CN/api-reference/rtc/macos/audio/audio-custom-capturenrendering#api_irtcengine_createcustomaudiotrack) | v4.0.0 |
| [setExternalAudioSource\:sampleRate\:channels\:localPlayback\:publish:](/zh-CN/api-reference/rtc/macos/audio/audio-custom-capturenrendering#api_irtcengine_setexternalaudiosource2) | 设置外部音频源参数。 | [createCustomAudioTrack\:config:](/zh-CN/api-reference/rtc/macos/audio/audio-custom-capturenrendering#api_irtcengine_createcustomaudiotrack) | v4.0.0 |
| [createDataStreamEx\:reliable\:ordered\:connection:](/zh-CN/api-reference/rtc/macos/metadata/datastream#api_irtcengineex_createdatastreamex1) | 创建一个数据流。 | [createDataStreamEx\:config\:connection:](/zh-CN/api-reference/rtc/macos/metadata/datastream#api_irtcengineex_createdatastreamex2) | v4.0.0 |
| [setLocalVideoMirrorMode:](/zh-CN/api-reference/rtc/macos/video/video-rendering#api_irtcengine_setlocalvideomirrormode) | 设置本地视频镜像模式。 | [setupLocalVideo:](/zh-CN/api-reference/rtc/macos/video/video-rendering#api_irtcengine_setuplocalvideo) 或 [setLocalRenderMode\:mirror:](/zh-CN/api-reference/rtc/macos/video/video-rendering#api_irtcengine_setlocalrendermode2) | v4.0.0 |
| [setLocalRenderMode\:mode:](/zh-CN/api-reference/rtc/macos/video/video-rendering#api_irtcengine_setlocalrendermode1) | 设置本地视频显示模式。 | [setLocalRenderMode\:mirror:](/zh-CN/api-reference/rtc/macos/video/video-rendering#api_irtcengine_setlocalrendermode2) | v4.0.0 |
| [setLogFileSize:](/zh-CN/api-reference/rtc/macos/network#api_irtcengine_setlogfilesize) | 设置 `agorasdk.log` 文件的大小。 | 使用 [sharedEngineWithConfig\:delegate:](/zh-CN/api-reference/rtc/macos/initialize#api_irtcengine_initialize) 中的 config 参数 | v4.0.0 |
| [setLogFilter:](/zh-CN/api-reference/rtc/macos/network#api_irtcengine_setlogfilter) | 设置 SDK 的日志输出等级。 | 使用 [sharedEngineWithConfig\:delegate:](/zh-CN/api-reference/rtc/macos/initialize#api_irtcengine_initialize) 中的 config 参数 | v4.0.0 |
| [setLogFile:](/zh-CN/api-reference/rtc/macos/network#api_irtcengine_setlogfile) | 设置 SDK 输出日志文件。 | 使用 [sharedEngineWithConfig\:delegate:](/zh-CN/api-reference/rtc/macos/initialize#api_irtcengine_initialize) 中的 config 参数 | v4.0.0 |
| [setLogLevel:](/zh-CN/api-reference/rtc/macos/network#api_irtcengine_setloglevel) | 设置 SDK 的输出日志等级。 | 使用 [sharedEngineWithConfig\:delegate:](/zh-CN/api-reference/rtc/macos/initialize#api_irtcengine_initialize) 中的 config 参数 | v4.0.0 |
| [setVideoResolution\:andFrameRate\:bitrate:](/zh-CN/api-reference/rtc/macos/video/video-basic#api_irtcengine_setvideoprofile2) | 手动设置视频编码配置。 | [setVideoEncoderConfiguration:](/zh-CN/api-reference/rtc/macos/video/video-basic#api_irtcengine_setvideoencoderconfiguration) | v4.0.0 |
| [setAudioProfile\:scenario:](/zh-CN/api-reference/rtc/macos/audio/audio-basic#api_irtcengine_setaudioprofile) | 设置音频配置和音频场景。 | [setAudioProfile:](/zh-CN/api-reference/rtc/macos/audio/audio-basic#api_irtcengine_setaudioprofile2) 或 [setAudioScenario:](/zh-CN/api-reference/rtc/macos/audio/audio-basic#api_irtcengine_setaudioscenario) | v4.0.0 |
| [startAudioMixing\:loopback\:cycle:](/zh-CN/api-reference/rtc/macos/play/audio-mixing#api_irtcengine_startaudiomixing) | 开始播放音乐文件。 | [startAudioMixing\:loopback\:cycle\:startPos:](/zh-CN/api-reference/rtc/macos/play/audio-mixing#api_irtcengine_startaudiomixing2) | v4.0.0 |
| [addVideoWatermark:](/zh-CN/api-reference/rtc/macos/video/video-prenpro/watermark#api_irtcengine_addvideowatermark1) | 向本地视频添加水印图像。 | [addVideoWatermark\:options:](/zh-CN/api-reference/rtc/macos/video/video-prenpro/watermark#api_irtcengine_addvideowatermark2) | v4.0.0 |
| [rtcEngineLocalAudioMixingDidFinish:](/zh-CN/api-reference/rtc/macos/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingfinished) | 本地音乐文件播放结束时的回调。 | [rtcEngine\:audioMixingStateChanged\:reasonCode:](/zh-CN/api-reference/rtc/macos/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged) | v4.0.0 |
| [audioQualityBlock:](/zh-CN/api-reference/rtc/macos/audio/audio-basic#callback_irtcengineeventhandler_onaudioquality) | 报告每个远端用户发送音频流的统计信息。 | [rtcEngine\:remoteAudioStats:](/zh-CN/api-reference/rtc/macos/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiostats) | v4.0.0 |
| [rtcEngineConnectionDidBanned:](/zh-CN/api-reference/rtc/macos/network#callback_irtcengineeventhandler_onconnectionbanned) | 连接被声网服务器封禁时触发的回调。 | [rtcEngine\:connectionChangedToState\:reason:](/zh-CN/api-reference/rtc/macos/network#callback_irtcengineeventhandler_onconnectionstatechanged) | v4.0.0 |
| [rtcEngineConnectionDidInterrupted:](/zh-CN/api-reference/rtc/macos/network#callback_irtcengineeventhandler_onconnectioninterrupted) | 连接中断回调。 | [rtcEngine\:connectionChangedToState\:reason:](/zh-CN/api-reference/rtc/macos/network#callback_irtcengineeventhandler_onconnectionstatechanged) | v4.0.0 |
| [rtcEngine\:firstRemoteAudioFrameOfUid\:elapsed:](/zh-CN/api-reference/rtc/macos/audio/audio-basic#callback_irtcengineeventhandler_onfirstremoteaudioframe) | 远端用户的第一帧音频被接收并解码时触发。 | [rtcEngine\:remoteAudioStateChangedOfUid\:state\:reason\:elapsed:](/zh-CN/api-reference/rtc/macos/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiostatechanged) | v4.0.0 |
| [rtcEngine\:firstRemoteAudioFrameDecodedOfUid\:elapsed:](/zh-CN/api-reference/rtc/macos/audio/audio-basic#callback_irtcengineeventhandler_onfirstremoteaudiodecoded) | 当 SDK 解码来自某个远端用户的首帧音频时触发回调。 | [rtcEngine\:remoteAudioStateChangedOfUid\:state\:reason\:elapsed:](/zh-CN/api-reference/rtc/macos/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiostatechanged) | v4.0.0 |
| [rtcEngine\:audioTransportStatsOfUid\:delay\:lost\:rxKBitRate:](/zh-CN/api-reference/rtc/macos/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiotransportstats) | 报告每个远端音频流的传输层统计信息。 | [rtcEngine\:remoteAudioStats:](/zh-CN/api-reference/rtc/macos/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiostats) | v4.0.0 |
| [rtcEngine\:videoTransportStatsOfUid\:delay\:lost\:rxKBitRate:](/zh-CN/api-reference/rtc/macos/video/video-basic#callback_irtcengineeventhandler_onremotevideotransportstats) | 上报每个远端视频流的传输层统计信息。 | [rtcEngine\:remoteVideoStats:](/zh-CN/api-reference/rtc/macos/video/video-basic#callback_irtcengineeventhandler_onremotevideostats) | v4.0.0 |
| [rtcEngine\:didLocalVideoEnabled\:byUid:](/zh-CN/api-reference/rtc/macos/video/video-basic#callback_irtcengineeventhandler_onuserenablelocalvideo) | 当指定的远端用户启用或关闭本地视频采集功能时触发。 | [rtcEngine\:remoteVideoStateChangedOfUid\:state\:reason\:elapsed:](/zh-CN/api-reference/rtc/macos/video/video-basic#callback_irtcengineeventhandler_onremotevideostatechanged) | v4.0.0 |
| [rtcEngineVideoDidStop:](/zh-CN/api-reference/rtc/macos/video/video-basic#callback_irtcengineeventhandler_onvideostopped) | 视频停止播放时的回调。 | [rtcEngine\:localVideoStateChangedOfState\:reason\:sourceType:](/zh-CN/api-reference/rtc/macos/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) | v4.0.0 |

## 已删除 API [#已删除-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 |
| AgoraWlAccReason | Wi-Fi 加速消息原因。 | - | v4.6.0 |
| AgoraWlAccAction | Wi-Fi 加速建议操作。 | - | v4.6.0 |
| AgoraWlAccStats | Wi-Fi 加速统计信息。 | - | v4.6.0 |
| setVideoProfile\:profile\:swapWidthAndHeight: | 设置视频编码配置。 | [setVideoEncoderConfiguration:](/zh-CN/api-reference/rtc/macos/video/video-basic#api_irtcengine_setvideoencoderconfiguration) | v4.4.0 |
| setRemoteRenderMode\:uid\:mode: | 设置远端视图显示模式。 | [setRemoteRenderMode\:mode\:mirror:](/zh-CN/api-reference/rtc/macos/video/video-rendering#api_irtcengine_setremoterendermode2) | v4.4.0 |
| openWithCustomSourceAtStartPos | 打开自定义媒体资源文件。 | [openWithMediaSource:](/zh-CN/api-reference/rtc/macos/play/mediaplayer/mediaplayer-open#api_imediaplayer_openwithmediasource) | v4.4.0 |
| setVideoQualityParameters | 设置视频优化选项（仅适用于直播）。 | 使用 [AgoraVideoEncoderConfiguration](/zh-CN/api-reference/rtc/macos/class-videoencoderconfiguration) 类中的 degradationPreference 参数 | v4.4.0 |
| startEchoTest | 开始语音通话回路测试。 | [startEchoTestWithConfig:](/zh-CN/api-reference/rtc/macos/network#api_irtcengine_startechotest3) | v4.4.0 |
| startEchoTestWithInterval | 开始语音通话回路测试。 | [startEchoTestWithConfig:](/zh-CN/api-reference/rtc/macos/network#api_irtcengine_startechotest3) | v4.4.0 |
| setEncryptionMode | 启用内置的加密方案。 | [enableEncryption\:encryptionConfig:](/zh-CN/api-reference/rtc/macos/network#api_irtcengine_enableencryption) | v4.4.0 |
| setEncryptionSecret | 启用内置加密，并设置数据加密密码。 | [enableEncryption\:encryptionConfig:](/zh-CN/api-reference/rtc/macos/network#api_irtcengine_enableencryption) | v4.4.0 |
| onEvent | 插件事件回调。 | [onEventWithContext\:key\:value:](/zh-CN/api-reference/rtc/macos/extension#callback_irtcengineeventhandler_onextensioneventwithcontext) | v4.4.0 |
| onExtensionStarted | 插件启用回调。 | [onExtensionStartedWithContext:](/zh-CN/api-reference/rtc/macos/extension#callback_irtcengineeventhandler_onextensionstartedwithcontext) | v4.4.0 |
| onExtensionStopped | 插件禁用回调。 | [onExtensionStoppedWithContext:](/zh-CN/api-reference/rtc/macos/extension#callback_irtcengineeventhandler_onextensionstoppedwithcontext) | v4.4.0 |
| onExtensionError | 插件出错回调。 | [onExtensionErrorWithContext\:error\:message:](/zh-CN/api-reference/rtc/macos/extension#callback_irtcengineeventhandler_onextensionerrorwithcontext) | v4.4.0 |