文档中心
语音通话 (Legacy)
Console 官网 社区 技术支持
简体中文
search-icon

发版说明

更新时间 2023/03/13 03:17:15

本文提供声网音频 SDK 的发版说明。

已知问题和局限性

iOS 15 兼容性

SDK 自 3.4.6 版本起对 iOS 15 进行了兼容性适配。对 3.2.0（含）及 3.4.5（含）之间的 SDK 版本，在 iOS 15 上高概率会发生崩溃。为避免该问题，请务必将 SDK 升级至 3.4.6 或之后版本。

3.7.2 版

该版本于 2022 年 11 月 2 日发布。

升级必看

为增加 SDK 安全性，该版本对使用的第三方开源库进行如下更新：

  • OpenSSL 库：从 1.1.1l 升级到 1.1.1q。
  • zlib 库：从 1.2.11 升级到 1.2.12。
  • FFmpeg 库：修复了安全漏洞 CVE-2021-38114，CVE-2021-38291。

问题修复

该版本修复了如下问题：

  • 部分网络情况下，SDK 不支持报告端到端丢包率。
  • 使用 iOS 16 系统的用户调用 enableInEarMonitoring 开启耳返时，无耳返效果。
  • 调用 setAudioMixingPosition 设置音乐文件的播放位置在 36 分钟或之后的位置时，音乐会从头开始播放，而非从指定的位置开始播放。

3.7.1 版

该版本于 2022 年 8 月 4 日发布。

新增特性

1. 设置本地代理

该版本新增 setLocalAccessPoint 方法，用于设置本地代理。

调用该方法前，请确保已成功部署声网混合云或声网实时音视频私有化平台。你可以联系 sales@agora.io 了解和部署声网混合云或声网实时音视频私有化平台。

改进

1. 跨频道媒体流转发

该版本优化了 SDK 与跨频道媒体流转发服务器连接机制，提高了跨频道媒体流转发的成功率。

问题修复

该版本修复了如下问题：

  • 偶现崩溃。
  • 虽然远端用户未改变音频状态，但本地用户在断网重连后会收到 remoteAudioStateChangedOfUid(2,6) 回调。
  • 在网络时延过大或路由器不响应 ICMP 包的情况下，reportRtcStats 回调报告的 gatewayRtt 不准确。
  • 调用 playEffect 或 startAudioMixing 播放 8 位 PCM 编码的 WAV 格式音频时，偶现崩溃。
  • 用户禁止麦克风权限后，localAudioStateChange 回调报告的本地音频出错原因与实际不符。
  • 偶现用户第一次加频道用时较长。

API 变更

新增

  • setLocalAccessPoint
  • didProxyConnected 中新增支持 localProxyIp 参数
  • AgoraProxyType 中新增 AgoraNoneProxyType(0) 和 AgoraLocalProxyType(3)

3.7.0.2 版

该版本于 2022 年 6 月 6 日发布，提升了 SDK 稳定性。

3.7.0 版

该版本于 2022 年 4 月 11 日发布。

升级必看

优化集成 Swift API

Swift 开发者会将声网 SDK 提供的 Objective-C API 通过 Xcode 自动转换成 Swift API 进行集成开发工作。为避免自动转换导致的 API 语义混淆，该版本在头文件中通过 NS_SWIFT_NAME 宏显式定义出每个 Objective-C API 对应的 Swift API 的名称。

使用 Swift API 时需要注意声网定义的如下 Swift API 名与 Xcode 自动转换的 Swift API 名不一致：

声网 Objective-C API 声网定义的 Swift API Xcode 自动转换的 Swift API
AgoraAudioDataFrameProtocol 协议中的 - (BOOL)onRecordAudioFrame:(AgoraAudioFrame* _Nonnull)frame; func onRecordAudioFrame(_ frame: AgoraAudioFrame) -> Bool {} func onRecord(_ frame: AgoraAudioFrame) -> Bool {}

新增特性

1. 空间音效

该版本新增空间音效功能，用于塑造远端用户声音的方位感和模拟声音在真实世界中的传播过程，实现本地用户听远端用户时的空间音效。

如有需要，请联系 sales@agora.io。

2. 本地语音音调

该版本新增 enableLocalVoicePitchCallback 方法和 reportLocalVoicePitchFrequency 回调，允许 SDK 按设置的时间间隔向 app 报告本地用户的语音音调。

3. 切换用户角色失败回调

该版本新增 didClientRoleChangeFailed 回调，用于报告直播场景下用户切换角色失败的原因和当前的用户角色。

4. 网络连接发生改变的原因

为方便用户了解网络连接发生改变的原因，该版本在 AgoraConnectionChangedReason 中新增如下枚举：

  • AgoraConnectionChangedSameUidLogin(19)：使用相同的 UID 从不同的设备加入同一频道。
  • AgoraConnectionChangedTooManyBroadcasters(20)：频道内主播人数已达上限。该枚举仅在开启 128 人功能后报告。

改进

1. 频道能力提升

自该版本起，单个频道可支持最多 128 位主播同时在线并同时发布音频流，观众人数无限制，每位主播或观众最多可同时订阅 50 位主播。

如有需要，请联系 sales@agora.io。

2. 新版 AI 降噪

自该版本起，声网在原版 AI 降噪功能的基础上增加了新版 AI 降噪功能，拥有更好的降噪效果。如果你希望体验新版 AI 降噪，请联系 sales@agora.io。

3. playEffect 优化

为避免阻塞，该版本优化了 playEffect 的内部实现逻辑，以减少播放音效文件时的卡顿。

4. 音频体验优化

该版本改善了网络突发抖动和高丢包情况下的音频卡顿问题。

5. 传输升级

该版本升级了传输协议和算法，增强了弱网对抗能力。

问题修复

该版本修复了 app 离开频道并退后台一段时间后，再切回前台时低概率性无法重新加入频道的问题。

API 变更

新增

  • enableLocalVoicePitchCallback
  • reportLocalVoicePitchFrequency
  • didClientRoleChangeFailed
  • AgoraConnectionChangedReason 中新增 AgoraConnectionChangedSameUidLogin(19) 和 AgoraConnectionChangedTooManyBroadcasters(20)

废弃

  • 警告码 AgoraWarningCodeSetClientRoleNotAuthorized(119)，改用 AgoraClientRoleChangeFailedReason

3.6.2 版

该版本于 2022 年 2 月 22 日发布。

新增特性

1. 使用 CocoaPods 时删除插件

插件指可选集成到项目文件的动态库。自该版本起，通过 CocoaPods 集成 iOS SDK 时，声网支持你通过在 Podfile 中使用 subspecs 字段指定集成你需要的动态库，以排除你不需要使用的插件，从而减少集成 SDK 后的应用体积。示例代码和 subspecs 字段详情请参考减少 App 体积。

2. Wi-Fi 加速

该版本新增支持并默认开启 Wi-Fi 加速功能。当 SDK 发现集成加速插件的 Wi-Fi 路由器后，该功能会正式生效，使路由器合理分配 Wi-Fi 频谱资源，以降低丢包率和时延，从而减少音频卡顿。

当路由器提供加速服务后，SDK 会周期性触发 wlAccStats 回调，报告 Wi-Fi 加速效果，并在 Wi-Fi 连接质量不佳时触发 wlAccMessage 回调，报告 Wi-Fi 连接质量不佳的原因和改善 Wi-Fi 连接的操作建议。

如果你不需要使用 Wi-Fi 加速功能，可以在加入频道前调用 enableWirelessAccelerate(NO) 关闭该功能。

声网提供的 Wi-Fi 加速功能除应用于音频流，还可以应用于其他第三方业务流，如私有信令、课件、RTMP 协议等。如有需要，请联系 sales@agora.io。

改进

1. 云代理

为丰富云代理的适用场景，该版本对云代理类型（proxyType）进行了如下改进：

  • AgoraNoneProxy(0) 由不使用云代理变更为自动模式。在该模式下，SDK 优先连接 SD-RTN™，如果连接失败，自动切换到 TCP/TLS 443。自 v3.6.2 起，SDK 默认开启该模式。
  • 新增 AgoraTcpProxy(2)，表示 TCP（加密）代理模式。在该模式下，SDK 始终通过 TCP/TLS 443 传输数据。

同时，该版本新增 didProxyConnected 回调，报告 SDK 连接代理的状态。例如，当用户调用 setCloudProxy 设置代理并成功加入频道后，SDK 会触发该回调，报告用户 ID，连接的代理类型和从调用 joinChannelByToken 到 SDK 触发该回调的经过的时间。

2. 音频录制

该版本扩展了 startAudioRecordingWithConfig 的功能，支持设置录制双声道和更高的音质：

  • 通过在 AgoraAudioRecordingConfiguration 中新增 recordingChannel，允许用户设置录制的音频声道为单声道或双声道。因为实际录制的音频声道与采集的音频声道有关，集成方案也会影响最终录制的音频声道，所以如需通过 startAudioRecordingWithConfig 录制立体声，请联系技术支持协助。
  • 通过在 AgoraAudioRecordingConfiguration.recordingQuality 中新增 AgoraAudioRecordingQualityUltraHigh(3)，允许用户设置录制的音质为超高音质。超高音质是 recordingQuality 中提供的最高音质。当采样率为 32000 Hz，以超高音质录制 10 分钟的 AAC 音频文件时，文件大小约为 7.5 M。

3. 播放音乐文件优化

该版本优化了调用 startAudioMixing 播放音频文件的体验，具体如下：

如果你希望体验这些优化，请确保已集成 AgoraFullAudioFormatExtension.xcframework 动态库。考虑到该库的体积较大，如果你对 app 体积有限制且不需要体验这些优化，你可以在集成 SDK 时自行删除该动态库。详见减少 App 体积。

4. 音频文件格式

该版本新增支持播放如下格式的音频文件：

  • MP4 格式的单音轨在线文件。
  • M4A 和 MP4 格式的多音轨在线文件。

对于 MP4 和 M4A 格式的在线文件，媒体信息（moov）必须在媒体数据（mdat）之前。

5. 音频设备出错

为方便获取系统电话对音频采集的影响，该版本在 AgoraAudioLocalError 中新增 AgoraAudioLocalErrorInterrupted(8)，报告音频采集被系统电话中断。

问题修复

该版本修复了如下问题：

  • 通过 startAudioMixing 播放特定的 WAV 音频文件，播放一段时间后会出现无声。
  • 高抖动网络下，音频卡顿。
  • 弱网环境下，调用 startAudioMixing 成功后，时隔 3 秒才收到 localAudioMixingStateDidChanged 回调。
  • 偶现崩溃。

API 变更

新增

  • enableWirelessAccelerate
  • wlAccStats
  • wlAccMessage
  • AgoraAudioRecordingConfiguration 中新增 recordingChannel
  • AgoraAudioRecordingConfiguration.recordingQuality 中新增 AgoraAudioRecordingQualityUltraHigh(3)
  • didProxyConnected
  • AgoraCloudProxyType 中新增 AgoraTcpProxy(2)
  • AgoraAudioLocalError 中新增 AgoraAudioLocalErrorInterrupted(8)

修改

  • AgoraCloudProxyType 中的 AgoraNoneProxy(0) 的行为

3.6.1.1 版

该版本于 2022 年 1 月 16 日发布，修复了 Web 用户恢复发送音频流后，3.6.0 或之后版本的 Native 用户可能听不到 Web 用户声音的问题。

3.6.1 版

该版本于 2022 年 1 月 12 日发布。

该版本修复了如下问题：

  • 对带端口号的 RTMP 推流地址解析异常而导致的推流失败。
  • 偶现崩溃。
  • 调用 startAudioMixing 无法播放以 “ipod-library://” 开头的本地 iTunes 音乐文件。

3.6.0.1 版

该版本于 2021 年 12 月 10 日发布，修复了 3.6.0 版将动态库 Agorafdkaac.xcframework 错误地更名为 AgoraFDKAACExtension.xcframework 的问题。

3.6.0 版

该版本于 2021 年 12 月 7 日发布。

升级必看

旁路推流

