文档中心
视频通话
Console Agora.io 社区 提交工单
简体中文
search-icon

发版说明

更新时间 2022/05/11 10:32:48

本文提供 Agora 视频 SDK 的发版说明。

3.7.0 版

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

升级必看

屏幕共享

屏幕共享时你可以通过 excludeWindowList 屏蔽指定窗口。该版本修改了在多显卡设备上的窗口屏蔽行为：

  • 早于 3.7.0 版，在多显卡设备上屏蔽指定窗口时，本地用户和远端用户看该窗口为黑屏。
  • 自 3.7.0 版起，在多显卡设备上屏蔽指定窗口时，SDK 会报告错误码 ERR_NOT_SUPPORTED_MUTI_GPU_EXCLUDE_WINDOW(1736)，表明不支持在多显卡设备上使用窗口屏蔽功能。

新增特性

1. 空间音效

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

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

2. 屏幕共享

该版本新增 setScreenCaptureScenario 方法，用于设置屏幕共享场景，如共享文档、视频等。SDK 支持根据你设置的场景调整共享的画质与体验。

3. 本地语音音调

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

4. 远端首帧出图回调

该版本在 IChannelEventHandler 类中新增 onFirstRemoteVideoFrame 回调，以在多频道场景下向本地用户报告远端用户的首帧视频已渲染。你还可以从该回调中获取远端用户 ID、视频宽度 (px)、高度 (px)、首帧出图时间 (ms)。

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

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

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

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

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

改进

1. 频道能力提升

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

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

2. 虚拟背景

测试结果和用户反馈显示，虚拟背景功能在多种复杂背景环境和多种人物姿态下均提升了实际效果。因此，自该版本起，虚拟背景由 Beta 功能转变为正式功能。

3. 新版 AI 降噪

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

4. playEffect 优化

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

5. 音频体验优化

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

6. 传输升级

该版本升级了传输协议和算法，增强了弱网对抗能力。同时，优化了多人视频场景的可伸缩视频编码能力，提升了视频体验。

API 变更

新增

  • setScreenCaptureScenario
  • enableLocalVoicePitchCallback
  • onLocalVoicePitchInHz
  • IChannelEventHandler 类中新增 onFirstRemoteVideoFrame
  • onClientRoleChangeFailed
  • CONNECTION_CHANGED_REASON_TYPE 中新增 CONNECTION_CHANGED_SAME_UID_LOGIN(19) 和 CONNECTION_CHANGED_TOO_MANY_BROADCASTERS(20)
  • ERR_NOT_SUPPORTED_MUTI_GPU_EXCLUDE_WINDOW(1736)

废弃

  • startScreenCaptureByScreenRect，改用 startScreenCaptureByDisplayId
  • 错误码 ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED(119)，改用 CLIENT_ROLE_CHANGE_FAILED_REASON
  • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED(20)

3.6.2 版

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

升级必看

屏幕共享

该版本对 onScreenCaptureInfoUpdated 回调报告的一系列字段进行了更名：

  • cardType 更名为 graphicsCardType
  • FILT_WINDOW_ERROR 更名为 EXCLUDE_WINDOW_ERROR
  • FILT_WINDOW_ERROR_FAIL 更名为 EXCLUDE_WINDOW_ERROR_FAIL
  • FILT_WINDOW_ERROR_NONE 更名为 EXCLUDE_WINDOW_ERROR_NONE

新增特性

1. 视频增强

继基础美颜后，Agora 新增支持更多视频增强功能：

  • 视频降噪：该功能可以降低视频噪声，提升视频画质。你可以通过 setVideoDenoiserOptions 方法设置开/关视频降噪和视频降噪效果选项。
  • 暗光增强：该功能可在光线亮度偏低（如背光、阴天、暗场景）和亮度不均匀的环境下自适应调整视频画面的亮度值，恢复或凸显图像的细节信息，提升视频图像的整体视觉效果。你可以通过 setLowLightEnhanceOptions 方法设置开/关暗光增强和暗光增强效果选项。
  • 色彩增强：该功能可智能调节饱和度和对比度等视频特性，提升视频色彩丰富度和色彩还原度，使视频画面更生动。你可以通过 setColorEnhanceOptions 方法设置开/关色彩增强和色彩增强效果选项。
  • 使用上述视频增强功能前，请确保已集成 libagora_video_process_extension.dll 动态库。
  • 视频增强功能对设备性能有一定要求。开启视频增强后，如果设备出现严重发烫等问题，请将视频增强效果选项修改为消耗性能较少的等级或关闭视频增强功能。

2. Wi-Fi 加速

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

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

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

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

3. 内容审核

为满足对视频内容监管的需求，该版本新增 enableContentInspect 方法，支持开启端云融合内容审核。成功开启内容审核后，SDK 会根据你在 ContentInspectConfig 中设置的内容审核模块和频率对本地用户发送的视频进行截图、审核和上传。审核完成后，Agora 内容审核服务器会以 HTTPS 请求的形式，向你的服务器发送审核结果，并将所有截图发送至你指定的第三方云存储。

如果你将 ContentInspectConfig 中的 type 设置为 kContentInspectModeration，即鉴黄，审核完成后，SDK 会触发 onContentInspectResult 回调，报告鉴黄结果。

开启内容审核前，请确保已开通 Agora 端云融合视频内容审核服务并集成相关的动态库。详见实现视频鉴黄。

改进

1. 云代理

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

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

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

2. 音频设备检测

为支持在频道内进行音频设备检测，该版本对音频检测相关方法和回调作如下改进：

  • 新增 onAudioDeviceTestVolumeIndication 回调，专门用于报告被检测音频设备的音量信息。

  • startRecordingDeviceTest、startPlaybackDeviceTest 和 startAudioDeviceLoopbackTest 方法由只能在加入频道前调用改为在加入频道前后均可调用，并触发如下回调：

    • 加入频道前调用，SDK 触发 onAudioVolumeIndication 和 onAudioDeviceTestVolumeIndication 回调。两种回调报告的音量信息相同。如果你将 SDK 升级到 3.6.2 或之后版本，建议你使用 onAudioDeviceTestVolumeIndication 回调。
    • 加入频道后调用，SDK 触发 onAudioDeviceTestVolumeIndication 回调。
加入频道后调用 startRecordingDeviceTest、startPlaybackDeviceTest 和 startAudioDeviceLoopbackTest 方法，只能检测当前正在使用的音频设备。

3. 音频录制

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

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

4. 播放音乐文件优化

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

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

问题修复

该版本修复了如下问题：

  • 使用 Push 方式自定义视频源时，偶现用户画面的分辨率持续变化。
  • 本地用户处于特定的混响环境下，远端用户可能听本地用户有回声。

API 变更

新增

  • setVideoDenoiserOptions
  • setLowLightEnhanceOptions
  • setColorEnhanceOptions
  • enableWirelessAccelerate
  • onWlAccMessage
  • onWlAccStats
  • enableContentInspect
  • onContentInspectResult
  • onAudioDeviceTestVolumeIndication
  • AudioRecordingConfiguration 中新增 recordingChannel
  • AudioRecordingConfiguration.recordingQuality 中新增 AUDIO_RECORDING_QUALITY_ULTRA_HIGH(3)
  • onProxyConnected
  • CLOUD_PROXY_TYPE 中新增 TCP_PROXY(2)

修改

  • onScreenCaptureInfoUpdated 回调报告的字段名
  • startRecordingDeviceTest、startPlaybackDeviceTest、startAudioDeviceLoopbackTest 的调用时序限制
  • CLOUD_PROXY_TYPE 中的 NONE_PROXY(0) 的行为

3.6.1.1 版

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

3.6.1 版

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

新增特性

屏幕共享场景下，用户会因为硬件不支持而无法在共享屏幕中通过 excludeWindowList 屏蔽指定窗口。该版本新增 onScreenCaptureInfoUpdated 回调，会在屏蔽指定窗口失败时触发，向你报告失败的错误码 errCode 和用户的显卡类型 cardType。

改进

该版本进行如下改进：

  • 对屏幕共享进行了画质、延迟、性能优化。
  • 窗口共享功能适配共享更多类型的应用窗口。
  • 使用 Mac 设备的远端用户因调用 leaveChannel 或网络中断等原因而离开频道后，本地用户看到远端画面停留在最后一帧，而不再是远端视图直接消失。

问题修复

该版本修复了如下问题：

  • 对带端口号的 旁路推流地址解析异常而导致的推流失败。
  • 本地用户共享某些应用窗口后，将其他应用窗口前置且覆盖当前共享窗口区域，远端用户看到共享窗口中存在黑色遮挡。
  • 本地用户使用 MediaIO 方式的视频自采集时，远端用户接收到的视频画面出现红色闪烁。
  • 在搭载 Windows 7 系统的特定机型上，出现崩溃。
  • 调用 updateScreenCaptureParameters 更新屏幕共享参数配置时，windowFocus 不生效。

3.6.0 版

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

升级必看

1. 旁路推流

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

  • startRtmpStreamWithoutTranscoding: 开始非转码推流。与旧推流方法 addPublishStreamUrl(false) 作用相同。
  • startRtmpStreamWithTranscoding: 开始 CDN 直播推流并设置转码属性。与依次调用旧推流方法 setLiveTranscoding、addPublishStreamUrl(true) 的作用相同。
  • updateRtmpTranscoding: 更新转码属性。与非首次调用旧推流方法 setLiveTranscoding 的作用相同。
  • stopRtmpStream: 结束 CDN 直播推流。与旧推流方法 removePublishStreamUrl 作用相同。
该版本废弃 addPublishStreamUrl、setLiveTranscoding、removePublishStreamUrl 这三个旧推流方法，Agora 推荐你使用新的推流方法，并参考旁路推流 更新你的业务代码逻辑。

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

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

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

    • 将 RTMP_STREAM_PUBLISH_ERROR 改名为 RTMP_STREAM_PUBLISH_ERROR_TYPE，并在 RTMP_STREAM_PUBLISH_ERROR_TYPE 错误码中新增如下：

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

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

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

  • 转码推流时，添加多张水印、背景图片：通过在 LiveTranscoding 结构体中新增 watermarkCount、backgroundImageCount 实现。

  • 转码推流时，设置每张水印、背景图片的图层编号和透明度：通过在 RtcImage 结构体中新增 zOrder 和 alpha 实现。

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

2. 跟随系统默认音频设备

为方便开发者灵活控制音频设备的切换，该版本在 IAudioDeviceCollection 类中新增如下方法：

  • getDefaultDevice：获取系统默认的音频设备。
  • followSystemPlaybackDevice：设置 SDK 使用的音频播放设备跟随系统默认的音频播放设备。
  • followSystemRecordingDevice：设置 SDK 使用的音频采集设备跟随系统默认的音频采集设备。

在 Windows 平台，SDK 初始化后默认使用系统默认的音频设备来播放和采集音频。该版本优化了系统默认音频设备发生变化时，SDK 的默认处理逻辑，具体如下：

  • v3.6.0 之前，SDK 仅在以下情况跟随系统默认设备变化：
    • 用户插入音频设备，导致系统默认的音频设备切换为新插入的音频设备。
    • 用户拔出或禁用系统默认的音频设备，且该设备为 SDK 当前使用的音频设备。
  • v3.6.0 及之后，SDK 始终跟随系统默认设备变化。如果无需跟随，你可以调用 followSystemPlaybackDevice(false) 和 followSystemRecordingDevice(false)。

新增特性

音画同步

同一用户可能使用两个设备分别发送音频流和视频流，为保证接收端听到和看到的音频和视频的时间同步性，该版本新增 setAVSyncSource 方法。你可以在视频发送端调用该方法，并传入音频发送端的频道名、用户 ID，SDK 会以发送的音频流的时间戳为基准进行自动调节发送的视频流，以保证即使在两个发送端的上行网络情况不一致（如分别使用 Wi-Fi 和 4G 网络）的情况下，也能让接收端听到和看到的音频和视频同步。

改进

1. 基础美颜

该版本更新了 Agora 基础美颜算法，提升了你通过 setBeautyEffectOptions 方法开启的基础美颜效果。为平衡美颜效果，该版本将 lighteningLevel（美白程度）的默认值从 0.7 改为 0.6，并在 BeautyOptions 结构体中新增 sharpnessLevel 支持设置锐化程度。

自该版本起，调用 setBeautyEffectOptions 前，请确保已集成 libagora_video_process_extension.dll 动态库。否则，你无法体验新的 Agora 基础美颜算法带来的基础美颜效果和锐度调节功能，只能体验原来的 Agora 基础美颜算法带来的基础美颜效果。

2. 首帧出图

该版本缩短了弱网环境下首帧出图时间，提升用户视频体验。

问题修复

该版本修复了如下问题：

  • 开启媒体流加密后，偶现远端用户接收到的视频卡顿。
  • 本地用户共享指定窗口时，本地用户发现该窗口被隐藏，远端用户看不到共享的窗口。
  • 共享 Foxmail 窗口失败。
  • 在部分设备上本地用户调用 enableLoopbackRecording 开启声卡采集，远端用户听到音频被播放两次。

API 变更

新增

  • startRtmpStreamWithoutTranscoding

  • startRtmpStreamWithTranscoding

  • updateRtmpTranscoding

  • stopRtmpStream

  • 在 RTMP_STREAM_PUBLISH_STATE 中新增 RTMP_STREAM_PUBLISH_STATE_DISCONNECTING(5)

  • 在 RTMP_STREAM_PUBLISH_ERROR_TYPE 中新增如下

    • RTMP_STREAM_PUBLISH_ERROR_NOT_BROADCASTER(11)
    • RTMP_STREAM_PUBLISH_ERROR_TRANSCODING_NO_MIX_STREAM(13)
    • RTMP_STREAM_PUBLISH_ERROR_NET_DOWN(14)
    • RTMP_STREAM_PUBLISH_ERROR_INVALID_APPID(15)

  • 在 RTMP_STREAMING_EVENT 中新增如下

    • RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT(3)
    • RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN(4)

  • 在 LiveTranscoding 结构体中新增 watermarkCount、backgroundImageCount

  • 在 RtcImage 结构体中新增 zOrder 和 alpha

  • 在 AUDIO_CODEC_PROFILE_TYPE 中新增 AUDIO_CODEC_PROFILE_HE_AAC_V2(2)

  • setAVSyncSource

  • 在 IAudioDeviceCollection 类中新增如下：

    • getDefaultDevice
    • followSystemPlaybackDevice
    • followSystemRecordingDevice

  • 在 BeautyOptions 结构体中新增 sharpnessLevel

修改

  • 将枚举 RTMP_STREAM_PUBLISH_ERROR 改名为 RTMP_STREAM_PUBLISH_ERROR_TYPE

  • 将 lighteningLevel 的默认值从 0.7 改为 0.6

3.5.2 版

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

升级必看

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

为准确报告加入频道失败的原因，自该版本起，在如下情况，SDK 返回的错误码由 -5(ERR_REFUSED) 更改为 -17(ERR_JOIN_CHANNEL_REJECTED)：

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

新增特性

1. 音视频录制

为方便用户在客户端录制本地音视频，该版本新增 IMediaRecorder 类，支持录制以下内容：

  • 本地麦克风采集且经 SDK 编码为 AAC 格式的音频。
  • 本地摄像头采集且经 SDK 编码的视频。

录制生成的文件保存在用户本地。

成功初始化 IRtcEngine 对象后，你可以调用 IMediaRecorder 类中的如下方法和回调实现本地音视频录制功能：

  • getMediaRecorder：注册 IMediaRecorderObserver 并获取 IMediaRecorder 对象。
  • startRecording：设置录制的内容、时长、生成文件的格式、回调间隔，并开启本地音视频录制。
  • stopRecording：停止本地音视频录制。
  • releaseRecorder：释放 IMediaRecorder 对象。
  • onRecorderStateChanged：录制状态发生改变回调。
  • onRecorderInfoUpdated：录制信息更新回调。
在通信频道场景下，该功能与 3.0.0 之前版本的 SDK 不兼容。

2. 视频截图

该版本新增 takeSnapshot 方法，支持对指定用户的视频进行截图，生成 JPG 格式图片，并保存至指定的路径。成功调用该方法后，SDK 触发 onSnapshotTaken 回调报告截图是否成功和获取截图的详情。

3. 音视频通话回路测试

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

相比 startEchoTest [2/3]，startEchoTest [3/3] 支持测试视频设备，可保障测试的安全性，不支持设置返回测试结果的时间间隔。

改进

1. 屏幕共享

该版本新增 getScreenCaptureSources 方法供你获取所有可用于共享的屏幕和窗口的对象列表 IScreenCaptureSourceList。用户可通过列表中的缩略图直观选择共享某个显示器的屏幕或共享某个窗口。在 IScreenCaptureSourceList 中，你还可以通过 getSourceInfo 获取详细的共享目标信息，如共享目标类型为窗口或屏幕，共享目标的窗口 ID 或屏幕 ID，共享目标的缩略图和图标。

此前，你需要调用 startScreenCaptureByScreenRect 通过显示屏在虚拟屏幕上的 Rectangle 坐标共享屏幕。自该版本起，你还可以直接调用 startScreenCaptureByDisplayId 通过屏幕 ID 开启屏幕共享。

如果用户设备外接其他显示屏，为避免屏幕共享出现问题，请使用 startScreenCaptureByDisplayId 开启共享，不要使用 startScreenCaptureByScreenRect。

2. 本地视频出错

为方便问题排查，该版本在 LOCAL_VIDEO_STREAM_ERROR 中新增如下错误码：

  • LOCAL_VIDEO_STREAM_ERROR_DEVICE_INVALID_ID(10): SDK 无法在视频设备列表中找到该视频设备。请检查视频设备 ID 是否有效。
  • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_OCCLUDED(13): 待共享的窗口被其他窗口遮挡住，被遮挡住的部分在共享时会被 SDK 涂黑。
  • LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED(20): SDK 不支持共享该类型的窗口。

3. 性能改进

通过优化 FEC（Forward Error Correction）编解码，小幅降低视频场景下的 CPU 占用率。

4. 体验改进

通过优化拥塞控制算法，提升弱网环境下视频清晰度和流畅度。

问题修复

该版本修复了如下问题：

  • 使用特定 NVIDIA 和 Intel 组合的双显卡，屏幕共享黑屏。
  • 用户在高丢包的弱网环境下加入频道，视频码率无法爬升。
  • 特定弱网条件下，视频码率断崖式下降所导致的视频清晰度和流畅度明显下降问题。
  • 在某些 Android 机型上调用 startAudioMixing 时，远端用户听到的人声和伴奏有轻微的不同步。
  • 部分设备上 Windows 版本识别错误问题。
  • 本地用户调用 enableDualStreamMode(false) 后，当该用户从使用 setVideoSource 自采集 SCREEN 类型的外部视频切换到 SDK 采集，本地会发送视频双流。

API 变更

该版本新增如下：

3.5.1 版

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

新增特性

1. 背景虚化