为降低旁路推流集成难度，该版本优化了推流 API 设计，并改善了推流客户端和服务端内部对网络问题的处理机制。你可以通过该版本新增的如下方法体验优化后的旁路推流功能：

  • startRtmpStreamWithoutTranscoding: 开始非转码推流。与旧推流方法 addPublishStreamUrl(NO) 作用相同。
  • startRtmpStreamWithTranscoding: 开始 CDN 直播推流并设置转码属性。与依次调用旧推流方法 setLiveTranscoding、addPublishStreamUrl(YES) 的作用相同。
  • updateRtmpTranscoding: 更新转码属性。与非首次调用旧推流方法 setLiveTranscoding 的作用相同。
  • stopRtmpStream: 结束 CDN 直播推流。与旧推流方法 removePublishStreamUrl 作用相同。

该版本废弃 addPublishStreamUrl、setLiveTranscoding、removePublishStreamUrl 这三个旧推流方法，声网推荐你使用新的推流方法，并参考《旁路推流》更新你的业务代码逻辑。

同时，自该版本起，不管你使用新推流方法还是旧推流方法，你都可以体验如下改进：

  • 推流状态、错误、事件透明：

    • 在 AgoraRtmpStreamingState 状态码中新增 AgoraRtmpStreamingStateDisconnecting(5)：SDK 正在与声网推流服务器和 CDN 服务器断开连接。当你调用 remove 或 stop 方法正常结束推流时，SDK 会依次报告推流状态为 Disconnecting、Idle。

    • 在 AgoraRtmpStreamingErrorCode 错误码中新增如下：

      • AgoraRtmpStreamPublishErrorNotBroadcaster(11)：用户角色不是主播，该用户无法使用推流功能。请检查你的应用代码逻辑。
      • AgoraRtmpStreamPublishErrorTranscodingNoMixStream(13)：非转码推流情况下，调用了 update 或 setLiveTranscoding 方法更新转码属性。请检查你的应用代码逻辑。
      • AgoraRtmpStreamPublishErrorNetDown(14)：主播的网络出错。
      • AgoraRtmpStreamPublishErrorInvalidAppId(15)：你的 App ID 没有使用声网推流服务的权限。请参考前提条件开启推流服务。

    • 在 AgoraRtmpStreamingEvent 事件码中新增如下：

      • AgoraRtmpStreamingEventAdvancedFeatureNotSupport(3)：功能不支持。
      • AgoraRtmpStreamingEventRequestTooOften(4)：预留参数。
      为保障推流质量，请务必根据推流状态码、错误码、事件码对业务逻辑进行处理。

  • 转码推流时，使用 HE-AAC v2 音频编解码器：通过在 AgoraAudioCodecProfileType 中新增 AgoraAudioCodecProfileHEAACv2 实现。

问题修复

该版本修复了如下问题：

  • 频道内主播将用户角色切换为观众，再切换回主播后，观众听该主播的声音带有变声效果。
  • 用户使用第三方音乐播放器播放音乐并设置音频场景为 AgoraAudioScenarioChatRoomGaming 后，加入频道会中断第三方音乐播放器播放的音乐。
  • 播放原唱歌曲时，调用 setAudioMixingPitch 调整音调会导致播放的歌曲从原唱切换为伴奏。

API 变更

新增

修改

将 lighteningLevel 的默认值从 0.7 改为 0.6

3.5.2 版

该版本于 2021 年 11 月 25 日发布。

升级必看

1. 加入频道失败时返回的错误码变更

为准确报告加入频道失败的原因，自该版本起，在如下情况，SDK 直接在加入频道方法的返回值中返回 -17(AgoraErrorCodeJoinChannelRejected)：

  • 当已经加入 AgoraRtcEngineKit 频道的用户使用有效的频道名再次调用 AgoraRtcEngineKit 类中的加入频道方法。
  • 当已经加入某个 AgoraRtcChannel 频道的用户再次调用该 AgoraRtcChannel 对象的加入频道方法。

在之前的版本中，发生上述错误时，SDK 可能通过 didOccurError 回调报告错误码 17，或在加入频道方法的返回值中返回 -5(AgoraErrorCodeRefused)。

2. 蓝牙规范选择

为确保与蓝牙耳机的连接，自该版本起，当通信场景下的用户或直播场景下的主播使用蓝牙耳机时，SDK 会检测设备是否支持蓝牙免提规范（Hands-Free Profile, HFP）并根据检测结果选择蓝牙规范，具体如下：

  • 在支持 HFP 的设备上，SDK 依然使用蓝牙免提规范（Hands-Free Profile, HFP），通过蓝牙耳机采集和播放音频。
  • 在不支持 HFP 的设备上，SDK 改为使用蓝牙立体声音频传输规范（Advance Audio Distribution Profile, A2DP）协议，通过设备的麦克风采集、蓝牙耳机播放音频。

新增特性

音频通话回路测试

为方便用户自行检查本地音频设备、网络状态能否保障正常发送、接收音频流，该版本新增 startEchoTestWithConfig 方法。你可以在加入频道前调用该方法，以测试用户的音频设备和网络回路是否正常。

相比 startEchoTestWithInterval，startEchoTestWithConfig 可保障测试的安全性，不支持设置返回测试结果的时间间隔。

问题修复

该版本修复了该问题：在某些 Android 机型上调用 startAudioMixing 时，远端用户听到的人声和伴奏有轻微的不同步。

API 变更

该版本新增 startEchoTestWithConfig。

3.5.1 版

该版本于 2021 年 10 月 13 日发布。

新增特性

1. 暂停/恢复跨频道媒体流转发

为方便跨频道连麦中的主播快速暂停或恢复媒体流转发，该版本新增如下方法和和状态码：

  • pauseAllChannelMediaRelay：暂停向所有目标频道转发媒体流。
  • resumeAllChannelMediaRelay：恢复向所有目标频道转发媒体流。
  • AgoraChannelMediaRelayEventPauseSendPacketToDestChannelSuccess(12)：成功暂停向目标频道转发媒体流。
  • AgoraChannelMediaRelayEventPauseSendPacketToDestChannelFailed(13)：暂停向目标频道转发媒体流失败。
  • AgoraChannelMediaRelayEventResumeSendPacketToDestChannelSuccess(14)：成功恢复向目标频道转发媒体流。
  • AgoraChannelMediaRelayEventResumeSendPacketToDestChannelFailed(15)：恢复向目标频道转发媒体流失败。

成功调用 pauseAllChannelMediaRelay 或 resumeAllChannelMediaRelay 方法后，SDK 会触发 didReceiveChannelMediaRelayEvent 回调，并在回调中报告是否成功暂停或恢复媒体流转发。

2. 推送外部音频帧到指定位置

为满足不同场景对外部音频帧的不同处理要求，该版本废弃 pushExternalAudioFrameRawData [1/2] 和 pushExternalAudioFrameSampleBuffer [1/2]，并新增带 sourcePos 参数的 pushExternalAudioFrameRawData [2/2] 和 pushExternalAudioFrameSampleBuffer [2/2] 替代。你可以将外部音频帧推送到音频采集后、编码前或本地播放前的位置。例如，在 KTV 场景中，将歌声推送到音频采集后的位置，将伴奏推送到音频编码前的位置，既让歌声经过 SDK 音频模块的处理，又让伴奏不受 SDK 音频模块的影响。

该版本还新增了 setExternalAudioSourceVolume，你可以设置指定位置的外部音频帧音量。

3. 音乐文件高级设置

为设置音乐文件的播放速度、音轨和声道模式，该版本新增如下方法：

  • setAudioMixingPlaybackSpeed: 设置当前音乐文件的播放速度。声网推荐取值范围为 [50,400]，100 表示原始速度。
  • getAudioTrackCount: 获取当前音乐文件的音轨数量。
  • selectAudioTrack: 指定当前音乐文件的播放音轨。指定音轨的索引取值范围为 [0, getAudioTrackCount())。
  • setAudioMixingDualMonoMode: 设置当前音乐文件的声道模式为原始模式、左声道模式、右声道模式或混合模式。

4. 获取音频文件信息

为获取任意音频文件的信息，该版本废弃 getAudioMixingDuration 并新增 getAudioFileInfo 替代。加入频道后，你可以调用 getAudioFileInfo 并通过 didRequestAudioFileInfo 回调获取指定音频文件的时长等信息。

改进

1. 5G 移动网络的识别和质量测试

该版本新增对 5G 移动网络的识别和质量测试，具体如下：

  • 在 AgoraNetworkType 中新增 AgoraNetworkTypeMobile5G (6) 枚举，当本地网络切换为 5G 时，SDK 触发 networkTypeChangedToType 回调报告该网络连接类型。
  • 支持调用 enableLastmileTest 或 startLastmileProbeTest 测试 5G 网络连接质量。

2. 其他改进

该版本还提升了开启 AI 降噪后使用部分蓝牙耳机时的音频体验。

问题修复

该版本修复了如下问题：

  • AgoraAudioScenarioGameStreaming 场景下，偶现因音乐检测不准确导致的回声或噪声。
  • 未播放音频文件就调用 pauseAudioMixing，之后再调用 startAudioMixing 播放音频文件，播放失败。
  • 本地用户调用 muteAllRemoteAudioStreams，收到 remoteAudioStateChangedOfUid (AgoraAudioRemoteReasonLocalMuted) 15 秒后，错误地收到了 remoteAudioStateChangedOfUid (AgoraAudioRemoteReasonRemoteMuted)。
  • 音频场景下偶现崩溃。
  • 在部分低端 iOS 设备上，app 在屏幕共享时退后台后，因占用内存超出限制被系统强制关闭。
  • 调用 setAudioSessionOperationRestriction 后，偶现的远端音频无声。
  • 自 3.4.5 版本起，连续多次调用 joinChannelByToken 方法时，返回值不准确。
  • 加入频道前调用 enableExternalAudioSourceWithSampleRate 不生效。
  • 在频道内调用 enableLocalAudio(NO) 后，SDK 额外触发 localAudioStateChange 回调报告 AgoraAudioLocalStateRecording(1)。

API 变更

新增

  • pauseAllChannelMediaRelay
  • resumeAllChannelMediaRelay
  • AgoraChannelMediaRelayEvent 中新增以下枚举：
    • AgoraChannelMediaRelayEventPauseSendPacketToDestChannelSuccess
    • AgoraChannelMediaRelayEventPauseSendPacketToDestChannelFailed
    • AgoraChannelMediaRelayEventResumeSendPacketToDestChannelSuccess
    • AgoraChannelMediaRelayEventResumeSendPacketToDestChannelFailed
  • pushExternalAudioFrameRawData [2/2]
  • pushExternalAudioFrameSampleBuffer [2/2]
  • setExternalAudioSourceVolume
  • setAudioMixingPlaybackSpeed
  • getAudioTrackCount
  • selectAudioTrack
  • setAudioMixingDualMonoMode
  • getAudioFileInfo
  • didRequestAudioFileInfo
  • AgoraNetworkType 中新增 AgoraNetworkTypeMobile5G

废弃

  • pushExternalAudioFrameRawData [1/2]
  • pushExternalAudioFrameSampleBuffer [1/2]
  • getAudioMixingDuration

3.5.0.4 版

该版本于 2021 年 9 月 26 日发布。

改进

为改善使用蓝牙耳机时的音质，该版本优化了 SDK 选择蓝牙规范和音量类型的逻辑：

  • 蓝牙规范：自该版本起，SDK 使用的蓝牙规范仅受用户角色影响：

    • 如果通信场景下的用户或直播场景下的主播使用蓝牙耳机，则蓝牙耳机通过蓝牙免提规范（Hands-Free Profile, HFP）采集和播放音频。
    • 如果直播场景下的观众使用蓝牙耳机，则蓝牙耳机通过蓝牙立体声音频传输规范（Advance Audio Distribution Profile, A2DP）播放音频。

  • 音量类型：该版本规范了音量类型。用户使用蓝牙耳机时，SDK 使用的音量类型如下：

    音频应用场景 通信场景下的用户或直播场景下的主播 直播场景下的观众
    Default 通话音量 媒体音量
    ChatRoomGaming 通话音量 通话音量
    GameStreaming 媒体音量 媒体音量
    ChatRoomEntertainment 通话音量 通话音量
    Education 通话音量 媒体音量
    ShowRoom 通话音量 媒体音量
    Meeting 媒体音量 媒体音量

问题修复

该版本修复了如下问题：

  • 头文件中重复声明 didAudioMuted、didVideoEnabled、didLocalVideoEnabled、firstRemoteVideoDecodedOfUid 函数。
  • 调用 startAudioMixing 成功播放音乐后，多次调用 setAudioMixingPosition 设置音乐文件的播放位置，音乐文件大概率会从头播放。
  • 在 AgoraAudioScenarioChatRoomGaming 的音频场景下，频道内用户将角色由观众切换为主播的瞬间，该用户听滋啦杂音。