为丰富虚拟背景的效果，该版本新增支持用户调用 enableVirtualBackground 开启虚拟背景时设置背景虚化。你需要将自定义的背景图类型设为 BACKGROUND_BLUR，并根据用户希望的背景虚化程度设置 blur_degree。

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

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

  • pauseAllChannelMediaRelay：暂停向所有目标频道转发媒体流。
  • resumeAllChannelMediaRelay：恢复向所有目标频道转发媒体流。
  • RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS(12)：成功暂停向目标频道转发媒体流。
  • RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_FAILED(13)：暂停向目标频道转发媒体流失败。
  • RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS(14)：成功恢复向目标频道转发媒体流。
  • RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_FAILED(15)：恢复向目标频道转发媒体流失败。

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

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

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

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

4. 音乐文件高级设置

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

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

5. 获取音频文件信息

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

改进

1. 音频设备出错

该版本在 LOCAL_AUDIO_STREAM_ERROR 中新增如下错误码：

  • LOCAL_AUDIO_STREAM_ERROR_RECORD_INVALID_ID(9): 报告音频采集设备的 ID 无效。
  • LOCAL_AUDIO_STREAM_ERROR_PLAYOUT_INVALID_ID(10): 报告音频播放设备的 ID 无效。

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

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

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

3. 其他改进

该版本还进行了如下改进：

  • 持续优化虚拟背景的人像边缘效果。
  • 在 CPU 占用率高的情况下，提升了使用声卡采集音频时的音频体验。
  • 支持 S/PDIF（Sony/Philips Digital Interface）的音频播放设备。
  • 提升了开启 AI 降噪后使用部分蓝牙耳机时的音频体验。

问题修复

该版本修复了如下问题：

  • GAME_STREAMING 场景下，偶现因音乐检测不准确导致的回声或噪声。
  • 远端用户在几秒内依次调用 enableLocalVideo(false)、enableLocalVideo(true) 关、开本地视频采集或依次调用 muteLocalVideoStream(true)、muteLocalVideoStream(false) 停止、恢复发送本地视频后，本地用户看远端用户偶现短暂黑屏。
  • 用户共享 QQ 浏览器窗口并切换浏览器 Tab 后，窗口共享停止。
  • 本地用户调用 muteAllRemoteAudioStreams，收到 onRemoteAudioStateChanged(REMOTE_AUDIO_REASON_LOCAL_MUTED) 15 秒后，错误地收到了 onRemoteAudioStateChanged(REMOTE_AUDIO_REASON_REMOTE_MUTED)。
  • 插拔音频设备时，SDK 重复触发 onAudioDeviceStateChanged 回调。
  • 自 3.4.5 版本起，连续多次调用 joinChannel 方法时，返回值不准确。
  • 特定场景下，主播使用特定低端机型时，偶现观众看主播视频卡顿。
  • 特定场景下，发送端使用特定的小米和红米机型时，偶现接收端看到视频画面出现马赛克方格。
  • 发送端使用特定的安卓模拟器时，本地视频或接收端看到的视频画面异常。
  • 加入频道前调用 setExternalAudioSource 不生效。
  • 使用光纤音箱时出现回声。
  • 在频道内调用 enableLocalAudio(false) 后，SDK 额外触发 onLocalAudioStateChanged 回调报告 LOCAL_AUDIO_STREAM_STATE_CAPTURING(1)。

API 变更

新增

废弃

  • pushAudioFrame[2/3]
  • getAudioMixingDuration

3.5.0.4 版

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

修复了如下问题：

  • 加入频道再立即离开频道后，调用 startAudioDeviceLoopbackTest 开始音频设备回路测试，onAudioVolumeIndication 回调报告的 AudioVolumeInfo 数组内容错误。
  • 使用原始视频数据时，SDK 会在捕捉到本地待渲染的视频帧时异常触发 onRenderVideoFrame 和 onRenderVideoFrameEx 回调。
  • 使用原始视频数据时，偶现崩溃。
  • 成功注册原始视频数据观测器后，app 在 onCaptureVideoFrame 回调中进行耗时操作时，远端用户看本地用户的视频出现卡顿。
  • 成功注册原始视频数据观测器并设置 getObservedFramePosition 的返回值为 POSITION_PRE_ENCODER (1 << 2) 后，SDK 会异常触发与设置的观测位置不符的 onCaptureVideoFrame 回调。
  • 在此前发布的 3.5.x 版 SDK 上，本地用户使用 Push 方式的音频自采集时，远端用户无法听到本地用户。

3.5.0.3 版

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

3.5.0.2 版

该版本于 2021 年 8 月 11 日发布，修复了特定场景下调用 setupLocalVideo 或 setupRemoteVideo 初始化本地或远端视图时出现的黑屏问题。例如：

  • 先调用 setupLocalVideo(null) 或 setupRemoteVideo(null) 关闭本地或远端视图，再调用 setupLocalVideo 或 setupRemoteVideo 初始化本地或远端视图。
  • 在 onRemoteVideoStateChanged 回调中调用 setupRemoteVideo 初始化远端视图。

3.5.0.1 版

该版本于 2021 年 8 月 4 日发布，修复了该问题：未调用 setupLocalVideo 和 setupRemoteVideo 时，注册原始视频数据观测器无法收到 onRenderVideoFrame 回调。

3.5.0 版

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

新增特性

视频自渲染

实时音视频互动过程中，SDK 会启动默认的渲染器渲染视频。自该版本起，Agora 新增支持通过 MediaIO 方式自定义视频渲染。如果你想要自定义视频渲染，可以先通过 IVideoSink 类自定义视频渲染器，再调用 setLocalVideoRenderer 或 setRemoteVideoRenderer 渲染本地或远端视频。

改进

1. 视频画质

该版本对采集和接收的视频画质进行了如下改进：

  • 通过对色彩范围的适配，提升采集和接收的视频对比度，以改善画面泛白问题。
  • 通过对色彩空间的适配，提升采集和接收的视频色彩丰富度，进一步还原视频色彩。

2. 虚拟背景（beta）

该版本优化了虚拟背景的人像边缘效果。

3. 音频相关错误码

为方便排查音频出错原因，该版本新增 ERR_ADM_WIN_CORE_SERVRE_SHUT_DOWN (1735) 错误码，报告 Windows Audio 服务被关闭。你需要开启 Windows Audio 服务或重启设备。

4. 其他改进

该版本还进行了如下改进：

  • 在开启 AGC 的场景下，缩短降噪收敛的时间，从而降低噪声忽大忽小的波动。
  • 改善了视频自渲染场景下的出帧平滑度。

问题修复

该版本修复了如下问题：

  • 使用 Push 方式自定义视频源的用户接收远端流时，偶现远端音画不同步。
  • 远端用户调用 enableLoopbackRecording 后，偶现本地用户听到自己的回声。
  • 调用 muteLocalAudioStream(true) 停止发布本地音频后，用户第一次加入频道可以听到远端用户，但退出频道后再次加入频道偶现无法听到远端用户。
  • 本地网络环境较差时，SDK 报告的远端用户的下行网络质量 （rxQuality）不准确。

API 变更

该版本新增如下：

3.4.6 版

该版本于 2021 年 7 月 15 日发布，提升了 SDK 稳定性。

3.4.5 版

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

升级必看

1. 支持 GCM2 加密

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

  • 在 ENCRYPTION_MODE 中新增 AES_128_GCM2 和 AES_256_GCM2 加密模式。新的 GCM 加密模式使用了安全性更高的密钥派生函数，支持设置密钥和盐。
  • 在 EncryptionConfig 中新增 encryptionKdfSalt 成员，用于为 AES_128_GCM2 和 AES_256_GCM2 加密模式设置盐。

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

更多介绍见媒体流加密。

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

2. 媒体流发布行为变更

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

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

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

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

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

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

3. startAudioMixing 变更

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

新增特性

1. 虚拟背景（beta）

为满足用户对自定义虚拟背景的需求，该版本新增 enableVirtualBackground 方法，支持你开启虚拟背景，将用户的背景设为纯色或 PNG、JPG 格式的图片。同时，你可以通过 onVirtualBackgroundSourceEnabled 回调了解虚拟背景是否成功开启和相应的出错原因。

使用虚拟背景前，请确保已集成相关的动态库，且设备性能和用户场景符合要求。详见 enableVirtualBackground 文档。

2. 视频编码数据

该版本新增 registerVideoEncodedFrameObserver 方法，你可以通过该方法注册本地视频编码数据观测器，并从 onVideoEncodedFrame 回调函数中获取本地视频编码数据，以实现各种自定义功能，如录制视频、截图、美颜。

改进

1. 性能优化

Agora 对该版本 SDK 进行内部线程优化，低端机上 CPU 占用率降低了约 20%。

2. 旁路推流

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

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

3. 自定义视频源

你可以通过 setVideoSource 方法自定义视频源，即使用 MediaIO 方式的视频自采集。为提升视频采集的灵活性，自该版本起，Agora 支持你在频道内直接从 MediaIO 视频自采集切换为 SDK 采集。详见如何从视频自采集切换到 SDK 采集。

4. 媒体设备状态回调

为更准确地报告媒体设备的状态，该版本优化了 MEDIA_DEVICE_STATE_TYPE 的枚举值：

  • 由于枚举值命名与含义不符，该版本将 MEDIA_DEVICE_STATE_ACTIVE (1) 的含义从“设备就绪”改为“设备正在使用”。
  • 新增 MEDIA_DEVICE_STATE_IDLE (0)，报告设备就绪。

MEDIA_DEVICE_STATE_TYPE 在 onAudioDeviceStateChanged 和 onVideoDeviceStateChanged 回调中返回。

5. 音乐文件状态

在 pauseAudioMixing 后调用 startAudioMixing 时，该版本在报告 onAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING, AUDIO_MIXING_REASON_STARTED_BY_USER) 状态之前新增了 onAudioMixingStateChanged(AUDIO_MIXING_STATE_STOPPED, AUDIO_MIXING_REASON_STOPPED_BY_USER) 状态，提示已停止播放音乐文件。

问题修复

该版本修复了如下问题：

  • 在弱网环境下，调用 startAudioMixing 播放在线音乐文件时，偶现 SDK 响应时间过长而引起卡顿。
  • 音频场景为 AUDIO_SCENARIO_CHATROOM_GAMING 时，本地用户通过系统播放器播放视频、开启屏幕共享与声卡采集后，远端用户听到播放的视频声音有杂音。
  • 弱网环境下，偶现用户无法切换角色。

API 变更

新增

修改

废弃

  • IChannel 类的 publish 和 unpublish

3.4.3 版

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

  • 调用 startAudioMixing 无法播放扩展名为 m4a 的 MP3 本地音乐文件。
  • 3.0.0+ 版本的用户离开有 3.0.0 之前版本的用户的通信频道，并切换频道场景为直播场景后，在加入下一个频道前切换用户角色为主播，但设置未生效。
  • 特定场景下，用户加入频道 10 分钟后偶现音频延迟。

3.4.2 版

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

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

  • 3.4.0、3.4.1 版本与 3.0.0 之前版本的互通问题：
    • 通信场景下，3.4.0 或 3.4.1 版本的 Native 用户看 3.0.0 之前版本的 Native 用户时，出现卡顿。
    • 直播场景下，3.4.0 或 3.4.1 版本的 Native 用户看 3.0.0 之前版本的 Windows 或 macOS 用户时，出现卡顿。
  • 集成 libagora_ai_denoise_extension.dll 后偶现崩溃。

3.4.1 版

该版本与 3.0.0 之前版本互通时可能有视频卡顿问题。如需与 3.0.0 之前版本的 SDK 互通，Agora 推荐你跳过该版本，升级到 3.4.2 版本。详见 3.4.2 版。

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

  • 在特定的基础变声场景下，出现崩溃。
  • 极端弱网情况下，Native 用户看 Web 主播花屏。

3.4.0 版

该版本与 3.0.0 之前版本互通时可能有视频卡顿问题。如需与 3.0.0 之前版本的 SDK 互通，Agora 推荐你跳过该版本，升级到 3.4.2 版本。详见 3.4.2 版。

该版本于 4 月 16 日发布。

升级必看

集成变更

  1. WGC 库

该版本新增与窗口共享相关的 libagora-wgc.dll 动态库。如果你将 SDK 升级到 v3.4.0 或更高版本，请务必在集成 SDK 时将该库拷贝至 agora_rtc_sdk.dll 所在文件夹中。

  1. 插件列表

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

行为变更

  1. 音乐文件播放状态

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

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

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

  1. 调节麦克风采集信号音量

自该版本起，adjustRecordingSignalVolume 仅调节麦克风采集信号音量。如需调节声卡采集信号音量，请改用 adjustLoopbackRecordingSignalVolume。

新增特性

1. 调节声卡采集信号音量

该版本新增 adjustLoopbackRecordingSignalVolume，你可以在 enableLoopbackRecording 后调用该方法调节声卡采集的信号音量。

2. 音效文件播放进度

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

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

同时，该版本废弃 playEffect[1/2]，请使用 playEffect[2/2] 替代。

改进

1. 视频编码

Agora SDK 允许你通过 degradationPreference 设置带宽受限时本地视频编码降级偏好，如降低视频帧率保障视频质量，降低视频质量保障视频帧率。自该版本起，degradationPreference 新增支持设为 MAINTAIN_BALANCED，弱网下会降低视频帧率和视频质量，以在流畅性和视频质量之间取得平衡，适用于流畅性和画质均优先的场景，如一对一通话、一对一教学、多人会议。

2. 原始视频数据

getRotationApplied 和 getMirrorApplied 可将原始视频数据作旋转、镜像处理。为提升用户体验，该版本将这些回调函数支持处理的视频数据格式由 RGBA 拓展到 RGBA 和 YUV 420。

3. 窗口共享

该版本起对窗口共享进行如下优化：

  • 在 Windows 10 1809 及之后版本的系统上，startScreenCaptureByWindowId 支持共享大部分 UWP 应用窗口和采用 DirectX 渲染的窗口。此时，共享的窗口有黄色描边，且 captureMouseCursor(false) 不生效。
  • 在 Windows 10 1809 之前版本的系统上，通过 startScreenCaptureByWindowId 共享指定窗口画面时，被其他窗口遮挡的区域被涂黑。

4. 音乐文件播放进度

为方便控制音乐文件的播放进度，该版本进行如下优化：

  • 废弃 startAudioMixing 并新增同名方法替代。新方法允许你通过 startPos 参数在播放音乐文件时设置播放位置。
  • 废弃 getAudioMixingDuration 并新增同名方法替代。新方法允许你通过 filePath 参数在播放本地音乐文件前获取该音乐文件总时长。

5. 客户端录音

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

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

6. 媒体设备出错

为方便用户了解本地音视频出错的原因，该版本进行如下优化：

  • 在 LOCAL_VIDEO_STREAM_ERROR 中新增错误码 LOCAL_VIDEO_STREAM_ERROR_DEVICE_NOT_FOUND(8)，报告无法找到本地视频采集设备。
  • 在 LOCAL_AUDIO_STREAM_ERROR 中新增如下错误码：
    • LOCAL_AUDIO_STREAM_ERROR_NO_RECORDING_DEVICE(6): 报告无法找到本地音频采集设备。
    • LOCAL_AUDIO_STREAM_ERROR_NO_PLAYOUT_DEVICE(7): 报告无法找到本地音频播放设备。

问题修复

该版本修复了如下问题：

  • 特定场景下，通过 getMirrorApplied 设置镜像后，视频画面出现上下颠倒。
  • 用户无法通过 onPreEncodeVideoFrame 获取 RGBA 格式的视频数据。
  • 用户无法通过 getMirrorApplied 和 getRotationApplied 处理本地编码前的视频数据。
  • 调用 enableSoundPositionIndication(true) 后 onAudioVolumeIndication 回调的音量信息不准确。
  • 在 Windows 10 特定机型上共享文件资源管理器窗口时，远端看到的窗口标题栏颜色异常。

API 变更

新增

修改

废弃

  • getAudioMixingDuration[1/2]
  • startAudioRecording[2/3]
  • playEffect[1/2]
  • startAudioMixing[1/2]
  • AUDIO_MIXING_ERROR_TYPE

3.3.2 版

该版本于 2021 年 3 月 29 日发布，修复了 Mac 上使用神奇效果最小化共享的窗口时，远端用户看到扭曲画面的问题。

3.3.1 版

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

新增特性

基础变声

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

改进

1. AES-GCM 加密模式

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

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

2. 远端音频统计

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

API 变更

新增

3.3.0 版

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

升级必看

1. 集成变更

该版本新增如下文件。

  • libagora-core.dll: Agora 基础计算框架。
  • av1.dll: AV1 框架，用于屏幕共享。

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

2. 订阅行为变更

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

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

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

3. 人声状态行为变更

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

新增特性

1. 频道媒体选项

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

2. 云代理

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

3. AI 降噪

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

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

4. 歌唱美声

在歌唱场景中，为美化歌声并添加混响效果，该版本新增 setVoiceBeautifierParameters，并在 VOICE_BEAUTIFIER_PRESET 中添加 SINGING_BEAUTIFIER 枚举值。

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

5. 设置日志文件

为保证日志内容的完整性，该版本在 RtcEngineContext 中新增 logConfig 成员变量，在你初始化 RtcEngine 时可用于设置 Agora SDK 输出的日志文件。详见如何设置日志文件。

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

6. 采集画质

为更好地控制摄像头采集的画质，该版本新增支持自定义采集分辨率并监听采集异常：

  • 自定义采集分辨率：调用 setCameraCapturerConfiguration 方法，将采集偏好设为 MANUAL(3) 并设置采集视频的宽高。
  • 监听采集异常：
    • 采集的画质亮度异常：通过 onLocalVideoStats 回调的 captureBrightnessLevel 监听。
    • 摄像头无法输出采集视频：通过 onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE_FAILED, LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE) 回调监听。
    • 摄像头重复输出采集视频：通过 onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE_CAPTURING, LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE) 回调监听。

7. 创建数据流

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

改进

1. 屏幕共享

自该版本起，SDK 会根据实际情况自动开启 DXGI（DirectX Graphics Infrastructure）采集，大幅提升屏幕共享支持的视频帧率和分辨率。

2. 远端音频统计

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

问题修复

该版本修复了如下问题：

  • 偶现本地用户无法播放远端音频。
  • 360 安全大脑（网购模式）自动拦截程序运行。

API 变更

新增

废弃

  • setDefaultMuteAllRemoteVideoStreams
  • setDefaultMuteAllRemoteAudioStreams
  • setLogFile
  • setLogFileSize
  • setLogFilter
  • createDataStream

3.2.1 版

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

  • IPv6 场景下的高概率崩溃问题。
  • 使用 MediaIO 方式自定义视频源并离开频道后，再次进出频道时偶现崩溃。
  • 调用 enableEncryption 后，onFirstLocalVideoFramePublished 回调无法被触发。
  • 部分虚拟摄像头视频采集异常。

3.2.0 版

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

升级必看

1. 集成变更

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

  • libagora-fdkaac.dll: Fraunhofer FDK AAC 动态库。
  • libagora-mpg123.dll: mpg123 动态库。
  • libagora-soundtouch.dll: SoundTouch 动态库。
  • libagora-ffmpeg.dll: FFmpeg 动态库。

如果你将 SDK 升级到 v3.2.0 或更高版本，请务必在集成 SDK 时将上述 dll 文件拷贝至 libagora-rtc-sdk.dll 所在文件夹中。