3.5.0.3 版

该版本于 2021 年 9 月 6 日发布，修复了如下问题：

  • 偶现的崩溃问题。
  • 声网 SDK 与声网 RTM SDK 的 AgoraReachability 命名冲突。

3.5.0.1 版

该版本于 2021 年 8 月 4 日发布，修复了：因 AgoraRtcEngineKit 强引用 AgoraRtcEngineDelegate，导致 AgoraRtcEngineDelegate 对象只有在 AgoraRtcEngineKit 销毁时才释放且产生内存堆积。

3.5.0 版

该版本在 AgoraRtcEngineKit 强引用 AgoraRtcEngineDelegate 的情况下会发生内存堆积。如果你设置了 AgoraRtcEngineKit 强引用 AgoraRtcEngineDelegate，声网推荐你跳过该版本，升级到 3.5.0.1 版本。详见 3.5.0.1 版。

该版本于 2021 年 7 月 20 日发布。

新增特性

原始音频数据多频道支持

在多频道场景下，为方便获取各频道的远端音频数据，该版本在 AgoraAudioFrame.h 中新增如下回调：

  • isMultipleChannelFrameWanted
  • onPlaybackAudioFrameBeforeMixingEx

成功注册音频观测器后，如果你将 isMultipleChannelFrameWanted 的返回值设为 YES，并将 getObservedAudioFramePosition 的返回值设为 AgoraAudioFramePositionBeforeMixing (1 << 3)，SDK 会触发 onPlaybackAudioFrameBeforeMixingEx 回调，向你发送多个频道的远端用户音频数据。

改进

在开启 AGC 的场景下，该版本缩短了降噪收敛的时间，从而降低了噪声忽大忽小的波动。

问题修复

该版本修复了如下问题：

  • 远端用户调用 enableLoopbackRecording 后，偶现本地用户听到自己的回声。
  • 会议场景下，远端用户在频道内开启本地音频采集后，偶现本地用户听远端用户有回声。
  • 调用 muteLocalAudioStream(YES) 停止发布本地音频后，用户第一次加入频道可以听到远端用户，但退出频道后再次加入频道偶现无法听到远端用户。
  • 本地网络环境较差时，SDK 报告的远端用户的下行网络质量 （rxQuality）不准确。
  • reportRtcStats 回调报告的 memoryTotalUsageRatio 的值不准确。

API 变更

新增

3.4.6 版

该版本在 AgoraRtcEngineKit 强引用 AgoraRtcEngineDelegate 的情况下会发生内存堆积。如果你设置了 AgoraRtcEngineKit 强引用 AgoraRtcEngineDelegate，声网推荐你跳过该版本，升级到 3.5.0.1 版本。详见 3.5.0.1 版。

该版本于 2021 年 7 月 15 日发布，修复了如下问题：

  • 特定场景下，SDK 初始化时偶现崩溃。
  • Objective-C 头文件缺失 nonnull、 _Nullable 修饰符导致运行项目时出现警告。
  • 调用 startAudioMixing 时传入经过百分号编码后的 URL，对应的在线音频文件播放失败。

3.4.5 版

该版本在 AgoraRtcEngineKit 强引用 AgoraRtcEngineDelegate 的情况下会发生内存堆积。如果你设置了 AgoraRtcEngineKit 强引用 AgoraRtcEngineDelegate，声网推荐你跳过该版本，升级到 3.5.0.1 版本。详见 3.5.0.1 版。

该版本于 2021 年 6 月 22 日发布。

升级必看

1. 支持 GCM2 加密

为进一步提升实时音视频传输过程的安全性，该版本进行如下优化：

  • 在 AgoraEncryptionMode 中新增 AgoraEncryptionModeAES128GCM2 (7) 和 AgoraEncryptionModeAES256GCM2 (8) 加密模式。新的 GCM 加密模式使用了安全性更高的密钥派生函数，支持设置密钥和盐。
  • 在 AgoraEncryptionConfig 中新增 encryptionKdfSalt 成员，用于为 AgoraEncryptionModeAES128GCM2 (7) 和 AgoraEncryptionModeAES256GCM2 (8) 加密模式设置盐。

此外，该版本将默认的加密模式由 AgoraEncryptionModeAES128XTS (1) 修改为 AgoraEncryptionModeAES128GCM2 (7)。如果你原来使用了默认的加密模式，将 SDK 升级到 v3.4.5 之后，请务必调用 enableEncryption 并将 AgoraEncryptionMode 设置为 AgoraEncryptionModeAES128XTS (1)。

更多介绍见媒体流加密。

开启加密功能后，同一频道内的所有用户都必须使用相同的加密模式和密钥，包括服务端用户（例如声网录制服务）。

2. 音频流发布行为变更

为方便用户灵活控制多个频道中的发布状态，该版本对 AgoraRtcChannel 类进行如下优化：

  • 废弃 publish 和 unpublish，并新增 muteLocalAudioStream 作为替代。你可以设置音频流发布状态。
  • 在 AgoraRtcChannelMediaOptions 中新增 publishLocalAudio 成员，默认值为 YES。你可以在加入频道时设置音频流的发布状态。如果用户已在一个频道中发流，则不论用户是主播还是观众，都需要在加入其他频道时设置 publishLocalAudio 为 NO。否则，加入频道会失败。
  • 调用 setClientRole(AgoraClientRoleBroadcaster) 后，本地用户默认发布音频流，无需再调用 publish。
publishLocalAudio = NO 和 muteLocalAudioStream(YES) 的功能相同，所以搭配使用时，后调用的 API 生效。

上述优化也带来了 AgoraRtcEngineKit 类的部分行为变更：

  • AgoraRtcEngineKit 类的 muteLocalAudioStream 对通过 AgoraRtcChannel 类创建的频道不生效，你需要改用 AgoraRtcChannel 类的 muteLocalAudioStream。
  • 通过带 options 参数的 joinChannelByToken 加入频道时，你可以设置音频流的发布状态。
  • 如果使用带 options 参数的 joinChannelByToken 加入频道，muteLocalAudioStream 只有在加入频道后调用才生效。

如果你将 SDK 升级到 v3.4.5 或之后版本，为保证你的业务功能不受影响，声网推荐你修改 muteLocalAudioStream、publish 及 unpublish 的实现。

更多介绍见设置发布状态和加入多频道。

3. 原始音频数据

原始音频数据可用于实现各种自定义音频处理功能，如音频录制和混音。为开发难度为并支持精准地观测特定节点的音频数据，该版本对原始音频数据 API 进行如下优化：

  • 将 setAudioFrameDelegate 方法改名为 setAudioDataFrame，将 AgoraAudioFrameDelegate 协议名改为 AgoraAudioDataFrameProtocol。

  • 为方便获取传输各阶段预期格式的原始音频数据，在 AgoraAudioDataFrameProtocol 中新增如下回调：

    • getObservedAudioFramePosition：设置音频观测位置。
    • getRecordAudioParams：设置 onRecordAudioFrame 回调数据的格式。
    • getPlaybackAudioParams：设置 onPlaybackAudioFrame 回调数据的格式。
    • getMixedAudioParams：设置 onMixedAudioFrame 回调数据的格式。

如果你将 SDK 升级到 v3.4.5 或更高版本，为保证你的业务功能不受影响，请确保修改 setAudioFrameDelegate 和 AgoraAudioFrameDelegate 的实现。

4. startAudioMixing 变更

为避免阻塞，该版本将 startAudioMixing由同步调用改为异步调用。

改进

1. CDN 推流

为向用户透明更多的旁路推流错误和事件，该版本新增如下：

  • 在 rtmpStreamingChangedToState 中新增错误码 AgoraRtmpStreamingErrorCodeUnpublishOK (100): 报告推流已正常结束。当你调用 removePublishStreamUrl 结束推流时，SDK 会返回该错误码和状态码 AgoraRtmpStreamingStateIdle (0)。
  • 在 rtmpStreamingEventWithUrl 中新增事件码 AgoraRtmpStreamingEventUrlAlreadyInUse (2): 报告该推流 URL 已用于推流。如果你想开始新的推流，请使用新的推流 URL。

2. 应用在 M1 Mac 运行

该版本支持在 M1 Mac 真机上运行集成了声网iOS SDK 的 app。由于 M1 Mac 和 iPhone、iPad 存在硬件差异，声网iOS SDK 在 M1 Mac 上不支持 iPhone、iPad 特有的硬件行为。例如，不支持将音频路由切换到听筒模式，不支持后置摄像头等。

3. 音乐文件状态

在 pauseAudioMixing 后调用 startAudioMixing 时，该版本在报告 localAudioMixingStateDidChanged(AgoraAudioMixingStatePlaying, AgoraAudioMixingReasonStartedByUser) 状态之前新增了 localAudioMixingStateDidChanged(AgoraAudioMixingStateStopped, AgoraAudioMixingReasonStoppedByUser) 状态，提示已停止播放音乐文件。

问题修复

该版本修复了如下问题：

  • 在弱网环境下，调用 startAudioMixing 播放在线音乐文件时，偶现 SDK 响应时间过长而引起卡顿。
  • 弱网环境下，偶现用户无法切换角色。

API 变更

新增

修改

废弃

  • AgoraRtcChannel 类的 publish 和 unpublish

3.4.4 版

该版本于 2021 年 6 月 18 日发布，对 iOS 15 进行了兼容性适配。

3.4.3 版

该版本于 2021 年 6 月 16 日发布，修复了如下问题：

  • Objective-C 头文件缺失 nonnull、 _Nullable 修饰符导致运行项目时出现警告。
  • 调用 startAudioMixing 无法播放扩展名为 m4a 的 MP3 本地音乐文件。
  • 3.0.0+ 版本的用户离开有 3.0.0 之前版本的用户的通信频道，并切换频道场景为直播场景后，在加入下一个频道前切换用户角色为主播，但设置未生效。
  • 特定场景下，用户加入频道 10 分钟后偶现音频延迟。

3.4.2 版

该版本于 2021 年 5 月 11 日发布，修复了特定场景下偶现的崩溃问题。

如果你从教育版本（2.3.4.10x 或 2.9.0.10x）迁移至 3.4.2 及之后版本，为避免兼容性问题，请确保你调用了 setAudioProfile 并将 scenario 设置为 AgoraAudioScenarioEducation。

3.4.1 版

该版本于 2021 年 4 月 22 日发布，修复了如下问题：

  • 在特定的基础变声场景下，出现崩溃。
  • 3.4.0 版中因 Non-public API usage 错误导致应用无法上架 Apple App Store。

3.4.0 版

该版本于 4 月 16 日发布。

升级必看

集成变更

为减少集成 SDK 后的 app 体积，该版本将部分功能以插件列表（命名以 Extension 为后缀）的形式发布，详见插件列表。如果你不需要使用相关插件功能，你可以直接删除对应的插件并重新编译项目。

行为变更

为监听音乐文件播放状态改变的原因，该版本对 localAudioMixingStateDidChanged 回调进行如下修改：

  • 将 errorCode 参数修改为 reason 参数。
  • 废弃 AgoraAudioMixingErrorCode，并新增 AgoraAudioMixingReasonCode 替代。通过 AgoraAudioMixingReasonCode，你可以获取播放开始、暂停、停止或失败的原因。
  • 修改 AgoraAudioMixingStateCode 的部分逻辑。例如，循环播放音乐时，播放完成或开始播放都会触发 AgoraAudioMixingStatePlaying 状态。

如果你将 SDK 升级到 v3.4.0 或更高版本，为保证你的业务功能不受影响，声网推荐你修改 localAudioMixingStateDidChanged 的实现。

新增特性

1. 虚拟节拍器

为满足在线教学等场景对节拍器的需求，该版本新增如下方法：

  • startRhythmPlayer: 开启虚拟节拍器。
  • stopRhythmPlayer: 关闭虚拟节拍器。
  • configRhythmPlayer: 在开启虚拟节拍器后，重新配置虚拟节拍器。

2. 音效文件播放进度

为控制音效文件的播放进度，该版本新增如下方法：

  • playEffect3: 通过 startPos 参数，在播放音效文件时设置播放位置。
  • setEffectPosition: 在播放音效文件后，设置音效文件的播放位置。
  • getEffectDuration: 获取本地音效文件的总时长。
  • getEffectCurrentPosition: 获取音效文件的播放进度。

同时，该版本废弃 playEffect2，请使用 playEffect3 替代。

改进

1. 音乐文件播放进度

为方便控制音乐文件的播放进度，该版本废弃 startAudioMixing 并新增同名方法替代。新方法允许你通过 startPos 参数在播放音乐文件时设置播放位置。

2. AirPlay 回调

该版本新增支持在 iOS 设备中触发 didAudioRouteChanged 回调并报告 AgoraAudioOutputRoutingAirPlay。当用户在 iOS 设备上使用 Apple AirPlay 播放音频时，SDK 会触发该回调。

3. 客户端录音

为在录音时设置录音内容，该版本新增 startAudioRecordingWithConfig 方法并废弃 startAudioRecording2。通过 startAudioRecordingWithConfig 的 config 参数，你可以设置录音音质、内容、采样率及录音文件的存储路径。

该版本还新增了错误码 AgoraErrorCodeAlreadyInRecording(160)。如果你在当前录音结束前再次调用 startAudioRecordingWithConfig，SDK 会报告该错误码。

问题修复

该版本修复了调用 enableSoundPositionIndication(YES) 后 reportAudioVolumeIndicationOfSpeakers 回调的音量信息不准确的问题。

API 变更

新增

修改

废弃

  • startAudioRecording2
  • playEffect2
  • startAudioMixing1
  • AgoraAudioMixingErrorCode

3.3.2 版

该版本于 2021 年 3 月 29 日发布，修复了如下问题：

  • 长时间在后台的应用回到前台时，偶现用户无法加入频道。
  • 特定场景下，远端用户长时间无声时，本地用户听远端用户有杂音。

3.3.1 版

该版本于 2021 年 3 月 4 日发布。

新增特性

基础变声

该版本新增 setVoiceConversionPreset 方法改变用户的声音。你可以把男声变得低沉、稳重，把女声变得甜美、中性。详见设置人声效果。

改进

1. AES-GCM 加密模式

在安全要求高的场景中，为保证数据的保密性、完整性和真实性，提高数据加密的计算效率，该版本在 AgoraEncryptionMode 中新增如下枚举值：

  • AgoraEncryptionModeAES128GCM: 128 位 AES 加密，GCM 模式。
  • AgoraEncryptionModeAES256GCM: 256 位 AES 加密，GCM 模式。
开启加密功能后，同一频道内的所有用户都必须使用相同的加密模式和密钥，包括服务端用户（例如声网录制服务）。

2. 远端音频统计

为监测通话中与音频相关的主观体验，该版本在 remoteAudioStats 中增加 mosValue，报告声网实时音频 MOS（平均主观意见分）评估系统对接收到的远端音频流的质量评分。

问题修复

该版本修复了开启听声辨位后，无法通过 reportAudioVolumeIndicationOfSpeakers 回调获取远端用户音量的问题。

API 变更

新增

3.3.0 版

该版本于 2021 年 1 月 22 日发布。

升级必看

1. 集成变更

为符合 Apple 对使用模拟器运行项目的要求，该版本对 SDK 包修改如下：

  • 所有动态库由 Framework 格式修改为 XCFramework 格式。XCFramework 格式的动态库支持在真机和模拟器上运行项目。
  • 移除原有的 ALL_ARCHITECTURE 文件夹。

该版本还新增了声网基础计算框架 AgoraCore.xcframework。

请参考集成 SDK 将 SDK 集成至你的项目。

2. 订阅行为变更

该版本废弃了 setDefaultMuteAllRemoteAudioStreams，并修改了 mute 相关方法的如下行为：

  • mute 相关方法需要在加入频道或切换频道后调用，否则会不生效。
  • mute 相关方法都能独立控制用户的订阅状态。一起调用 muteAll 为前缀的方法和 muteRemote 为前缀的方法时，后调用的方法会生效。
  • muteAll 为前缀的方法设置是否订阅所有音频流，包含调用时刻之后加入频道的用户的音频流，即 muteAll 为前缀的方法包含了 setDefaultMute 为前缀的方法的功能。声网不推荐一起调用 muteAll 和 setDefaultMute 为前缀的方法，否则设置可能会不生效。

更多介绍见设置订阅状态。

3. 人声状态行为变更

在远端用户的 reportAudioVolumeIndicationOfSpeakers 回调中，该版本将 vad 成员的值由始终为 0 修改为始终为 1。

新增特性

1. 频道媒体选项

为方便开发者更灵活地控制媒体流订阅，该版本新增 joinChannelByToken2 和 switchChannelByToken2 方法，支持设置用户加入频道和切换频道时是否订阅频道内所有的远端音频流。

2. 云代理

为提升声网云代理的易用性，该版本新增 setCloudProxy 方法设置云代理并允许你选择连接 UDP 协议的云代理。详见云代理。

3. AI 降噪

为在传统降噪模式的基础上消除非平稳噪声，该版本新增 enableDeepLearningDenoise，用于开启 AI 降噪模式。

开启 AI 降噪前，请将 AgoraAIDenoiseExtension.xcframework 动态库集成到你的项目文件中。

4. 歌唱美声

在歌唱场景中，为美化歌声并添加混响效果，该版本新增 setVoiceBeautifierParameters，并在 AgoraVoiceBeautifierPreset 中添加 AgoraSingingBeautifier 常量。

你可以调用 setVoiceBeautifierPreset(AgoraSingingBeautifier) 美化男声并添加歌声在小房间的混响效果。如需更多设置，你可以调用 setVoiceBeautifierParameters(AgoraSingingBeautifier, param1, param2) 美化男声或女声，并添加歌声在小房间、大房间或大厅的混响效果。

5. 设置日志文件

为保证日志内容的完整性，该版本在 AgoraRtcEngineConfig 中新增 logConfig 属性，在你初始化 AgoraRtcEngineKit 时可用于设置声网 SDK 输出的日志文件。详见如何设置日志文件。

自该版本起，声网不推荐使用 setLogFile、setLogFileSize 和 setLogFilter 方法设置日志文件。

6. 创建数据流

为了支持歌词同步、课件同步等场景，该版本废弃了原有的 createDataStream 方法，并使用新的同名方法替代，用于创建数据流，并设置数据流是否与发布到声网频道内的音频流同步以及接收到的数据是否有序。

改进

1. 原始音频数据

该版本补齐了 iOS 平台的原始音频数据接口。你可以从原始音频数据接口获取原始音频数据，并进行前处理或后处理，获取想要的播放效果。

  • setAudioFrameDelegate
  • onRecordAudioFrame
  • onPlaybackAudioFrame
  • onMixedAudioFrame
  • onPlaybackAudioFrameBeforeMixing

2. 远端音频统计

为方便监测通话中与音频有关的主观体验，该版本在 AgoraRtcRemoteAudioStats 中增加 qoeQuality 和 qualityChangedReason，报告接收远端音频时的体验质量以及体验质量较差的原因。

API 变更

新增

废弃

  • setDefaultMuteAllRemoteAudioStreams
  • setLogFile
  • setLogFileSize
  • setLogFilter
  • createDataStream

3.2.1 版

该版本于 2020 年 12 月 17 日发布，修复了如下问题：

  • IPv6 场景下的高概率崩溃问题。
  • Native 音频 SDK 的客户端与 Web 客户端互通时，Web 客户端持续报告 Client.on(disable-local-video)或 Client.on(mute-video) 回调。

3.2.0 版

该版本于 2020 年 11 月 30 日发布。

升级必看

1. 集成变更

自该版本起，SDK 包中新增以下文件：

  • Agorafdkaac.framework: Fraunhofer FDK AAC 动态库。
  • AgoraSoundTouch.framework: SoundTouch 动态库。

如果你将 SDK 升级到 v3.2.0 或更高版本，请务必参考下述步骤在集成 SDK 时添加上述动态库：

  1. 将上述文件拷贝至 AgoraRtcKit.framework 所在文件夹中。
  2. 打开 Xcode，进入 TARGETS > Project Name > General > Frameworks, Libraries, and Embedded Content 菜单，点击 +，再点击 Add Other… 添加 Agorafdkaac.framework 和 AgoraSoundTouch.framework，并确保动态库的 Embed 属性为 Embed & Sign。

此外，该版本将 SDK 包中的 AgoraRtcCryptoLoader.framework 文件合并入 AgoraRtcKit.framework 文件中。集成 AgoraRtcKit.framework 后，你可以直接使用内置加密功能。

2. 云代理

该版本优化了声网云代理架构。如果你已经在使用云代理，为避免新 SDK 和老云代理的兼容性问题，请在升级 SDK 前联系技术支持。详见云代理。

3. 安全合规

声网已通过 ISO 27001、ISO 27017、ISO 27018 国际认证，为全球用户提供安全可靠的实时互动云服务。详见 ISO 证书。

同时，为支持传输层加密，该版本新增 TLS（Transport Layer Security）加密和 UDP（User Datagram Protocol）加密方式。