2. 云代理

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

3. 安全合规

Agora 已通过 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 方法中新增 AUDIO_SCENARIO_MEETING(8)。
    • 屏幕共享：
      • 该版本新增支持共享过程中，将共享的幻灯片进入演示模式，将共享的窗口（如网页视频、网页文档）开启全屏模式。
      • 新增 LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_CLOSED(12) 错误码，提示你通过窗口 ID 共享的窗口已关闭，或通过窗口 ID 共享的全屏窗口已退出全屏。
      • 该版本优化弱网环境下 CONTENT_HINT_DETAILS 屏幕共享的流畅度和画质。

    2. 美声与音效

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

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

    3. CDN 转码推流

    该版本在 LiveTranscoding 结构体中新增 videoCodecType 成员，支持设置转码输出视频流的编解码类型为 H.264 或 H.265。

    4. 互动直播延时

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

    API 变更

    新增

    废弃

    3.1.2 版

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

    该版本修复了 onFirstLocalVideoFrame 和 onFirstRemoteVideoFrame 回调的触发时机不准确的问题。

    3.1.1 版

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

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

    • AREA_CODE_CN: 中国大陆。
    • AREA_CODE_NA: 北美区域。
    • AREA_CODE_EU: 欧洲区域。
    • AREA_CODE_AS: 除中国大陆以外的亚洲区域。
    • AREA_CODE_JP: 日本。
    • AREA_CODE_IN: 印度。
    • AREA_CODE_GLOB:（默认）全球。

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

    3.1.0 版

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

    新增特性

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

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

    • onAudioPublishStateChanged：音频发布状态发生改变。
    • onVideoPublishStateChanged：视频发布状态发生改变。
    • onAudioSubscribeStateChanged：音频订阅状态发生改变。
    • onVideoSubscribeStateChanged：视频订阅状态发生改变。

    2. 本地首帧发布回调

    为提示用户本地音视频首帧已发布，该版本新增如下回调：

    • onFirstLocalAudioFramePublished：已发布本地音频首帧回调。该回调取代 onFirstLocalAudioFrame 回调，我们推荐你不再使用 onFirstLocalAudioFrame 回调。
    • onFirstLocalVideoFramePublished：已发布本地视频首帧回调。

    3. 自定义数据上报

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

    改进

    1. 指定访问区域完善

    该版本新增以下枚举值，在调用 initialize 初始化 IRtcEngine 时提供更多区域选择。指定访问区域后，集成了 Agora SDK 的 app 会连接指定区域内的 Agora 服务器。

    • AREA_CODE_JAPAN：日本。
    • AREA_CODE_INDIA：印度。

    2. 屏幕共享

    为提升屏幕共享的用户体验，该版本新增如下功能：

    • 置顶指定窗口：通过在 ScreenCaptureParameters 结构体中新增 windowFocus 成员实现。
    • 屏蔽指定窗口：通过在 ScreenCaptureParameters 结构体中新增 excludeWindowList 成员实现。
    • 屏幕共享下的本地视频状态报告：通过在 onLocalVideoStateChanged 回调中新增状态码 LOCAL_VIDEO_STREAM_STATE_CAPTURING(1) 和错误码 LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_MINIMIZED(11) 实现。
    • 支持 MediaIO 方式自定义视频源：新增 IVideoSource 类设置自定义的视频源。

    3. CDN 直播推流

    为提升 CDN 直播推流用户体验，该版本新增 onRtmpStreamingEvent 回调，报告推流过程中发生的事件，如未成功添加背景图或水印。

    4. 加密

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

    • setEncryptionSecret
    • setEncryptionMode

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

    5. 通话中质量透明

    该版本进一步扩充了 LocalAudioStats 类、LocalVideoStats 类、RemoteVideoStats 类和 RemoteAudioStats 类的成员，提供更多音视频质量相关数据。

    • LocalAudioStats 类新增 txPacketLossRate，表示本端到 Agora 边缘服务器的物理音频丢包率 (%)。
    • LocalVideoStats 类新增
      • txPacketLossRate：本端到 Agora 边缘服务器的物理视频丢包率 (%)。
      • captureFrameRate：本地视频采集帧率 (fps)。
    • RemoteAudioStats 和 RemoteVideoStats 类中新增 publishDuration，表示远端音频流和视频流的累计发布时长（毫秒）。

    6. 设置音频编码属性

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

    Profile 3.1.0 版本 3.1.0 版本之前
    AUDIO_PROFILE_DEFAULT
  • 直播场景：64 Kbps
  • 通信场景：16 Kbps
    		•
  • 直播场景：52 Kbps
  • 通信场景：16 Kbps
    		•
    AUDIO_PROFILE_SPEECH_STANDARD 18 Kbps 18 Kbps
    AUDIO_PROFILE_MUSIC_STANDARD 64 Kbps 48 Kbps
    AUDIO_PROFILE_MUSIC_STANDARD_STEREO 80 Kbps 56 Kbps
    AUDIO_PROFILE_MUSIC_HIGH_QUALITY 96 Kbps 128 Kbps
    AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO 128 Kbps 192 Kbps

    7. 日志扩容

    该版本中，Agora 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 写入最新的日志。

    8. 优化弱网环境下的视频体验

    • 自该版本起，弱网环境下会自动降低视频分辨率，以进一步优化视频流畅度。
    • 优化了网络状态变化过程中的视频画质，保证画质不模糊。

    问题修复

    该版本修复了华为特定型号的笔记本上偶现啸叫的问题。

    API 变更

    新增

    废弃

    • setEncryptionSecret
    • setEncryptionMode
    • onFirstLocalAudioFrame

    删除

    • 警告码：WARN_ADM_IMPROPER_SETTINGS(1053)

    3.0.1.1 版

    该版本于 2020 年 6 月 18 日发布。主要修复如下问题：

    • registerVideoRenderFactory（已废弃）方法导致的崩溃现象。
    • 美颜功能不生效。

    3.0.1 版

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

    升级必看

    视频观测位置

    自 v3.0.1 起，如果你想要获取 onPreEncodeVideoFrame 回调中的视频数据，除实现该回调外，还需要在 getObservedFramePosition 中将 POSITION_PRE_ENCODER(1 << 2) 设置为观测位置。

    新增特性

    1. 调整音乐文件音调

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

    2. 变声与混响

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

    • 在 VOICE_CHANGER_PRESET 枚举中新增了以 VOICE_BEAUTY 为前缀和以 GENERAL_BEAUTY_VOICE 为前缀的枚举值，分别实现美音或语聊美声功能。
    • 在 AUDIO_REVERB_PRESET 枚举中新增了以 AUDIO_REVERB_FX 为前缀的枚举值和 AUDIO_VIRTUAL_STEREO，分别实现增强版混响效果和虚拟立体声效果。

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

    3. 全屏显示视频

    为提高用户观看视频的体验，该版本在视频显示模式中新增 RENDER_MODE_FILL(4) 模式。设置该模式后，视频尺寸会进行缩放和拉伸直至充满显示视图。你可以在调用以下方法设置用户视图时选择该显示模式：

    • setupLocalVideo
    • setupRemoteVideo
    • setLocalRenderMode
    • setRemoteRenderMode

    4. 远端音视频数据后处理多频道支持

    在多频道场景下，为方便后处理各频道的远端音视频数据，该版本新增如下 C++ 接口：

    • IAudioFrameObserver 类中新增 isMultipleChannelFrameWanted 和 onPlaybackAudioFrameBeforeMixingEx。
    • IVideoFrameObserver 类中新增 isMultipleChannelFrameWanted 和 onRenderVideoFrameEx。

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

    改进

    设置视频观测位置

    成功注册视频观测器后，你可以在视频处理的各节点观测并获取想要的视频数据，如本地采集的视频数据，接收的远端视频数据等。为降低设备耗能，该版本允许自定义视频观测位置。你可以通过修改 getObservedFramePosition 的返回值，设置只观测以下某个或多个位置的视频数据：

    • 本地采集的视频数据
    • 接收远端发送的视频数据
    • 本地编码前的视频数据

    问题修复

    • 修复了混音、Loopback 测试异常等问题。
    • 修复了连麦用户屏幕共享黑屏的问题。
    • 修复了 onClientRoleChanged 回调多次、App ID 和 Token 校验、日志目录乱码等问题。

    API 变更

    新增

    3.0.0.2 版

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

    新增特性

    设置区域访问限制

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

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

    问题修复

    该版本修复了连麦用户屏幕共享黑屏的问题。

    API 变更

    新增

    RtcEngineContext 结构体中新增 areaCode 成员

    3.0.0 版

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

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

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

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

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

    升级必看

    1. 通信场景上行默认不开启视频小流

    从该版本起，Agora 在通信场景下，默认不开启视频小流。如需启用，请在成功加入频道后，调用 enableDualStreamMode (true) 方法启用视频双流模式。在多人视频通信场景下，我们建议你开启视频双流。

    新增特性

    1. 多频道管理

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

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

    2. 视频原始数据

    为方便开发者获取传输各阶段的视频原始数据，满足更多场景需求，该版本在 IVideoFrameObserver 类中新增如下 C++ 回调接口：

    • onPreEncodeVideoFrame：获取前处理后、编码前的本地视频原始数据。该方法适用于有视频前处理需求的开发场景。
    • getSmoothRenderingEnabled：设置是否对获取的视频数据（通过 onRenderVideoFrame）进行平滑处理。平滑处理后的视频帧，出帧时间间隔会更均匀，因此视频自渲染的体验更好。

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

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

    4. 美颜

    常见的视频社交、在线教育和连麦直播等场景中，用户普遍希望有基础的美颜功能。该版本新增接口 setBeautyEffectOptions，你可以调用该接口设置对比度、亮度、平滑度等参数，达到美白、磨皮、红润肤色等美颜效果。详情请参考美颜。

    改进

    1. 音频编码属性

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

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

    2. 镜像模式

    为提升视频镜像的使用体验，该版本增加了视频编码镜像和视频渲染镜像的功能：

    • 视频编码镜像：在 VideoEncoderConfiguration 结构体中，新增 mirrorMode 成员，方便设置本地视频编码的镜像模式，即远端看本地是否镜像。
    • 视频渲染镜像：在 VideoCanvas 结构体中，新增 mirrorMode 成员，方便用户在调用 setupLocalVideo 方法初始化本地视图时，设置本地看本地是否镜像，以及调用 setupRemoteVideo 方法初始化远端视图时，设置本地看远端是否镜像；同时在 setLocalRenderMode 和 setRemoteRenderMode 方法中新增 mirrorMode 参数，支持在通话中更新本地看本地，或本地看远端的镜像模式。

    3. 质量透明

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

    4. 屏幕共享

    为支持更多屏幕共享使用场景，该版本新增支持调用 startScreenCaptureByWindowId 方法时共享通用 Windows 平台（UWP）应用窗口。

    5. 其他提升

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

    问题修复

    • 修复了混音、音频录制、音频编码、回声等音频问题。
    • 修复了水印、视频画面比例、画质模糊、视频不能全屏、屏幕共享黑边等视频问题。
    • 修复了特定场景下偶现的 app 崩溃、日志文件、推流不稳定等问题。

    API 变更

    新增

    废弃

    2.9.3 版

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

    该版本于 2020 年 2 月10 日发布。

    该版本修复了如下问题：

    • 通信场景下，调用 setRemoteSubscribeFallbackOption 方法也生效。
    • 一对一通信场景下，下行音视频弱网下会回退为纯音频。

    2.9.1 版

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

    新增特性

    1. 人声检测

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

    2. RGBA 视频原始数据

    该版本新增支持 RGBA 格式的视频原始数据。你可以通过新增的 C++ 接口 getVideoFormatPreference，设置想要获取的视频原始数据的格式。

    同时为提高开发体验，Agora 支持对 RGBA 格式的视频原始数据分别通过 C++ 接口 getRotationApplied 和 getMirrorApplied 进行旋转和镜像处理。

    改进

    1. 直播水印

    为提高直播水印的用户体验，解决视频方向模式为 Adaptive 时，水印位置和方向可能和预期不符的问题，该版本废弃了原有的 addVideoWatermark 接口，并使用一个新的同名接口进行取代。同名接口下，Agora 使用 WatermarkOptions 类对水印进行设置，其中：

    • visibleInPreview 成员设置本地预览是否能看见水印。
    • positionInLandscapeMode/positionInPortraitMode 成员设置视频编码横屏/竖屏模式时的水印坐标。

    同时，该版本对水印功能的性能进行了优化。和之前版本相比，该功能的 CPU 占用降低了 5% - 20%。

    2. 设置客户端录音采样率

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

    问题修复

    其他

    IAgoraRtcEngine.h 头文件中的拼写错误。

    API 变更

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

    新增

    废弃

    • startAudioRecording
    • addVideoWatermark

    2.9.0 版

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

    升级必看

    1. 旁路推流

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

    • configPublisher
    • setVideoCompositingLayout
    • clearVideoCompositingLayout

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

    新的推流实现方法，详见旁路推流。

    2. 远端视频状态

    为方便用户了解远端视频状态，该版本删除了原有的 onRemoteVideoStateChanged 接口，并使用一个新的同名接口进行取代。新接口下， state 参数扩展为 STOPPED(0)、STARTING(1)、DECODING(2)、FROZEN(3) 和 FAILED(4)。同时，新接口还增加了 reason 参数，用以报告远端视频状态发生改变的原因。因此，如果你将 Native SDK 升级至该版本，请确保重新实现 onRemoteVideoStateChanged 接口。

    该回调的触发时机与老的 onRemoteVideoStateChanged 回调不同。新接口只有在远端视频流状态发生改变时，才会触发。

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

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

    新增特性

    1. 快速切换频道

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

    2. 跨频道媒体流转发

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

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

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

    3. 本地及远端音频状态

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

    • 本地音频：STOPPED(0)、RECORDING(1)、ENCODING(2) 和 FAILED(3)。状态为 FAILED(3) 时，你可以通过 error 参数中返回的错误码定位及排查问题。
    • 远端音频：STOPED(0)、STARTING(1)、DECODING(2)、FROZEN(3) 和 FAILED(4)。你可以在 reason 参数中了解引起远端音频状态发生改变的原因。

    4. 本地音频数据

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

    改进

    1. 通话中质量透明

    该版本进一步扩充了 RtcStats、LocalVideoStats 和 RemoteVideoStats 类的成员。各类新增成员如下：

    • RtcStats 类：累计发送音频/视频字节数及累计接收音频/视频字节数
    • LocalVideoStats 类：本地视频的编码码率、宽高、发送帧数及编码类型
    • RemoteVideoStats 类：远端视频在网络对抗后的丢包率

    2. 直播视频质量提升

    该版本改善了弱网条件下直播视频卡顿问题，提升了画面清晰度，优化了网络极端丢包情况下的直播画面流畅度。

    3. 屏幕共享质量提升

    该版本提升了通信场景下，下行网络状况不佳时，屏幕共享文字的清晰度。该改进只在屏幕共享的内容类型 ContentHint 设置为 Details(2) 时生效。

    4. 摄像头热插拔

    为提升 Windows 平台设备使用体验，该版本支持使用 RtcEngineContext 类中的 context 成员支持摄像头设备热插拔，并实现如下改进：

    • 支持加入频道前或退出频道后，响应设备热插拔。
    • 支持 App 视频自渲染场景下，响应设备热插拔。
    • 修复了特殊场景下频繁热插拔摄像头导致的崩溃问题。
    • 缩短加入频道的时间。

    5. 其他改进

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

    问题修复

    音频

    • 修复了与 Web 互通时听声辨位过程中出现的声音失真的问题。
    • 修复了 muteRemoteAudioStream 方法调用无效的问题。
    • 修复了特殊场景下偶现的音频无声的问题。

    视频

    • 修复了 onRemoteVideoStateChanged 回调行为不符预期的问题。

    其他

    • 修复了偶现的旁路推流串流的问题。
    • 修复了偶现的崩溃问题。
    • 修复了特定场景下加入频道失败的问题。

    API 变更

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

    新增

    废弃

    删除

    • configPublisher
    • setVideoCompositingLayout
    • clearVideoCompositingLayout
    • onRemoteVideoStateChanged

    2.8.0 版

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

    新增特性

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

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

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

    为保证通信质量，频道内所有用户需使用同一数据类型的用户 ID，即频道内的所有用户 ID应同为 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 将用户 ID升级至 String 型 User account，请确保所有终端用户同步升级。

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

    2. 音视频卡顿回调

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

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

    改进

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

    API 变更

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

    新增

    废弃

    2.4.1 版

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

    升级必看

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

    1. 旁路推流

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

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

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

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

    2、RemoteVideoStats 类参数更名

    为更精准地表达远端视频流的统计信息，该版本将 RemoteVideoStats 类中的 receivedFrameRate 参数更名为 rendererOutputFrameRate。

    新增特性

    1、添加媒体附属信息

    常见的直播场景中，主播给观众分发商品链接、优惠券、在线答题等，能构建更为丰富的直播互动方式。为满足该部分社交类直播 App 开发者的需求，该版本新增 registerMediaMetadataObserver 接口以及 IMediaMetadataObserver 类，目前允许主播在发出的视频帧中添加 Metadata，发送媒体附属信息。

    2、优化屏幕共享

    为确保屏幕共享画面完整性，保持共享屏幕的宽高比，避免画面裁剪和拉伸，该版本对屏幕共享的编码策略进行了优化。新版本下 Agora 按如下策略进行编码。假设 dimensions 值为 1920 x 1080，即 2073600 像素：

    • 如果屏幕分辨率小于 dimensions，如 1000 x 1000，SDK 直接按 1000 x 1000 进行编码
    • 如果屏幕分辨率大于 dimensions，如 2000 x 2000，SDK 将保持屏幕分辨率的宽高比 1：1，取 dimensions 以内的最大分辨率，即 1440 x 1440， 进行编码

    屏幕共享按用户在 ScreenCaptureParameters 类下设置的 dimensions 值进行计费。如果用户没有设置 dimensions 的值，SDK 会按 1920 x 1080 计费。

    同时，为方便用户选择屏幕共享时是否采集鼠标，该版本在 ScreenCaptureParameters 类中新增 captureMouseCursor 参数。该参数默认采集鼠标。

    3、本地视频状态回调

    为方便开发者了解本地视频状态，该版本新增 onLocalVideoStateChanged 回调。该回调下，本地视频有 STOPPED、CAPTURING、ENCODING 和 FAILED 四种状态。当本地视频状态为 FAILED 时，用户可以参考该回调 error 参数返回的错误码进行问题排查。该回调能帮助开发者辨别本地视频故障是由采集还是编码引起的。原有的 onCameraReady 和 onVideoStopped 回调在该版本废弃，我们不再推荐。

    4、推流状态回调

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

    5、网络连接失败原因梳理

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

    6、本地网络连接类型回调

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

    7、获取播放伴奏音量

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

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

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

    9、其他新增特性

    • 该版本新增支持 64 位系统。

    改进

    1、质量透明

    2、其他改进

    • 优化了AUDIO_SCENARIO_TYPE 为 GAME_STREAMING 时的音质效果
    • 优化了部分场景下语音和视频的延时
    • SDK 包大小降低约 0.5 M
    • 提高了用户修改视频属性的码率后，网络质量打分的准确性
    • 默认启用音频质量通知回调。开发者无需调用 enableAudioQualityIndication 方法，也可以收到 onRemoteAudioStats 回调
    • 提升了视频服务的稳定性
    • 提升了推流服务的稳定性
    • 提升了视频设备的兼容性

    问题修复

    音频

    • 修复了同时播放多个本地音效文件失败的问题

    视频

    • 修复了特殊场景下发送端发小流的问题

    其他

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

    API 变更

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

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

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

    新增

    废弃

    • enableAudioQualityIndication
    • onCameraReady，请改用onLocalVideoStateChanged 回调中的 LOCAL_VIDEO_STREAM_STATE_CAPTURING(1)
    • onVideoStopped，请改用 onLocalVideoStateChanged 回调中的 LOCAL_VIDEO_STREAM_STATE_STOPPED(0)
    • 警告码 WARN_LOOKUP_CHANNEL_REJECTED(105)，请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_REJECTED_BY_SERVER(10)
    • 错误码 ERR_TOKEN_EXPIRED(109)，请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_TOKEN_EXPIRED(9)
    • 错误码 ERR_INVALID_TOKEN(110)，请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_INVALID_TOKEN(8)
    • 错误码 ERR_START_CAMERA(1003)，请改用 onLocalVideoStateChanged 回调中的 LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4)
    • 错误码 ERR_VDM_WIM_DEVICE_IN_USE(1502)，请改用 onConnectionStateChanged 回调中的 LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY(3)

    2.4.0 版及之前

    2.4.0 版

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

    新增功能

    1. 高级屏幕共享

    该版本针对原有的屏幕共享进行了升级，并支持如下功能：

    该版本废弃了原有的 startScreenCapture 接口。Agora 推荐你使用新接口实现屏幕共享。新接口下，用户需要在代码中设计获取 screenRect 和 windowId 的代码逻辑，详情请参考开始屏幕共享。

    2. 变声和混响

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

    3. 听声辨位

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

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

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

    5. 音频设备回路测试

    该版本新增音频设备回路测试接口 startAudioDeviceLoopbackTest 与 stopAudioDeviceLoopbackTest，用于测试本地的麦克风和播放设备能否正常工作。该测试在本地进行，不涉及网络传输。

    6. 设置用户媒体流优先级

    该版本新增接口 setRemoteUserPriority 用于设置远端用户的优先级。该方法可以与 setRemoteSubscribeFallbackOption 搭配使用。如果开启了订阅流回退选项，弱网下 SDK 会优先保证高优先级用户收到的流的质量。

    7. 音乐文件播放状态

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

    8. 设置日志文件大小

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

    9. 直播转码支持设置背景图片

    该版本在设置直播转码的 LiveTranscoding 类中，新增 backgroundImage 参数，支持设置直播转码合图的背景图片。

    10. 云代理服务

    该版本新增云代理服务，方便部署企业防火墙的用户正常使用 Agora 的服务，详见使用云代理服务。

    功能改进

    1. 质量测试与透明
    • 该版本在原有的 startEchoTest 中新增参数 intervalInSeconds，用于设置返回测试结果的时间间隔。
    • 该版本在本地视频流统计信息 LocalVideoStats 类中新增 targetBitrate，targetFrameRate，qualityAdaptIndication 三个参数，分别反映目标码率、目标帧率与和上次返回的本地视频流统计信息相比，本地视频质量的自适应情况。
    2. 视频偏好设置

    一般场景下，Agora 默认的视频编码配置能满足需求。对于特定场景，该版本提供如下功能让用户选择视频偏好：

    • 弱网下画质或流畅偏好设置。该版本在视频编码属性 VideoEncoderConfiguration 类中新增 2 个参数 minFrameRate 和 degradationPrefer，分别用于设置最低视频编码帧率，以及带宽受限时编码帧率的偏好。这两个参数需要搭配使用。
    • 采集时预览或性能偏好设置。该版本新增接口 setCameraCapturerConfiguration，通过设置摄像头采集偏好，用户可以根据实际场景选择优先保证设备性能还是视频质量。具体场景及参数选择，请参考 API 文档。
    3. 核心质量改进
    • 降低了音频延时
    • 提升了视频质量和稳定性
    • 缩短了远端视频的出图时间
    • 改善了屏幕共享直播弱⽹下视频流畅性和延迟

    问题修复

    音频
    • 修复了调用 enableLocalAudio 接口导致的蓝牙断开的问题
    • 新增支持中文字符音乐
    • 修复了高音声音变弱的问题
    • 修复了偶现的声音快放问题
    视频
    • 通过增加 renderMode 的默认值，修复了用户在没有设置的情况 下，窗口和画面比例不符合引发的拉伸问题
    • 部分低性能设备上出现的播放视频卡住的问题
    • 优化了 SDK 出图时间
    其他
    • 修复了偶现的崩溃问题
    • 修复了降低设备分辨率时，屏幕共享流被裁剪的问题。我们建议你使用 v2.4.0 最新的屏幕共享接口解决该问题，新接口为屏幕共享采用独立的采集参数，不再与摄像头输入共用。详见进行屏幕共享。
    • 修复了屏幕共享坐标为负时，无法共享桌面的问题
    • 修复了偶现的的回声问题
    • 修复了转码推流场景下，SEI 信息与媒体流不同步的问题

    API 变更

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

    新增
    废弃
    • startEchoTest
    • startScreenCapture
    • setVideoQualityParameters

    2.3.3 版

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

    改进

    为提升用户体验，屏幕共享做了大量算法优化。针对不同的共享场景提供不同的屏幕共享策略，尤其针对 PPT 翻页和网页浏览场景，提升了屏幕共享过程中的流畅度和清晰度。同时改善了通信场景下屏幕共享开启阶段画面模糊的现象。

    问题修复

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

    2.3.2 版

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

    升级必看

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

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

    如果你的 Native SDK 是由 v2.0.8 升级至 v2.3.2，Agora 建议你另外参考升级指南了解主要 API 的变动。

    新增功能

    1. 视频自采集（Push 模式）

    为方便用户在通话或直播中使用外部视频数据，该版本新增如下接口，支持使用 Push 方式进行视频自采集。启用后，应用程序需要将外部的视频帧封装成 AgoraVideoFrame 格式后，推送给 Agora SDK 进行编码和传输。该方法适用于用户在发送端自己做采集、渲染，然后把视频帧发送给 Agora SDK 进行编码和传输的场景。本地渲染需要用户自己完成。

    2. 音频自渲染（Pull 模式）

    为提升外部音频源的使用体验，该版本新增如下接口，支持使用 Pull 方式进行音频自渲染。启用后，应用程序会采用主动拉取的方式从音频引擎拉取远端已解码混音后的音频帧，用于外部音频播放。

    和语音观测器中的 onPlaybackAudioFrame 方法相比，该方法的优势在于：

    • 使用 onPlaybackAudioFrame 方法时，SDK 主动每 10 ms 回调数据给应用程序。如果应用程序处理有延时，就有可能会导致音频播放抖动；
    • 使用 pullAudioFrame 方法时，SDK 主动拉取音频帧。通过设置 AudioFrame 中的 samples 参数，SDK 可以指定需要的播放采样数量；同时 SDK 内部会通过调整缓存，帮助应用程序处理延时，从而有效避免因外部音频播放抖动导致的异常，如音频不同步等问题。Agora 推荐使用该方法。
    3. 提升直播清晰度

    Agora SDK 会根据网络条件进行码率自适应。为满足用户在直播场景下对视频清晰度的要求，该版本在 setVideoEncoderConfiguration 接口中新增 minBitrate 参数，强制视频编码器输出高质量图片。如果将参数设为高于默认值，在网络状况不佳情况下可能会导致网络丢包，并影响视频播放的流畅度。因此如非对画质有特殊需求，Agora 建议不要修改该参数的值。

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

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

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

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

    5. 直播中弱网环境下视频自动回退/重开

    网络不理想的环境下，直播音视频的质量都会下降。为提升直播效率，Agora 新增了 setLocalPublishFallbackOption 和 setRemoteSubscribeFallbackOption 两个接口。 用户设置这两个接口后，在网络条件差、无法同时保证音视频质量的情况下，SDK 会自动将视频流从大流切换为小流，或直接关闭视频流，从而保证或提高音频质量。同时 SDK 会持续监控网络质量，并在网络质量改善时恢复音视频流。在推流回退为音频流时，或由音频流恢复为音视频流，触发 onLocalPublishFallbackToAudioOnly 或 onRemoteSubscribeFallbackToAudioOnly 回调。

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

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

    7. 设置视频编码属性

    为满足场景中视频旋转的需要，提升自定义视频源画质，该版本引入 setVideoEncoderConfiguration 替换原 setVideoProfile 接口，来设置视频编码属性。 新接口中的 VideoEncoderConfiguration 类对应一套视频参数，包含视频的分辨率 dimension、帧率 frame rate、码率 bitrate、最低编码码率minBitrate 以及视频方向 orientationMode，其中 Agora 建议保留 minBitrate 的默认设置。原接口 setVideoProfile 仍可使用，但不再推荐。

    8. 虚拟声卡采集

    为提升声卡采集易用性，该版本在 enableLoopbackRecording 接口中新增参数 deviceName，支持用户使用虚拟声卡进行采集。该参数 NULL 时默认使用当前声卡采集。如需使用虚拟声卡，直接使用虚拟声卡的产品名传参即可。

    改进

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

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

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

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

    该版本对数据统计相关回调进行了统一梳理，相关回调及算法详见通话中数据统计。

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

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

    该版本废弃了原有的 onConnectionInterrupted 和 onConnectionBanned 回调。

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

    3. 优化打分反馈机制

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

    4. 音频设备热插拔逻辑优化，提升音频可用性

    优化了通话中和直播中的设备插拔选择，避免因用户主动切换设备而导致音频无声。

    5. 其他优化
    • 优化了直播场景下视频弱网抗丢包能力
    • 加快了严重拥塞状态视频的恢复速度
    • 提升了推流稳定性
    • 优化了 API 的调用线程
    • 增加了重新检测耳机插入和蓝牙设备连接的代码
    • 降低了音频延时
    • 优化了屏幕共享的性能

    问题修复

    SDK 相关

    修复了检测设备时出现的闪退问题

    音频
    • 修复了设备在连接蓝牙的状态下，退出频道后，音频不走蓝牙的问题
    • 修复了调用 startAudioMixing 播放音乐文件时出现的崩溃问题
    • 修复了麦克风在禁用的状态下，设备插上耳机后，禁用失效的问题
    • 修复了外放条件下，上下麦、系统电话打断、进退频道等多种场景下，出现的无法调节外放音量的问题
    • 修复了应用从后台切回前台时，出现的出声音慢的问题
    • 修复了音频模块的崩溃问题
    视频
    • 修复了因视频编码问题引起的 Native 设备与 Web 端互通时，Web 端看不到 Native 端视频画面的问题
    • 修复了 x86 设备上自采集图像时硬件编码器的相关问题
    • 修复了视频自采集时的偶现问题
    • 修复了 Windows 设备上出现的屏幕共享时鼠标位置问题
    • 修复了首帧出图时间过长的问题
    • 修复了共享桌面指定区域过程中，调用 setVideoProfile 设备视频编码属性时，出现的共享画面左右颠倒的问题
    • 修复了屏幕共享时出现的本地和远端鼠标位置不一致的问题
    • 修复了使用高分辨率视频屏幕共享时出现的卡糊的问题

    API 变更

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

    新增
    废弃

    2.2.2 版

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

    修复问题

    • 修复了偶发的线上统计崩溃的问题
    • 修复了特定场景下偶发的视频窗口尺寸变化后，视频卡住的问题
    • 修复了偶发的无法正常反馈频道内谁在说话以及说话者的音量的问题

    2.2.1 版

    该版本于 2018 年 5 月 30 日发布。内部代码优化。

    2.2.0 版

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

    升级必看

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

    新增功能

    本次发版新增如下功能：

    1. 音效混响进频道

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

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

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

    通过 Agora 部署的代理服务器，方便有企业防火墙的用户设置代理服务器，以使用 Agora 的服务。

    修复了连麦后退出频道后再进入频道连麦对端看不到自己的问题。

    3. 获取远端视频状态

    新增 onRemoteVideoStateChanged 接口，以获知远端视频流的状态。

    4. 视频水印

    在本地直播及旁路直播中增加水印功能，允许用户将一张 PNG 图片作为水印添加到正在进行的本地直播或旁路直播中。新增 addVideoWatermark 和 clearVideoWatermarks 接口，以添加或删除本地直播水印；LiveTranscoding 接口中新增 watermark 参数，用于控制旁路直播中水印的添加。

    改进功能

    本次发版改进如下功能：

    1. 当前说话者音量提示

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

    2. 频道内网络质量监测

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

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

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

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

    提升了用户在播放音乐等场景下的音乐音质。

    修复问题

    • 修复了大量用户同时直播连麦时，偶发的抖屏现象

    • 修复了 Windows 设备在直播场景下偶发的音频卡顿问题

    2.1.3 版

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

    升级必看

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

    问题修复

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

    改进

    改进了通信和直播场景下屏幕共享的效果，缩短了用户从屏幕共享模式切换回普通模式需要的时间间隔。

    2.1.2 版

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

    升级必看

    SDK 升级至 2.1.2 的直播场景后，相同分辨率下，视频更清晰，但带宽也会变大。

    问题修复

    • 修复了连麦后退出频道后再进入频道连麦对端看不到自己的问题。

    • 修复了通信场景的屏幕共享清晰度小于直播场景的问题。

    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 查询用户在频道中的状态信息，查询指定频道内的分角色用户列表，查询厂商频道列表，查询用户是否为连麦用户等。

    4. 17 人视频

    在直播场景下，同一频道内支持 17 位主播同时进行视频直播和连麦。

    5. 插入外部视频源

    直播场景下，可以将采集到的视频添加到正在进行的直播中，直播室里的主播和观众可以一起边看电影、比赛或演出，边进行点评、互动等功能，会让现有的直播话题更广、体验更好。 仅支持拉入一路流，格式包括: RTMP, HLS, FLV。赛事直播最多同时支持 5 人连麦直播。

    6. 新增直播场景下的屏幕共享功能

    • 在 2.1.0 以前: Agora SDK 仅支持视频通话场景下的屏幕共享功能;

    • 从 2.1.0 开始: Agora SDK 正式支持直播场景下的屏幕共享功能;

    7. 声卡采集

    新增 API enableLoopbackRecording 开启视声卡采集，开启后 SDK 可以采集到本地播放的所有声音。

    改进

    本次发版改进如下功能：

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

    问题修复

    • 修复了摄像头采集失败问题;

    • 修复了偶现的崩溃;

    • 修复了偶现的视频卡顿问题;

    2.0 版

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

    升级必看

    致各位开发者:

    由于 Agora 的产品升级， 当 Windows SDK 升级至 2.0 将不支持 Agora Recording Server（<=1.8.2）的调用接口，相关 API 将被废弃。

    受影响范围

    • 使用 Windows SDK 并且使用 Agora Recording Server（<= version 1.8.2）的用户
    • 涉及到的 API 为 startRecordingService，stopRecordingService 以及 refreshRecordingServiceStatus，将在后续版本中不再支持。

    解决方案

    我们提供了两种方案供您选择:

    方案一: 将 Agora Recording Server（<= version 1.8.2）升级到 Agora Recording SDK( >= version 1.12)。Agora Recording SDK 无需在客户端触发录制，将不影响 Windows SDK 的后续升级（推荐该方法）

    方案二：如果你希望继续使用 Agora Recording Server，维持 Windows SDK 版本不变（<=v1.14），将不影响您继续使用 Windows SDK的 API 触发录制。

    若您有任何疑问，可以通过以下方式获得技术支持:

    1. 通过 Agora 开发者社区提问
    2. 通过 Agora 工单系统提交工单
    3. 您还可以随时联系技术支持群里的同事或商务

    新增功能

    • 通信场景支持视频大小流功能，新增 API setRemoteVideoStreamType 和 enableDualStreamMode ;

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

      名称 描述
      setExternalAudioSource 设置外部音频采集参数: 采样率，通道数等
      pushExternalAudioFrame 推送外部音频帧

    • 通信和直播场景下支持服务端踢人功能。如有需要，请联系 sales@agora.io 开通该功能。

    • 支持 Windows 64 位;

    • 增加音量、静音设置/获取接口以及系统音量、静音同步引擎事件接口, 详见:

      名称 描述
      setPlaybackDeviceVolume 设置播放设备音量
      getPlaybackDeviceVolume 获取播放设备音量
      setRecordingDeviceVolume 设置麦克风音量
      getRecordingDeviceVolume 获取麦克风音量
      setPlaybackDeviceMute 静音播放设备
      getPlaybackDeviceMute 获取播放设备静音状态
      setRecordingDeviceMute 静音麦克风
      getRecordingDeviceMute 获取麦克风静音状态
      onAudioDeviceVolumeChanged 当放音、录音、应用程序音量发生变化时触发该回调

    问题修复

    修复了加入频道后出现的崩溃。

    1.14 版

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

    新增功能

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

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

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

    改进

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

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

    • 节省带宽:

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

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

    • 精准的码率控制:

      • 1.14 以前: 码率控制不够精准，上下波动幅度较大。波动过大容易造成网络拥塞，增加丢包、丢帧的概率，影响了带宽估计模块的精度，特别是在弱网低码率情况下尤为明显。

      • 1.14 开始: 精准的码率控制，要多少给多少，不多给也不少给，避免波动过大造成的网络拥塞，减少传输延时，有助于减少网络卡顿。

    问题修复

    • 修复了部分 Windows 机器上无声音的问题。

    • 修复了部分 Windows 机器上的摄像头问题。

    1.13.1 版

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

    优化

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

    1.13 版

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

    新增功能

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

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

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

    • 屏幕共享直播场景下采集声卡选项动态开启和关闭。

    改进

    • 软编情况下，视频属性可控。

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

    • 屏幕共享: 提升了画质清晰度和流畅度。

    • 屏幕共享: 通信场景下新增动态更新截图区域。

    修复问题

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

    1.12 版

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

    新增功能

    • 直播场景下， 新增 API 方法 injectStream 在当前频道内插入一条 RTMP 流。该功能目前为 beta 版

    • 在 API 方法 setEncryptionMode 里新增加密模式 aes-128-ecb 。

    • 在 API 方法 startAudioRecording 里新增参数 quality用于设置录音音质。

    • 新增 API onActiveSpeaker 提示当前频道内谁在说话。

    • 通信场景下，删除了原有的 API 方法 setScreenCaptureWindow，更新 API 方法 startScreenCapture 共享整个屏幕、指定窗口或指定区域

    • 通信场景下，启用屏幕共享功能后，在屏幕共享过程中可以显示鼠标

    改进

    通信场景下针对 320 x 180 分辨率提供了以下改进方案:

    • 网络和设备状态较差的情况下仍能保证画质流畅度。

    • 网络和设备状态良好的情况下可以做到比 180P 更好的画质清晰度。

    修复问题

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