传输层加密导致以下指标受到影响：
  • SDK 包体积大小：数据详见《产品概述》。
  • 首帧出图时长：首帧出图时长（中位数）相比 v3.1.0 增加 0 ~ 70 ms。

    • 新增特性

    极速直播

    该版本新增 setClientRole 方法，支持设置观众的延时级别。你可以通过该方法在互动直播和极速直播之间切换：

    • 将观众的延时级别设为超低延时，使用互动直播。
    • 将观众的延时级别设为低延时，使用极速直播。

    详见极速直播产品概述。

    改进

    1. 会议场景

    为提升多人会议的音频体验，该版本在 setAudioProfile 方法中新增 AgoraAudioScenarioMeeting(8)。

    2. 美声与音效

    为提升美声与音效 API 的易用性，该版本废弃 setLocalVoiceChanger 和 setLocalVoiceReverbPreset，并新增如下方法替代：

    • setVoiceBeautifierPreset: 与 setLocalVoiceChanger 相比，该方法删除了小男孩等变声音效和空旷音效。
    • setAudioEffectPreset: 与 setLocalVoiceReverbPreset 相比，该方法新增了小男孩等变声音效、空旷音效、3D 人声音效和电音音效，并删除了摇滚和嘻哈音效。
    • setAudioEffectParameters: 对指定的音效选项进行更细节的设置。该版本支持的音效选项有 3D 人声和电音音效。

    3. 互动直播延时

    互动直播场景下，观众看直播的延时降低了约 500 ms。

    问题修复

    该版本修复了如下问题：

    • stopChannelMediaRelay 不生效的问题。
    • 特定场景下 SDK 错误地返回了 AgoraErrorCodeAdmStartRecording(1012) 错误码的问题。

    API 变更

    新增

    废弃

    • setLocalVoiceChanger
    • setLocalVoiceReverbPreset

    3.1.2 版

    该版本于 2020 年 9 月 14 日发布。

    升级必看

    为提升用户体验，防止 app 在 iOS 14.0 版本上触发查看本地网络设备的弹窗提示，该版本默认关闭本地网络连通质量报告功能。reportRtcStats 中的 gatewayRtt 参数会失效，请不要使用该参数获取客户端到本地路由器的往返延时。详见 FAQ。

    如果你不介意弹窗提示，且需启用该功能，请联系技术支持。

    问题修复

    该版本修复了推流失败的问题。

    3.1.1 版

    该版本于 2020 年 8 月 27 日发布。

    升级必看

    该版本修改了区域访问限制的区域码 AgoraAreaCode，最新区域码如下：

    • AgoraAreaCodeCN: 中国大陆。
    • AgoraAreaCodeNA: 北美区域。
    • AgoraAreaCodeEU: 欧洲区域。
    • AgoraAreaCodeAS: 除中国大陆以外的亚洲区域。
    • AgoraAreaCodeJP: 日本。
    • AgoraAreaCodeIN: 印度。
    • AgoraAreaCodeGLOB:（默认）全球。

    如你此前调用 sharedEngineWithConfig 方法时指定了访问区域，在由之前版本升级至该版本时，请确保使用正确的区域码。

    3.1.0 版

    该版本于 2020 年 8 月 11 日发布。

    新增特性

    1. 发布和订阅状态转换回调

    该版本新增以下回调方便你了解音频流当前的发布及订阅状态，有助于订阅和发布相关的数据统计：

    • didAudioPublishStateChange: 音频发布状态发生改变。
    • didAudioSubscribeStateChange: 音频订阅状态发生改变。

    2. 本地首帧发布回调

    为提示用户本地音频首帧已发布，该版本新增 firstLocalAudioFramePublished 回调。该回调取代 firstLocalAudioFrame 回调，我们推荐你不再使用 firstLocalAudioFrame 回调。

    3. 自定义数据上报

    该版本支持自定义数据上报。如需试用，请联系 sales@agora.io 开通并商定自定义数据格式。

    改进

    1. 指定访问区域完善

    该版本新增以下枚举值，在调用 sharedEngineWithConfig 创建 AgoraRtcEngineKit 实例时提供更多区域选择。指定访问区域后，集成了声网 SDK 的 app 会连接指定区域内的声网服务器。

    • AgoraIpAreaCode_JAPAN: 日本。
    • AgoraIpAreaCode_INDIA: 印度。

    2. 加密

    该版本新增 enableEncryption 方法，用于开启内置加密，并废弃原加密方法：

    • setEncryptionSecret
    • setEncryptionMode

    与原加密方法相比，该方法新增对国密 SM4 加密模式的支持，你可以根据需要选择合适的加密模式。

    3. 通话中质量透明

    该版本进一步扩充了 AgoraRtcLocalAudioStats 类和 AgoraRtcRemoteAudioStats 类的成员，提供更多音频质量相关数据。

    • AgoraRtcLocalAudioStats 类新增 txPacketLossRate，表示本端到声网边缘服务器的物理音频丢包率 (%)。
    • AgoraRtcRemoteAudioStats 类中新增 publishDuration，表示远端音频流的累计发布时长（毫秒）。

    4. 设置音频编码属性

    为提升音频性能，该版本对音频编码码率最大值进行如下优化：

    Profile 3.1.0 版本 3.1.0 版本之前
    AgoraAudioProfileDefault
  • 直播场景: 64 Kbps
  • 通信场景: 18 Kbps
    		•
  • 直播场景: 52 Kbps
  • 通信场景: 18 Kbps
    		•
    AgoraAudioProfileSpeechStandard 18 Kbps 18 Kbps
    AgoraAudioProfileMusicStandard 64 Kbps 48 Kbps
    AgoraAudioProfileMusicStandardStereo 80 Kbps 56 Kbps
    AgoraAudioProfileMusicHighQuality 96 Kbps 128 Kbps
    AgoraAudioProfileMusicHighQualityStereo 128 Kbps 192 Kbps

    5. 日志扩容

    该版本中，声网 SDK 日志文件的默认个数由 2 个增加至 5 个，单个日志文件的默认大小由 512 KB 扩大至 1024 KB。默认情况下，SDK 会生成 agorasdk.log、agorasdk_1.log、agorasdk_2.log、agorasdk_3.log、agorasdk_4.log 这 5 个日志文件。最新的日志永远写在 agorasdk.log 中。agorasdk.log写满后，SDK 会从 1-4 中删除修改时间最早的一个文件，然后将 agorasdk.log 重命名为该文件，并建立新的 agorasdk.log 写入最新的日志。

    6. 其他改进

    • 该版本对 iOS 部分机型（使用 Apple A10 及以下芯片）进行性能优化，降低了 CPU 使用率和内存占用。
    • 该版本降低了远端用户音频首帧的出声时间。

    问题修复

    该版本修复了如下问题：

    • 调用 setAudioMixingPitch 方法时，部分参数不生效。
    • 断开蓝牙设备时，偶现音频卡顿。
    • 特定场景下，收不到 setMediaMetadataDataSource 回调。
    • 多频道场景中，用户切换频道发言后，退出频道时偶现崩溃。

    API 变更

    新增

    废弃

    • setEncryptionSecret
    • setEncryptionMode
    • firstLocalAudioFrame

    删除

    • 警告码: AgoraWarningCodeAdmImproperSettings(1053)

    3.0.1 版

    该版本于 2020 年 5 月 27 日发布。

    升级必看

    iOS 静态库升级动态库

    为提升开发体验，该版本将 SDK 由静态库升级为动态库，不再支持静态库。使用动态库可以提高库的安全等级，方便 app 上传至 App Store，且避免与第三方库产生不兼容等问题。

    如果你由之前版本的静态库升级为当前版本，需要重新集成，详见升级指南。

    iOS 13.3.1 版本对动态库的支持有已知问题，已在 iOS 13.4 版本修复。

    新增特性

    1. 调整音乐文件音调

    为方便调整混音时音乐文件的播放音调，该版本新增 setAudioMixingPitch 方法。通过设置该方法的 pitch 参数，你可以升高或降低音乐文件的音调。该方法仅对音乐文件音调有效，对本地人声不生效。

    2. 变声与混响

    为提高用户的音频体验，该版本在 setLocalVoiceChanger 和 setLocalVoiceReverbPreset 中分别新增以下枚举值：

    • 新增了以 AgoraAudioVoiceBeauty 为前缀和以 AgoraAudioGeneralBeautyVoice 为前缀的枚举值，分别实现美音或语聊美声功能。
    • 新增了以 AgoraAudioReverbPresetFx 为前缀的枚举值和 AgoraAudioReverbPresetVirtualStereo，分别实现增强版混响效果和虚拟立体声效果。

    你可以查看进阶功能变声与混响了解使用方法和注意事项。

    3. 远端音频数据后处理多频道支持 (C++)

    在多频道场景下，为方便后处理各频道的远端音视频数据，该版本在 IAudioFrameObserver 类中新增 isMultipleChannelFrameWanted 和 onPlaybackAudioFrameBeforeMixingEx。

    成功注册音频观测器后，如果你将 isMultipleChannelFrameWanted 的返回值设为 true，就可以通过上述回调获取多个频道对应的音频数据。在多频道场景下，我们建议你将返回值设为 true。

    改进

    • 该版本优化了通话时的音频效果。频道中多个用户同时讲话时，不会减弱任何一方的音频效果。
    • 该版本降低了对设备整体 CPU 的占用。

    问题修复

    • 修复了 didRemoteAudioStateChanged 回调不准、音频无声、混音、声音卡顿等问题。
    • 修复了通话无法正常结束、didClientRoleChanged 回调多次等问题。

    API 变更

    该版本新增以下 API：

    3.0.0.2 版

    该版本于 2020 年 4 月 22 日发布。

    新增特性

    设置区域访问限制

    该版本新增 sharedEngineWithConfig 方法，支持在创建 AgoraRtcEngineKit 实例时指定服务器的访问区域。该功能为高级设置，适用于有访问安全限制的场景。目前支持的区域有中国大陆、北美、欧洲、亚洲（中国大陆除外）和全球（默认）。

    指定访问区域后，集成了声网 SDK 的 app 在指定区域使用时，正常情况下会连接指定区域的声网服务器；在非指定区域使用时，会从所在区域和指定区域的服务器地址中，择优选择服务器建立连接。

    问题修复

    该版本修复了无法连接蓝牙耳机的问题。

    API 变更

    新增

    sharedEngineWithConfig

    3.0.0 版

    该版本于 2020 年 3 月 4 日发布。并于 2020 年 3 月 24 日修复了偶现的音频无声、混音、didClientRoleChanged 回调多次、崩溃等问题。

    在该版本对通信场景采用了全新的系统架构，并升级了通信和直播场景下的 last mile 网络策略。在带宽不足时，新的网络策略能充分利用上下行有限带宽提升有效码率，从而增强弱网对抗能力，极大提升了弱网情况下通信和直播场景的终端用户体验。

    由于通信场景采用了新的系统架构，为保证新老版本通信用户的互通兼容，我们使用了回退机制。如果频道内有老版本通信用户加入，则当前版本 (3.0.0) 的终端用户会回退成老版本通信。一旦回退，频道内所有用户都无法享受新版本带来的体验提升。因此我们强烈推荐同步升级所有终端用户到当前版本。

    同时，我们对本地服务端录制进行了升级发布。为确保享受全新架构和网络策略优化带来的好处，使用本地服务端录制的客户，请务必同步升级本地服务端录制 SDK 至 3.0.0 版本。

    新增特性、改进与问题修复详见下文。

    升级必看

    1. 静态库更名与新增动态库

    为与其他平台保持一致，该版本将 SDK 的库名由 AgoraRtcEngineKit 变更为 AgoraRtcKit。如果你由老版本的 SDK 升级至该版本，请务必重新导入类。详细步骤见《快速开始》中的导入类章节。

    同时，为提升开发体验，该版本新增动态库支持。你可以在静态库和动态库之间任选一个进行集成，其中动态库的包名为 Agora_Native_SDK_for_iOS_v3_0_0_VOICE_Dynamic。

    使用动态库可以提高库的安全等级，方便 app 上传至 App Store，且避免与第三方库产生不兼容等问题。如果选择动态库，则需要重新进行集成并导入类。该步骤大约需要 5 分钟。详见《快速开始》中的集成 SDK 和导入类章节。

    下表展示分别使用动态库和静态库生成 ipa 文件过程中各文件体积的差异：
    库类型 ipa 体积 (M) 解压后体积 (M) Frameworks 文件夹体积 (M) 二进制文件体积 (M) Frameworks 文件夹 + 二进制文件总体积 (M)
    动态库 27 56.6 44 2.4 46.4
    静态库 26.5 55.3 30.1 15.1 45.2
    使用动态库集成时，SDK 不再存放于二进制文件中，而是作为一个独立的库存放在 Frameworks 文件夹中。与使用静态库集成相比，二进制文件体积减少了 12.7 M，Frameworks 文件夹体积增加了 13.9 M。

    新增特性

    1. 多频道管理

    为方便用户在同一时间加入多个频道，该版本新增了 AgoraRtcChannel 和 AgoraRtcChannelDelegate 类。通过创建多个 AgoraRtcChannel 对象，用户可以加入各 AgoraRtcChannel 对象对应的频道中，实现多频道功能。

    加入多个频道后，用户可以同时接收多个频道的流，但只能同时在一个频道内发流。该功能适用于用户需要同时接收多个频道的流，或频繁切换频道发流的场景。详细的集成步骤和注意事项，请参考加入多频道。

    2. 调节本地播放的指定远端用户音量

    该版本新增 adjustUserPlaybackSignalVolume 方法，用以调节本地用户听到的指定远端用户的音量。通话或直播过程中，你可以多次调用该方法，来调节多个远端用户在本地播放的音量，或对某个远端用户在本地播放的音量调节多次。

    3. 媒体播放器组件

    为丰富直播玩法，声网发布了媒体播放器组件，支持主播在直播过程中，播放本地或在线媒体资源，并同步分享给频道内所有用户。详情请参考媒体播放器组件发版说明。

    改进

    1. 音频编码属性

    为满足更高音质需求，该版本调整了直播场景下 AgoraAudioProfileDefault(0) 对应的音频编码属性，详见下表：

    SDK 版本 AgoraAudioProfileDefault(0)
    3.0.0 48 KHz 采样率，音乐编码，单声道，编码码率最大值为 52 Kbps。
    3.0.0 之前 32 KHz 采样率，音乐编码，单声道，编码码率最大值为 52 Kbps。

    2. 质量透明

    为方便开发者获取更多通话统计信息，该版本在 AgoraChannelStats 类中新增 gatewayRtt、memoryAppUsageRatio、memoryTotalUsageRatio 和 memoryAppUsageInKbytes 成员，方便更好地监控通话的质量和通话过程中的内存变动。

    3. 其他提升

    该版本自动开启直播场景下 Native SDK 与 Web SDK 的互通，并废弃原有的 enableWebSdkInteroperability 方法。

    问题修复

    • 修复了混音、音频录制、音频编码、回声等音频问题。
    • 修复了特定场景下偶现的 app 崩溃、日志文件、推流不稳定等问题。

    API 变更

    行为变更

    该版本在调用 enableLocalAudio (NO) 后，不会引起通话音量切换为媒体音量。

    新增

    废弃

    2.9.1 版

    自 2021 年 12 月 8 日起，声网启动对早于 3.0.0 版的音频 SDK、视频 SDK 的退休流程。详见部分服务下架计划。

    该版本于 2019 年 9 月 19 日发布。新增特性与修复问题列表详见下文。

    新增特性

    人声检测

    为判断本地用户是否说话，该版本在启用说话者音量提示 enableAudioVolumeIndication 方法中新增 bool 型的 report_vad 参数。启用该参数后，你会在 reportAudioVolumeIndicationOfSpeakers 回调报告的 AgoraRtcAudioVolumeInfo 结构体中获取本地用户的人声状态。

    改进

    设置客户端录音采样率

    为方便用户设置客户端录音的采样率，该版本废弃了原有的 startAudioRecording 方法，并使用新的同名方法进行取代。新的方法下，录音采样率可设为 16、32、44.1 或 48 kHz。原方法仅支持固定的 32 kHz 采样率，该版本继续保留原方法但我们不推荐使用。

    问题修复

    音频

    • 偶现音频卡顿。
    • 通话被第三方应用打断后，用户再回到频道时，音频异常。
    • 进入频道后偶现回声。

    其他

    API 变更

    为提升用户体验，声网 SDK 在该版本中对 API 进行了如下变动：

    新增

    废弃

    • startAudioRecording

    2.9.0 版

    该版本于 2019 年 8 月 16 日发布。新增特性与修复问题列表详见下文。

    升级必看

    1. 旁路推流

    该版本起，声网删除如下接口：

    • configPublisher

    如果你的 App 使用上述接口实现旁路推流功能，请确保将 Native SDK 升级至最新版本，并改用如下接口实现推流：

    新的推流实现方法，详见推流到 RTMP。

    2. 关闭/开启本地音频采集

    为提高通信场景下，本地用户关闭麦克风后听到的音质，该版本在 enableLocalAudio(true) 后，将系统音量修改为媒体音量。调用 enableLocalAudio(false) 后，系统音量自动切换为通话音量。

    新增特性

    1. 快速切换频道

    为方便直播频道中的观众用户快速切换到其他频道，该版本新增 switchChannelByToken 方法。和先调 leaveChannel，再调 joinChannelByToken 相比，该方法能实现更快的频道切换。调用 switchChannelByToken 方法切换到其他直播频道后，本地会先收到离开原频道的回调 didLeaveChannelWithStats，再收到成功加入新频道的回调 didJoinChannel。

    2. 跨频道媒体流转发

    跨频道媒体流转发，指将主播的媒体流转发至其他直播频道，实现主播跨频道与其他主播实时互动的场景。该版本新增如下接口，通过将源频道中的媒体流转发至目标频道，实现跨直播间连麦功能：

    在跨频道媒体流转发过程中，SDK 会通过 channelMediaRelayStateDidChange 和 didReceiveChannelMediaRelayEvent 回调报告媒体流转发的状态和事件。

    该场景的实现方法、API 调用时序、示例代码及开发注意事项，请参考 跨直播间连麦 指南。

    3. 本地及远端音频状态

    为方便用户了解本地及远端的音频状态，该版本新增 localAudioStateChange 和 remoteAudioStateChangedOfUid 回调。新的回调下，本地及远端音频有如下状态：

    • 本地音频：Stopped(0)、Recording(1)、Encoding(2) 和 Failed(3)。状态为 Failed(3) 时，你可以通过 error 参数中返回的错误码定位及排查问题。
    • 远端音频：Stopped(0)、Starting(1)、Decoding(2)、Frozen(3) 和 Failed(4)。你可以在 reason 参数中了解引起远端音频状态发生改变的原因。

    4. 本地音频数据

    为方便更好地了解通话质量，获取更多质量相关数据，该版本新增 localAudioStats 回调，通过 numChannels、sentSampleRate、sentBitrate 参数报告本地音频统计信息。

    5. 远端音频帧拉取

    为提升音频播放体验，该版本新增如下接口，支持使用拉取的方式获取远端音频数据。App 可以对拉取到的原始音频数据进行处理后再渲染，获取想要的音频效果。

    该方法和 onPlaybackAudioFrame 回调相比，区别在于：

    • onPlaybackAudioFrame：SDK 每 10 毫秒通过回调将音频数据传输给 App。如果 App 处理延时，可能会导致音频播放抖动。
    • pullPlaybackAudioFrameRawData / pullPlaybackAudioFrameSampleBufferByLengthInByte：App 主动拉取音频数据。通过设置音频数据，SDK 可以调整缓存，帮助 App 处理延时，从而有效避免音频播放抖动。

    改进

    1. 通话中质量透明

    该版本进一步扩充了 AgoraChannelStats 类的成员：

    • AgoraChannelStats 类：累计发送音频字节数及累计接收音频字节数

    2. 其他改进

    • 优化了 GameStreaming 场景下的音频质量。
    • 优化了通信场景下用户关闭麦克风后听到的音质。

    问题修复

    音频

    • 修复了与 Web 互通时听声辨位过程中出现的声音失真的问题。
    • 修复了使用音频 SDK 过程中出现的崩溃问题。
    • 修复了特殊场景下直播观众设置 Audio Session 为 Playback 后出现的音频卡顿问题。
    • 修复了听声辨位场景下，Web 端加入频道后，听不到声音的问题。

    其他

    • 修复了偶现的旁路推流串流的问题。
    • 修复了调用 leaveChannel 后崩溃的问题。

    API 变更

    为提升用户体验，声网 SDK 在该版本中对 API 进行了如下变动：

    新增

    废弃

    删除

    • configPublisher

    2.8.0 版

    该版本于 2019 年 7 月 8 日发布。新增特性详见下文。

    新增特性

    1. 全平台支持 String 型的用户名

    很多 App 使用 String 类型的用户名。为降低开发成本，声网新增支持 String 型的 User account，方便用户通过如下接口直接使用 App 账号加入声网频道：

    对于其他接口，声网沿用 Int 型的 UID。声网 Engine 会维护 UID 和 User account 映射表，你可以随时通过 String user account 获取 UID，或者通过 UID 获取 String user account，无需自己维护映射表。

    为保证通信质量，频道内所有用户需使用同一数据类型的用户名，即频道内的所有用户名应同为 Int 型或同为 String 型。

    Note：

    • 同一频道内，Int 型的 User ID 和 String 型的 User account 不可混用。目前支持 String 型 User account 的 SDK 如下：

      • Native SDK：v2.8.0 及之后版本
      • Web SDK：v2.5.0 及之后版本

      如果你的频道内有不支持 String 型 User account 的用户，则只能使用 Int 型的 User ID。

    • 如果你使用该版本的 Native SDK 将用户名升级至 String 型 User account，请确保所有终端用户同步升级。

    • 如果使用 String 型的 User account，请确保你的服务端用户生成 Token 的脚本已升级至最新版本。如果使用 String 型 User account 加入频道，请确保使用该 User account 或其对应的 Int 型 UID 来生成 Token。你可以调用 getUserInfoByUserAccount 来获取 User account 所对应的 UID。

    2. 音频卡顿回调

    为监控通话过程中的音频传输质量，方便开发者客观体验通信质量，该版本在远端音频统计数据 AgoraRtcRemoteAudioStats 类中新增 totalFrozenTime 和 frozenRate 成员，报告远端用户在加入频道后发生音视频的卡顿时长及卡顿率。

    同时，该版本在 AgoraRtcRemoteAudioStats 类中还新增 numChannels、receivedSampleRate 和 receivedBitrate 成员。

    改进

    为方便开发者统计掉线率，该版本在 connectionChangedToState 回调的 AgoraConnectionChangedReason 参数中添加 AgoraConnectionChangedKeepAliveTimeout(14) 成员，表示 SDK 与服务器连接保活超时，引起 SDK 连接状态发生改变。

    API 变更

    为提升用户体验，声网在 v2.8.0 版本中对 API 进行了如下变动：

    新增

    废弃

    2.4.1 版

    该版本于 2019 年 6 月 12 日发布。新增特性、功能改进与修复问题列表详见下文。

    升级必看

    如下内容涉及 SDK 的行为变更。如果你是由之前版本的 SDK 升级至该版本，升级前请务必阅读。

    RTMP 推流

    为提高推流服务的易用性，该版本对推流接口的参数设置进行了如下限制：

    类/接口 参数限制
    AgoraLiveTranscoding 类
  • videoFrameRate：设置转码推流的帧率，单位为 fps，取值范围为 [0, 30]，默认值为 15。如果设值超过 30，声网服务端会自动调整为 30
  • videoBitrate：设置转码推流的码率，单位为 Kbps，默认值为 400。用户可以根据 Video Profile 参考表中的码率值进行设置。如果设置的码率超出合理范围，服务端会在合理区间内对码率值进行自适应
  • videoCodecProfile：设置转码推流的视频编码规格，可设为 BASELINE、MAIN 或 HIGH。若设为其他值，服务端会改为默认值 *HIGH *
  • size：设置转码推流的视频分辨率。size 的最小值不低于 16 x 16
    		•
    AgoraImage 类 url：字符长度不得超过 1024 字节
    addPublishStreamUrl url：字符长度不得超过 1024 字节
    removePublishStreamUrl url：字符长度不得超过 1024 字节

    同时，该版本在 LiveTranscoding 类中新增 audioCodecProfile 参数，支持设置音频编码的规格。默认规格为 LC-AAC。

    此外，该版本还对 streamPublishedWithUrl 方法的 errorCode 参数新增了五个错误码，方便快速定位与排查问题。

    新增特性

    1、推流状态 调

    为方便推流用户了解当前的推流状态，并在推流出错时了解原因排查问题，该版本新增 rtmpStreamingChangedToState 回调。该回调下，推流有 Idle、Connecting、Running、Recovering 和 Failure 五种状态。当推流状态为 FAILURE 时，用户可以参考该回调 errCode 参数返回的错误码进行问题排查。原有的 streamPublishedWithUrl 和 streamUnpublishedWithUrl 回调仍可以使用，但我们不再推荐。

    2、网络连接失败原因 理

    为方便开发者更好地排查网络连接相关故障，该版本梳理并整合了网络连接相关的错误码，在原有 connectionChangedToState 回调的 reason 参数中新增八个导致网络连接失败的原因。新增后，只要网络连接发生错误，SDK 都会返回该回调。同时该版本废弃了原有的警告码 AgoraWarningCodeLookupChannelRejected(105) 和错误码 AgoraErrorCodeTokenExpired(109)、AgoraErrorCodeInvalidToken(110)。

    3、本地网络连接类型 调

    为方便用户了解本地网络的连接类型，该版本新增 networkTypeChangedToType 回调。该回调下，本地网络连接有 Unknown、Disconnected、Lan Wifi、2G、3G、4G 七种类型。当网络连接短暂中断时，该回调能帮助开发者辨别引起中断的原因是网络切换还是网络条件不好。

    4、获取播放伴奏 量

    为方便开发者获取伴奏的播放音量，排查音量相关问题，该版本新增 getAudioMixingPlayoutVolume 和 getAudioMixingPublishVolume 方法，用以分别获取音乐文件在本地和远端的播放音量。

    5、精确回调远端音频首帧 码

    为更精准地获取远端用户的出声时间，该版本新增 firstRemoteAudioFrameDecodedOfUid 回调，用以向 App 层报告 SDK 已完成远端音频首帧解码。在远端用户加入频道后首次发送音频，或远端用户 15 秒不发音频后再次发送时，该回调均会被触发。该回调与 firstRemoteAudioFrameOfUid 的区别在于，firstRemoteAudioFrameOfUid 在收到首个音频包时触发，先于 firstRemoteAudioDecodedOfUid。

    改进

    1、在线音效 加

    为提高用户体验，构造丰富有趣的实时音视频场景，该版本新增支持同时播放多个在线音效文件。开发者可以通过多次调用 playEffect 方法，传入不同的在线音效文件的 URL，实现音效叠加。

    2、质量 明

    3、其他 进

    • 优化了AgoraAudioScenario 为 GameStreaming 时的音质效果
    • 优化了部分场景下的语音延时
    • SDK 包大小降低约 0.5 M
    • 默认启用音频质量通知回调。开发者无需调用 enableAudioQualityIndication 方法，也可以收到 remoteAudioStats 回调
    • 提升了推流服务的稳定性

    问题修复

    音频

    • 修复了音频被 Siri 打断且无法恢复的问题

    其他

    • 修复了用户退出频道后仍然收到 networkQuality 回调的问题
    • 修复了偶现的崩溃问题，提升了系统稳定性

    API 变更

    为提升用户体验，声网在 v2.4.1 版本中对 API 进行了如下变动：

    全平台 C++ 接口行为一致

    从该版本起，Native SDK 保证了各平台 C++ 接口的行为一致性，方便用户通过统一的 C++ 接口，在各平台保持业务逻辑一致。同时在 C++ 头文件的 IRtcEngine 类中实现了 RtcEngineParameters 类下的所有方法。各接口的适用范围及使用注意事项详见声网 C++ API Reference for All Platforms 首页。

    新增

    废弃

    • enableAudioQualityIndication
    • 警告码 AgoraWarningCodeLookupChannelRejected(105)，请改用 connectionChangedToState 回调中的 AgoraConnectionChangedRejectedByServer(10)
    • 错误码 AgoraErrorCodeTokenExpired(109)，请改用 connectionChangedToState 回调中的 AgoraConnectionChangedTokenExpired(9)
    • 错误码 AgoraErrorCodeInvalidToken(110)，请改用 connectionChangedToState 回调中的 AgoraConnectionChangedInvalidToken(8)

    2.4.0 版及之前

    2.4.0 版

    该版本于 2019 年 4 月 1 日发布。新增特性、功能改进与修复问题列表详见下文。

    升级必看

    • 声网音频 SDK（iOS）在 2.4.0 版本新增 CoreML.framework 库依赖。请确保在集成时添加该库，详见集成 SDK。
    • 如果你希望通过 CocoaPods 自动导入库，请确保在运行 pod install 前，先运行 pop update 更新本地 CocoaPods 库。如果你希望通过指定 SDK 版本号获取最新版，请在 Podfile 中将版本号指定为 'AgoraRtcEngnine_iOS', '2.4.0.1'。

    新增特性

    1. 变声和混响

    在语音聊天室场景中添加变声和混响效果，能有效增强社交的趣味性。该版本在原有音效设置接口的基础上，新增 setLocalVoiceChanger 和 setLocalVoiceReverbPreset 方法，开发者无需手动设置音效参数，直接选择想要的本地语音变声或混响效果。详情请参考变声与混响。

    2. 听声辨位

    该版本新增 enableSoundPositionIndication 和 setRemoteVoicePosition 方法，支持本地用户听声辨位。用户需要在加入频道前调用 enableSoundPositionIndication 开启远端用户的语音立体声，然后在 setRemoteVoicePosition 中设置远端用户声音出现的位置，通过左右耳听到的声音差异，对远端用户的声音产生方位感。在多人在线游戏场景，如射击游戏中，该功能可以增加游戏角色的方位感，模拟真实场景。

    3. 通话前 Last-mile 网络探测

    在通话前进行 Last-mile 网络探测，可以有效帮助本地用户判断和预测上行网络质量是否良好。该版本新增通话前 Last-mile 网络探测接口 startLastmileProbeTest、stopLastmileProbeTest 及 lastmileProbeResult，向用户反馈开始通话前上下行网络的带宽、丢包、网络抖动和往返时延数据。

    4. 音乐文件播放状态

    该版本为播放音乐文件新增回调 localAudioMixingStateDidChanged，方便用户获知音乐文件的播放状态（成功/失败），以及播放出错的原因。同时新增一个警告码 701，当播放音乐文件时，本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL 时，均会触发该警告码。

    5. 设置日志文件大小

    声网 SDK 有 2 个日志文件，每个文件默认大小为 512 KB。为解决该大小无法满足部分用户需求的问题，该版本新增接口 setLogFileSize，用于设置 SDK 输出的日志文件大小。

    6. 云代理服务

    支持使用云代理服务，方便部署企业防火墙的用户正常使用声网的服务，详见使用云代理服务。

    功能改进

    1. 质量测试与透明
    2. 核心质量改进
    • 降低了音频延时
    • 提升了视频质量和稳定性
    • 缩短了远端视频的出图时间

    问题修复

    音频相关
    • 修复了调用 enableLocalAudio 接口导致的蓝牙断开的问题
    • 新增支持中文字符音乐
    • 修正 pushExternalAudioFrameSampleBuffer 成功的返回值为 YES
    • 修复了高音声音变弱的问题
    • 修复了偶现的声音快放问题
    其他
    • 统一了 Android 和 iOS 平台上 SDK 判断远端用户掉线的时间
    • 修复了转码推流场景下，SEI 信息与媒体流不同步的问题

    API 整理

    为提升用户体验，声网在 v2.4.0 版本中对 API 进行了如下变动：

    新增
    废弃
    • startEchoTest

    2.3.3 版

    该版本于 2019 年 1 月 24 日发布。修复问题详见下文。

    问题修复

    修复了 networkQuality 回调不准确的问题。

    2.3.2 版
    该版本于 2019 年 1 月 16 日发布。新增特性与修复问题详见下文。

    升级必看

    2.3.2 除了下文提到的功能和改进外，整体提升直播场景下视频弱网下抗丢包能力，提高流畅度，降低卡顿率。升级前，请了解版本兼容性:

    • Native SDK 版本号须大于等于 1.11 版本
    • Web SDK 版本号须大于等于 2.1 版本

    新增功能

    1. 控制音乐文件的播放音量

    为方便用户控制混音音乐文件在本地及远端的播放音量，该版本在已有 adjustAudioMixingVolume 的基础上新增 adjustAudioMixingPlayoutVolume 和 adjustAudioMixingPublishVolume 接口，用于分别控制混音音乐文件在本地和远端的播放音量。

    添加新的方法后，原有的 adjustPlaybackSignalVolume 由控制人声和音乐的音量改为仅控制人声的音量。因此，如果要静音本地播放，需同时设置 adjustPlaybackSignalVolume(0) 和 adjustAudioMixingPlayoutVolume(0)。

    该版本梳理了用户在音频采集到播放过程中可能会需要调整音量的场景，及各场景对应的 API，供用户参考使用。详见官网文档调整通话音量。

    改进

    1. 提供更透明的质量数据统计

    为提升质量透明的用户体验，该版本废弃了原有的 audioQualityOfUid 回调，并新增 remoteAudioStats 回调进行取代。和原来的接口相比，新接口使用更为综合的算法，通过引入音频丢帧率、端到端的音频延迟、接收端网络抖动的缓冲延迟等参数，使回调结果更贴近用户感受。同时，该版本优化了 networkQuality 的算法，对上下行网络质量采用不同的计算方法，使评分更精准。

    • remoteAudioStats：通话中远端音频流的统计信息回调。用于替换 audioQualityOfUid
    • networkQuality：通话中每个用户的网络上下行 Last mile 质量报告回调。

    声网 SDK 计划在下一个版本对如下 API 进行进一步改进：

    该版本对数据统计相关回调进行了统一梳理，相关回调及算法详见通话前检测网络质量。

    2. 改进获取 SDK 网络连接状态的生成策略

    为提升 SDK 使用数据统计的准确性和合理性，该版本新增如下接口，用以获取 SDK 的网络连接状态，以及连接状态发生改变的原因。

    该版本废弃了原有的 rtcEngineConnectionDidInterrupted 和 rtcEngineConnectionDidBanned 回调。

    在新的接口下，SDK 共有 5 种连接状态：未连接、正在连接、已连接、正在重新建立连接和连接失败。当连接状态发生改变时，都会触发 connectionChangedToState 回调。当条件满足时，原有的 rtcEngineConnectionDidInterrupted 和 rtcEngineConnectionDidBanned 回调也会触发，但声网不再推荐使用。

    3. 优化打分反馈机制

    为方便用户（开发者）收集最终用户（应用程序使用者）对使用应用进行通话或直播的反馈，该版本将 rate 接口中的打分范围缩小为 1 - 5，减少最终用户的打分干扰。声网建议在应用程序中集成该接口，方便应用程序收集用户反馈。

    4. 音乐场景的音质优化

    该版本针对高音质需求场景，如音乐教学等进行了音质改进。通过调用 setAudioProfile，将 AgoraAudioProfile 设置为 MusicHighQuality(4)，AgoraAudioScenario 设置为 GameStreaming(3) 实现，在有效消除回声、降低噪音的同时，不损害音乐的音质。

    5. 其他改进
    • 提升了推流稳定性
    • 优化了 API 的调用线程
    • 优化了 SDK 在 iOS 中低端设备上的性能
    • 增加了重新检测耳机插入和蓝牙设备连接的代码
    • 降低了音频延时

    问题修复

    音频相关：
    • 修复了设备在连接蓝牙的状态下，退出频道后，音频不走蓝牙的问题
    • 修复了调用 startAudioMixing 播放音乐文件时出现的崩溃问题
    • 修复了麦克风在禁用的状态下，设备插上耳机后，禁用失效的问题
    • 修复了外放条件下，上下麦、系统电话打断、Siri 中断、进退频道等多种场景下，出现的无法调节外放音量的问题
    • 修复了应用从后台切回前台时，出现的出声音慢的问题

    API 整理

    为提升用户体验，声网在 v2.3.2 版本中对 API 进行了如下变动：

    新增
    废弃

    2.3.1 版

    该版本于 2018 年 9 月 28 日发布。新增特性与修复问题列表详见下文。

    新增功能

    关闭/重新开启本地语音功能

    应用程序在加入频道时，语音功能是默认打开的。为满足用户只接收而不发送音频流的需求，该版本新增 enableLocalAudio 接口，方便应用程序在进入频道后关闭或重新开启本地语音功能。关闭本地语音功能后，应用程序会收到 didMicrophoneEnabled 回调，并停止采集本地音频流。该方法不影响接收和播放远端音频流。

    该功能与 muteLocalAudioStream 的区别在于前者不采集不发送，而后者是采集但不发送。

    改进

    • 优化了 iOS 低端设备在纯音频通信场景下的 CPU 消耗

    问题修复

    • 修复了某些 iOS 设备上偶现的崩溃问题
    • 修复了直播场景下，观众端因统计有误出现的延迟的问题

    2.3.0 版

    该版本于 2018 年 8 月 31 日发布。新增特性与修复问题列表详见下文。

    声网 SDK 在 v2.3.0 版本中，全面提升了视频功能的稳定性及可用性，保证了更加可靠的实时通信。同时音视频质量也得到进一步提高。 视频方面，通过优化编码性能，增强了弱网对抗能力，减少卡顿时间，提升视频流畅度；音频方面，采用深度学习算法，改进了通话中的音频质量。

    升级必看

    • 该版本新增了一个系统库依赖：Accelerate.framework。该系统库可以进行大规模的数学计算和图像计算，并针对高性能进行了优化。
    • 为更好地提升用户体验，声网 SDK 在 v2.1.0 版本中对动态密钥进行了升级。如果你当前使用的 SDK 是 v2.1.0 之前的版本，并希望升级到 v2.1.0 或更高版本，请务必参考 动态密钥升级说明 。

    新增功能

    本次发版新增如下功能：

    1. 提前 30 秒提醒 Token 即将过期

    由于 Token 具有一定的时效，在通话过程中如果 Token 即将失效，SDK 会提前 30 秒触发回调 tokenPrivilegeWillExpire，提醒应用程序更新 Token。当收到该回调时，用户需要重新在服务端生成新的 Token，然后调用 renewToken 将新生成的 Token 传给 SDK。

    2. 按用户返回音频上下行码率、帧率、丢包率及延迟

    为方便统计每个用户的音视频上下行码率、帧率及丢包率，该版本新增 audioTransportStatsOfUid 回调。 通话或直播过程中，当用户收到远端用户发送的音视频数据包后，会周期性地发生该回调上报，频率约为 2 秒 1 次。 回调中包含用户的 UID、音/视频接收码率、丢包率、以及延迟时间（毫秒）。 并在统计频道内通话相关数据的 Rtcstats 类中增加 lastmileDelay 参数，返回客户端到 vos 服务器的延迟。

    3. 设置 SDK 对 Audio Session 的管理限制

    在默认情况下，SDK 和 App 对 Audio Session 都有控制权，但某些场景下，App 会希望限制声网 SDK 对 Audio Session 的控制权限， 而使用其他应用或第三方组件对 Audio Session 进行操控。为满足该需求，本版本新增 setAudioSessionOperationRestriction 接口。 用户可以选择相应的 Restriction，来实现 SDK 不同程度的管理限制。该方法可动态使用，在加入频道前，或频道中均能调用。

    改进功能

    • 优化了一对一音视频的质量，在降低延时、防止卡顿方面提升明显。优化效果重点覆盖东南亚、南美、非洲和中东等地区
    • 直播场景下，改善了音频编码器的效率，保证通话质量的同时节省用户流量
    • 采用深度学习算法，改进了通话及直播中的音频质量

    问题修复

    • 修复了某些 iOS 设备上 App 偶发的闪退的问题
    • 修复了特定场景下某些 iOS 设备上推流后出现的崩溃问题
    • 修复了某些 iOS 设备上偶现的崩溃的问题
    • 修复了某些 iOS 设备上频繁暂停、恢复播放所有音效时出现的崩溃的问题
    • 修复了多人连麦场景下，主播频繁进出频道时，偶现的主播内存异常增长的问题
    • 修复了特定场景下偶现的主播加入频道、下麦再上麦后，远端用户听不到主播声音的问题
    • 修复了特定场景下某些 iOS 设备上偶现的接听系统电话再回到频道后，听不到声音的问题
    • 修复了特定场景下偶现的直播观众无法调节频道内通话音量的问题
    • 修复了频繁进出频道时，某些 iOS 设备上出现的崩溃的问题
    • 修复了通信场景下偶现的其他端看不到 iOS 端视频画面的问题
    • 修复了 2 人连麦过程中，一端播放背景音乐时将自己静音或关闭音频后，另一端闪退的问题
    • 修复了特定场景下，iOS 端和 Web 端互通时，Web 频繁进出频道后，iOS 设备上出现的崩溃的问题
    • 修复了特定场景下，预加载音效时某些设备上偶现的崩溃问题
    • 修复了偶现的 iOS 与 macOS 设备 无法进入频道互通的问题
    • 修复了直播场景下，使用第三方应用播放音乐时，某些 iOS 设备上出现的退出频道时崩溃的问题
    • 修复了特定场景下，某些 iOS 设备上出现的退出频道时崩溃的问题
    • 修复了直播场景下，某些 iOS 设备上出现的拉流过程中，其他用户拉流也能成功的问题
    • 修复了部分设备上偶现的使用声卡时回声的问题
    • 修复了特定场景下，某些 iOS 设备上无法调节音量的问题

    API 整理

    为提升用户体验，声网在 v2.3.0 版本中对 API 进行了梳理，并针对部分接口进行了如下处理：

    为避免在直播转码推流中添加多个相同 User，v2.3.0 版本中新增如下接口：

    • addUser
    • removeUser

    以下接口与录制相关，在 v2.3.0 版本后不再支持。声网提供专门的 Recording SDK 用于更好的录制服务，详见声网 Recording SDK 发版说明。

    • startRecordingService
    • stopRecordingService
    • refreshRecordingServiceStatus
    • didRefreshRecordingServiceStatus

    以下接口长期处于弃用状态，现进行删除，v2.3.0 版本后不再支持：

    • setSpeakerphoneVolume

    2.2.3 版

    该版本于 2018 年 7 月 5 日发布。新增特性与修复问题列表详见下文。

    升级必看

    为更好地提升用户体验，声网 SDK 在 v2.1.0 版本中对动态密钥进行了升级。如果你当前使用的 SDK 是 v2.1.0 之前的版本，并希望升级到 v2.1.0 或更高版本，请务必参考 动态密钥升级说明 。

    问题修复

    • 修复了特定场景下偶发的线上统计崩溃的问题。
    • 修复了直播时特定场景下偶发的崩溃的问题。
    • 修复了多人直播连麦时，SDK 内存增长的问题。
    • 复了偶发的无法正常反馈频道内谁在说话以及说话者音量的问题。
    • 修复了直播时偶发的观众听到主播声忽大忽小的问题。

    2.2.2 版

    该版本于 2018 年 6 月 21 日发布。修复问题列表详见下文。

    问题修复

    • 修复了特定场景下偶发的线上统计崩溃的问题
    • 修复了 iOS 设备无法同时使用媒体和信令服务的问题
    • 修复了偶发的无法正常反馈频道内谁在说话以及说话者的音量的问题

    2.2.1 版

    该版本于 2018 年 5 月 30 日发布。新增特性与修复问题列表详见下文。

    问题修复

    • 修复了部分设备上偶现的 Crash 问题。
    • 修复了部分设备上内存泄漏的问题。
    • 修复了部分设备上播放网络伴奏时某些 App 闪退的问题。

    2.2.0 版

    该版本于 2018 年 5 月 4 日发布。新增特性与修复问题列表详见下文。

    新增功能

    本次发版新增如下功能：

    1. 音效混响进频道

    播放音效 playEffect 接口新增了一个 publish 参数，用于在播放音效时，远端用户可以听到本地播放的音效。

    如果你的 SDK 是由之前版本升级到 v2.2 版本，请务必关注该接口功能的变动。

    2. 服务端部署代理服务器

    通过部署声网提供的代理服务器安装包，设有企业防火墙的用户可以设置代理服务器，使用声网的服务。详见 企业部署代理服务器 中的描述。

    改进功能

    本次发版改进如下功能：

    1. 当前说话者音量提示

    改进 enableAudioVolumeIndication接口的功能，无论频道内是否有人说话，都会在回调中按设置的时间间隔返回说话者音量提示。

    2. 频道内网络质量监测

    根据用户对频道内实时网络质量监测测的需求，在 onNetworkQuality 中改进了返回数据的准确度。

    3. 进入频道前网络条件监测

    为方便用户在进频道前检查当前网络是否能支撑语音或视频通话，在 onLastmileQuality 中，由通过恒定码率监测优化为根据用户设定的 Video Profile 的码率进行监测，提高返回数据的准确度。且在网络状态为 unknown 时，依然以 2 秒的间隔返回回调。

    4. 提升音乐场景下的音质

    提升了用户在播放音乐等场景下的音乐音质。用户可以通过设置 setAudioProfile 中的 Scenario：AgoraAudioScenarioGameStreaming = 3 来实现高保真的音乐传输。

    5. 支持 Bitcode

    新增支持 Bitcode 功能。支持 Bitcode 的 SDK 包大小约为普通包的 2.5 倍；使用 Bitcode 开发的 App 在上传 App Store 后，App Store 会对其进行优化及瘦身，瘦身程度视 App 的代码量而定，代码量越大，瘦身程度越高。

    问题修复

    • 修复了某些 iOS 设备导致频道内其他端的回音问题。

    2.1.3 版

    该版本于 2018 年 4 月 19 日发布。新增特性与修复问题列表详见下文。

    升级必看

    该版本的 SDK 修改了 setVideoProfile 方法在直播场景下的码率值，修改后的码率值与 2.0 版本一致。

    问题修复

    • 修复了 SDK 没有设置 Delegate 时，偶尔收不到 Block 回调的问题。

    • 修复了 SDK 的外链符号里，有 NSAssertionHandler 的问题。

    • 修复了部分手机上，用户离开频道后，开启自带的录音设备时，偶现录音出错的问题。

    • 修复了直播场景下，调用 enableWebSdkInteroperability接口后，iOS 端偶尔看不到 Win 10 系统 Web 端视频画面的问题。

    • 修复了通信或直播过程中偶现 Crash 的问题。

    2.1.2 版

    该版本于 2018 年 4 月 2 日发布。新增特性与修复问题列表详见下文。

    问题修复

    • 修复了之前版本 SDK 在 iOS 11 平台上崩溃的问题。

    • 修复了之前版本 SDK 在 dtx+aac 模式下会视频卡顿的问题。

    2.1.1 版

    该版本于 2018 年 3 月 16 日发布。

    请正在或已集成 2.1 SDK 的客户尽快升级更新！ 本次发版修复了一个的系统风险，请尽快升级以免对服务造成影响。

    2.1.0 版

    该版本于 2018 年 3 月 7 日发布。新增特性与修复问题列表详见下文。

    新增功能

    本次发版新增如下功能：

    1. 开黑

    新增了一个游戏开黑场景，用于节省流量和去除杂音，通过调用 API setAudioProfile 实现。

    2. 音效均衡和音效混响

    在直播场景下，主播如果需要通过内置的麦克风美化和定制自己的语音输入，可以通过调用 API setLocalVoiceEqualization 和 setLocalVoiceReverb 轻易地设置音效均衡和混响来实现所需要的效果。

    3. 在线频道信息查询

    新增 Restful API 查询用户在频道中的状态信息，查询指定频道内的分角色用户列表，查询厂商频道列表，查询用户是否为连麦用户等。详见:

    改进

    本次发版改进如下功能：

    改进 描述
    卡顿 改善了观众模式下的卡顿现象
    卡顿 改善了特定设备导致的卡顿现象
    鉴权模型优化 旧鉴权模型一个密钥只能对应一个服务权限(例如加入频道)，而新的一个 Token 包含了所有的服务权限(例如加入频道，连麦，推流等)

    问题修复

    • 修复了自采集方案退出频道后 app 录不到声音的问题;

    • 修复了偶现的崩溃;

    • 修复了偶现的关闭麦克风无法听到声音的问题;

    2.0.2 版

    该版本于 2017 年 12 月 15 日发布。新增特性与修复问题列表详见下文。

    问题修复

    修复了 ffmpeg 符号冲突问题;

    2.0 版

    该版本于 2017 年 12 月 6 日发布。新增特性与修复问题列表详见下文。

    新增功能

    • 伴奏和音效回调更新如下:

      名称 描述
      rtcEngineMediaEngineDidAudioMixingFinish 废弃，已经被 rtcEngineLocalAudioMixingDidFinish 替代
      rtcEngineDidAudioEffectFinish 新增，当本地结束音效播放时触发该回调
      rtcEngineRemoteAudioMixingDidStart 新增，当远端开始伴奏播放时触发该回调
      rtcEngineRemoteAudioMixingDidFinish 新增，当远端结束音效播放时触发该回调

    • 通信和直播场景下支持音频自采集功能，新增以下 API:

      名称 描述
      enableExternalAudioSourceWithSampleRate 开启外部音频采集
      disableExternalAudioSource 关闭外部音频采集
      pushExternalAudioFrameRawData 推送外部音频帧
    • 通信和直播场景下支持服务端踢人功能。如有需要，请联系 sales@agora.io 开通该功能。

    问题修复

    修复了音频路由和蓝牙相关的若干问题。

    1.14 版

    该版本于 2017 年 10 月 20 日发布。新增特性与修复问题列表详见下文。

    新增功能

    • 新增 API setAudioProfile 设置音频参数和应用场景。

    • 新增 API setLocalVoicePitch 提供基础变声功能。

    • 直播场景: 新增 API setInEarMonitoringVolume 提供调节耳返音量功能。

    改进

    • 优化了在高码率下的音频体验。

    • 秒开: 直播场景下，单流模式时观众加入频道 1 秒内看见主播图像(均值为 938 ms, 网络状态良好时可达 734 ms)。

    • 节省带宽:

      • 1.14 以前: 如果你选择不听某人的音频或不看某人的视频，音视频流会照发。

      • 1.14 开始: 如果你选择不听或不看某人的流，则不会下发，从而节省带宽。

    问题修复

    修复了部分 iOS 机器上偶现的崩溃。

    1.13.1 版

    该版本于 2017 年 9 月 28 日发布。新增特性与修复问题列表详见下文。

    问题修复

    • 解决了 iOS 11 在 iPhone 7(及以上版本) 手机外放下无法调节音量的问题。

    • 优化了特定场景下出现的回声问题。

    1.13 版

    该版本于 2017 年 9 月 4 日发布。新增特性与修复问题列表详见下文。

    新增功能

    • 新增 API didClientRoleChanged 用于提醒直播场景下主播、观众上下麦的回调。

    • 新增单独关闭语音播放的功能。

    • 新增功能支持服务端推流失败回调。

    • 为 SDK 新增了 module map, 意味着 Swift 项目以后不需要添加桥接文件才能使用。

    改进

    • 可以在客户端设置推流的 profile

    修复问题

    修复了部分机型上偶现的崩溃。

    1.12 版

    该版本于 2017 年 7 月 25 日发布。新增特性与修复问题列表详见下文。

    新增功能

    • 在 API 方法 setEncryptionMode 里新增了加密模式 aes-128-ecb。
    • 在 API 方法 startAudioRecording里新增了参数 quality 用于设置录音音质。
    • 新增了一系列 API 管理音效。
    • 直播场景下， 新增了 API 方法 injectStream在当前频道内插入一条 RTMP 流。该功能目前为 beta 版。

    修复问题

    修复了部分机型上偶现的崩溃问题。