本文提供声网视频 SDK 的发版说明。
SDK 自 3.4.6 版本起对 iOS 15 进行了兼容性适配。对 3.2.0(含)及 3.4.5(含)之间的 SDK 版本,在 iOS 15 上高概率会发生崩溃。为避免该问题,请务必将 SDK 升级至 3.4.6 或之后版本。
该版本于 2022 年 11 月 2 日发布。
升级必看
为增加 SDK 安全性,该版本对使用的第三方开源库进行如下更新:
改进
考虑到用户的图片可能破损,例如,用户下载的图片不完整,用户设备病毒损坏了图片,该版本在虚拟背景功能中增加了对破损图片的兼容,支持将部分破损图片设为虚拟背景。
问题修复
该版本修复了如下问题:
enableInEarMonitoring
开启耳返时,无耳返效果。setAudioMixingPosition
设置音乐文件的播放位置在 36 分钟或之后的位置时,音乐会从头开始播放,而非从指定的位置开始播放。该版本于 2022 年 8 月 4 日发布。
1. 设置本地代理
该版本新增 setLocalAccessPoint
方法,用于设置本地代理。
1. 超分辨率(Beta)
该版本废弃 enableRemoteSuperResolution
方法,并新增同名方法,用于开启超分辨率功能,即对接收到的某个远端用户的视频宽和高均扩大为 2 倍像素。
相比废弃方法,新方法中增加 mode
参数。该参数可设为如下值:
AgoraVideoSRModeManual(0)
: 表示对你指定的远端用户进行超分辨率处理。AgoraVideoSRModeAuto(1)
: 表示对频道内最大的渲染窗口所对应的远端用户进行超分辨率处理。AgoraSuperResolutionExtension.xcframework
动态库。其他注意事项详见 enableRemoteSuperResolution 文档。
2. 跨频道媒体流转发
该版本优化了 SDK 与跨频道媒体流转发服务器连接机制,提高了跨频道媒体流转发的成功率。
该版本修复了如下问题:
remoteAudioStateChangedOfUid(2,6)
回调。reportRtcStats
回调报告的 gatewayRtt
不准确。 playEffect
或 startAudioMixing
播放 8 位 PCM 编码的 WAV 格式音频时,偶现崩溃。networkQuality
回调报告的上行网络质量不准确。 localAudioStateChange
回调报告的本地音频出错原因与实际不符。新增
setLocalAccessPoint
didProxyConnected
中新增支持 localProxyIp
参数AgoraProxyType
中新增 AgoraNoneProxyType(0)
和 AgoraLocalProxyType(3)
enableRemoteSuperResolution
setCameraCaptureRotation
AgoraSuperResolutionStateReason
中新增 AgoraSRStateReasonInsufficientPerformance(4)
AgoraVirtualBackgroundSourceStateReason
中新增 AgoraVBSStateReasonInsufficientPerformance(4)
废弃
enableRemoteSuperResolution
该版本于 2022 年 6 月 6 日发布。
该版本修复了频道内 Web 端发送 H.264 视频流时,Native 端看到 Web 端视频卡顿的问题。
该版本于 2022 年 4 月 11 日发布。
1. JND 库集成变更
自 3.7.0 版起,SDK 默认静态编译 JND 库,不再提供插件的方式。如果你已集成 JND 插件,升级至 3.7.0 版时请在项目依赖中删除 JND 插件并重新编译项目。JND 插件的介绍可参考插件列表。
2. 优化集成 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 |
---|---|---|
AgoraRtcEngineKit 类中的 - (int)updateScreenCaptureParameters:(AgoraScreenCaptureParameters* _Nonnull)captureParams; |
updateScreenCaptureParameters() | update() |
AgoraRtcEngineKit 类中的 - (int)setScreenCaptureContentHint:(AgoraVideoContentHint)contentHint; |
setScreenCaptureContentHint() | setScreenCapture() |
AgoraAudioDataFrameProtocol 协议中的 - (BOOL)onRecordAudioFrame:(AgoraAudioFrame* _Nonnull)frame; |
func onRecordAudioFrame(_ frame: AgoraAudioFrame) -> Bool {} | func onRecord(_ frame: AgoraAudioFrame) -> Bool {} |
AgoraRtcScreenCapture 接口中的 + (instancetype _Nonnull)screenCaptureWithId:(NSUInteger)displayId rect:(CGRect)rect dimensions:(CGSize)dimensions frameRate:(NSInteger)frameRate bitrate:(NSInteger)bitrate captureMouseCursor:(BOOL)captureMouseCursor; |
screenCapture(withId: rect: dimensions: frameRate: bitrate: captureMouseCursor:) | init(id: rect: dimensions: frameRate: bitrate: captureMouseCursor:) |
1. 空间音效
该版本新增空间音效功能,用于塑造远端用户声音的方位感和模拟声音在真实世界中的传播过程,实现本地用户听远端用户时的空间音效。
如有需要,请联系 sales@shengwang.cn。
2. 屏幕共享
该版本新增 startScreenCapture
、stopScreenCapture
、updateScreenCapture
方法,支持在该平台开启屏幕共享。屏幕共享的实现方法请参考屏幕共享。
3. 本地语音音调
该版本新增 enableLocalVoicePitchCallback
方法和 reportLocalVoicePitchFrequency
回调,允许 SDK 按设置的时间间隔向 app 报告本地用户的语音音调。
4. 远端首帧出图回调
该版本在 AgoraRtcChannelDelegate
类中新增 firstRemoteVideoFrameOfUid
回调,以在多频道场景下向本地用户报告远端用户的首帧视频已渲染。你还可以从该回调中获取远端用户 ID、视频宽度 (px)、高度 (px)、首帧出图时间 (ms)。
5. 切换用户角色失败回调
该版本新增 didClientRoleChangeFailed
回调,用于报告直播场景下用户切换角色失败的原因和当前的用户角色。
6. 网络连接发生改变的原因
为方便用户了解网络连接发生改变的原因,该版本在 AgoraConnectionChangedReason
中新增如下枚举:
AgoraConnectionChangedSameUidLogin(19)
:使用相同的 UID 从不同的设备加入同一频道。AgoraConnectionChangedTooManyBroadcasters(20)
:频道内主播人数已达上限。该枚举仅在开启 128 人功能后报告。1. 频道能力提升
自该版本起,单个频道可支持最多 128 位主播同时在线并同时发布音视频流,观众人数无限制,每位主播或观众最多可同时订阅 50 位主播。
如有需要,请联系 sales@shengwang.cn。
2. 虚拟背景
测试结果和用户反馈显示,虚拟背景功能在多种复杂背景环境和多种人物姿态下均提升了实际效果。因此,自该版本起,虚拟背景由 Beta 功能转变为正式功能。
3. 新版 AI 降噪
自该版本起,声网在原版 AI 降噪功能的基础上增加了新版 AI 降噪功能,拥有更好的降噪效果。如果你希望体验新版 AI 降噪,请联系 sales@shengwang.cn。
4. playEffect 优化
为避免阻塞,该版本优化了 playEffect
的内部实现逻辑,以减少播放音效文件时的卡顿。
5. 音频体验优化
该版本改善了网络突发抖动和高丢包情况下的音频卡顿问题。
6. 传输升级
该版本升级了传输协议和算法,增强了弱网对抗能力。同时,优化了多人视频场景的可伸缩视频编码能力,提升了视频体验。
该版本修复了 app 离开频道并退后台一段时间后,再切回前台时低概率性无法重新加入频道的问题。
新增
startScreenCapture
stopScreenCapture
updateScreenCapture
enableLocalVoicePitchCallback
reportLocalVoicePitchFrequency
AgoraRtcChannelDelegate
类中新增 firstRemoteVideoFrameOfUid
didClientRoleChangeFailed
AgoraConnectionChangedReason
中新增 AgoraConnectionChangedSameUidLogin(19)
和 AgoraConnectionChangedTooManyBroadcasters(20)
AgoraLocalVideoStreamError
中新增:AgoraLocalVideoStreamErrorExtensionCaptureStarted(13)
AgoraLocalVideoStreamErrorExtensionCaptureStoped(14)
AgoraLocalVideoStreamErrorExtensionCaptureDisconnected(15)
废弃
AgoraWarningCodeSetClientRoleNotAuthorized(119)
,改用 AgoraClientRoleChangeFailedReason
该版本于 2022 年 2 月 22 日发布。
1. 使用 CocoaPods 时删除插件
插件指可选集成到项目文件的动态库。自该版本起,通过 CocoaPods 集成 iOS SDK 时,声网支持你通过在 Podfile 中使用 subspecs
字段指定集成你需要的动态库,以排除你不需要使用的插件,从而减少集成 SDK 后的应用体积。示例代码和 subspecs
字段详情请参考减少 App 体积。
2. 视频增强
继基础美颜后,声网新增支持更多视频增强功能:
setVideoDenoiserOptions
方法设置开/关视频降噪和视频降噪效果选项。setLowLightEnhanceOptions
方法设置开/关暗光增强和暗光增强效果选项。setColorEnhanceOptions
方法设置开/关色彩增强和色彩增强效果选项。AgoraVideoProcessExtension.xcframework
动态库。3. Wi-Fi 加速
该版本新增支持并默认开启 Wi-Fi 加速功能。当 SDK 发现集成加速插件的 Wi-Fi 路由器后,该功能会正式生效,使路由器合理分配 Wi-Fi 频谱资源,以降低丢包率和时延,从而减少音视频卡顿。
当路由器提供加速服务后,SDK 会周期性触发 wlAccStats
回调,报告 Wi-Fi 加速效果,并在 Wi-Fi 连接质量不佳时触发 wlAccMessage
回调,报告 Wi-Fi 连接质量不佳的原因和改善 Wi-Fi 连接的操作建议。
如果你不需要使用 Wi-Fi 加速功能,可以在加入频道前调用 enableWirelessAccelerate(NO)
关闭该功能。
4. 视频截图上传
为满足对视频内容监管的需求,该版本新增 enableContentInspect
方法,支持开启视频截图上传。成功开启视频截图上传后,SDK 会根据你在 AgoraContentInspectConfig
中设置的视频截图上传模块和频率对本地用户发送的视频进行截图、上传。截图完成后,声网服务器会以 HTTPS 请求的形式通知你的服务器,并将所有截图发送至你指定的第三方云存储。
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
播放音频文件的体验,具体如下:
getAudioFileInfo
获取的音频时长更加准确。如果你希望体验这些优化,请确保已集成 AgoraFullAudioFormatExtension.xcframework
动态库。考虑到该库的体积较大,如果你对 app 体积有限制且不需要体验这些优化,你可以在集成 SDK 时自行删除该动态库。详见减少 App 体积。
4. 音频文件格式
该版本新增支持播放如下格式的音频文件:
对于 MP4 和 M4A 格式的在线文件,媒体信息(moov)必须在媒体数据(mdat)之前。
5. 音频设备出错
为方便获取系统电话对音频采集的影响,该版本在 AgoraAudioLocalError
中新增 AgoraAudioLocalErrorInterrupted(8)
,报告音频采集被系统电话中断。
该版本修复了如下问题:
startAudioMixing
播放特定的 WAV 音频文件,播放一段时间后会出现无声。startAudioMixing
成功后,时隔 3 秒才收到 localAudioMixingStateDidChanged
回调。addVideoWatermark
添加水印,水印颜色与原色不同。新增
setVideoDenoiserOptions
setLowLightEnhanceOptions
setColorEnhanceOptions
enableWirelessAccelerate
wlAccStats
wlAccMessage
enableContentInspect
contentInspectResult
AgoraAudioRecordingConfiguration
中新增 recordingChannel
AgoraAudioRecordingConfiguration.recordingQuality
中新增 AgoraAudioRecordingQualityUltraHigh(3)
didProxyConnected
AgoraCloudProxyType
中新增 AgoraTcpProxy(2)
AgoraAudioLocalError
中新增 AgoraAudioLocalErrorInterrupted(8)
修改
AgoraCloudProxyType
中的 AgoraNoneProxy(0)
的行为该版本于 2022 年 1 月 16 日发布,修复了 Web 用户恢复发送音频流后,3.6.0 或之后版本的 Native 用户可能听不到 Web 用户声音的问题。
该版本于 2022 年 1 月 12 日发布。
该版本进行如下改进:
leaveChannel
或网络中断等原因而离开频道后,本地用户看到远端画面停留在最后一帧,而不再是远端视图直接消失。该版本修复了如下问题:
AgoraVideoProcessExtension.xcframework
动态库后,应用上传 Apple App Store 报错。startAudioMixing
无法播放以 “ipod-library://”
开头的本地 iTunes 音乐文件。该版本于 2021 年 12 月 10 日发布,修复了 3.6.0 版将动态库 Agorafdkaac.xcframework
错误地更名为 AgoraFDKAACExtension.xcframework
的问题。
该版本于 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)
:预留参数。转码推流时,添加多张水印、背景图片:通过在 AgoraLiveTranscoding
类中新增 watermarkArray
、backgroundImageArray
实现。
转码推流时,设置每张水印、背景图片的图层编号和透明度:通过在 AgoraImage
结构体中新增 zOrder
和 alpha
实现。
转码推流时,使用 HE-AAC v2 音频编解码器:通过在 AgoraAudioCodecProfileType
中新增 AgoraAudioCodecProfileHEAACv2
实现。
音画同步
同一用户可能使用两个设备分别发送音频流和视频流,为保证接收端听到和看到的音频和视频的时间同步性,该版本新增 setAVSyncSource
方法。你可以在视频发送端调用该方法,并传入音频发送端的频道名、用户 ID,SDK 会以发送的音频流的时间戳为基准进行自动调节发送的视频流,以保证即使在两个发送端的上行网络情况不一致(如分别使用 Wi-Fi 和 4G 网络)的情况下,也能让接收端听到和看到的音频和视频同步。
1. 基础美颜
该版本更新了声网基础美颜算法,提升了你通过 setBeautyEffectOptions
方法开启的基础美颜效果。为平衡美颜效果,该版本将 lighteningLevel
(美白程度)的默认值从 0.7 改为 0.6,并在 AgoraBeautyOptions
结构体中新增 sharpnessLevel
支持设置锐化程度。
自该版本起,调用 setBeautyEffectOptions
前,请确保已集成 AgoraVideoProcessExtension.xcframework
动态库。否则,你无法体验新的声网基础美颜算法带来的基础美颜效果和锐度调节功能,只能体验原来的声网基础美颜算法带来的基础美颜效果。
2. 首帧出图
该版本缩短了弱网环境下首帧出图时间,提升用户视频体验。
该版本修复了如下问题:
AgoraAudioScenarioChatRoomGaming
后,加入频道会中断第三方音乐播放器播放的音乐。setAudioMixingPitch
调整音调会导致播放的歌曲从原唱切换为伴奏。新增
AgoraRtmpStreamingState
中新增 AgoraRtmpStreamingStateDisconnecting(5)
AgoraRtmpStreamingErrorCode
中新增如下:
AgoraRtmpStreamPublishErrorNotBroadcaster(11)
AgoraRtmpStreamPublishErrorTranscodingNoMixStream(13)
AgoraRtmpStreamPublishErrorNetDown(14)
AgoraRtmpStreamPublishErrorInvalidAppId(15)
AgoraRtmpStreamingEvent
中新增如下:
RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT(3)
RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN(4)
AgoraLiveTranscoding
类中新增 watermarkArray
和 backgroundImageArray
在 AgoraImage
中新增 zOrder
和 alpha
在 AgoraAudioCodecProfileType
中新增 AgoraAudioCodecProfileHEAACv2
在 AgoraBeautyOptions
类中新增 sharpnessLevel
修改
将 lighteningLevel
的默认值从 0.7 改为 0.6
该版本于 2021 年 11 月 25 日发布。
1. 加入频道失败时返回的错误码变更
为准确报告加入频道失败的原因,自该版本起,在如下情况,SDK 直接在加入频道方法的返回值中返回 -17(AgoraErrorCodeJoinChannelRejected)
:
AgoraRtcEngineKit
频道的用户使用有效的频道名再次调用 AgoraRtcEngineKit
类中的加入频道方法。AgoraRtcChannel
频道的用户再次调用该 AgoraRtcChannel
对象的加入频道方法。在之前的版本中,发生上述错误时,SDK 可能通过 didOccurError
回调报告错误码 17
,或在加入频道方法的返回值中返回 -5(AgoraErrorCodeRefused)
。
2. 蓝牙规范选择
为确保与蓝牙耳机的连接,自该版本起,当通信场景下的用户或直播场景下的主播使用蓝牙耳机时,SDK 会检测设备是否支持蓝牙免提规范(Hands-Free Profile, HFP)并根据检测结果选择蓝牙规范,具体如下:
1. 音视频录制
为方便用户在客户端录制本地音视频,该版本新增 AgoraMediaRecorder
类,支持录制以下内容:
录制生成的文件保存在用户本地。
成功初始化 AgoraRtcEngineKit
对象后,你可以调用 AgoraMediaRecorder
类中的如下方法和回调实现本地音视频录制功能:
sharedMediaRecorderWithRtcEngine
:创建 AgoraMediaRecorder
实例。startRecording
:设置录制的内容、时长、生成文件的格式、回调间隔,并开启本地音视频录制。stopRecording
:停止本地音视频录制。destroy
:释放 AgoraMediaRecorder
实例。stateDidChanged
:录制状态发生改变回调。informationDidUpdated
:录制信息更新回调。2. 视频截图
该版本新增 takeSnapshot
方法,支持对指定用户的视频进行截图,生成 JPG 格式图片,并保存至指定的路径。成功调用该方法后,SDK 触发 snapshotTaken
回调报告截图是否成功和获取截图的详情。
3. 音视频通话回路测试
为方便用户自行检查本地音频设备、视频设备、网络状态能否保障正常发送、接收音视频流,该版本新增 startEchoTestWithConfig
方法。你可以在加入频道前调用该方法,以测试用户的音视频设备和网络回路是否正常。
相比 startEchoTestWithInterval
,startEchoTestWithConfig
支持测试视频设备,可保障测试的安全性,不支持设置返回测试结果的时间间隔。
1. 性能改进
通过优化 FEC(Forward Error Correction)编解码,小幅降低视频场景下的 CPU 占用率。
2. 体验改进
通过优化拥塞控制算法,提升弱网环境下视频清晰度和流畅度。
该版本修复了如下问题:
startAudioMixing
时,远端用户听到的人声和伴奏有轻微的不同步。enableDualStreamMode(NO)
后,当该用户从使用 setVideoSource
自采集 Screen
类型的外部视频切换到 SDK 采集,本地会发送视频双流。该版本新增如下:
startEchoTestWithConfig
sharedMediaRecorderWithRtcEngine
stateDidChanged
informationDidUpdated
startRecording
stopRecording
destroy
takeSnapshot
snapshotTaken
该版本于 2021 年 10 月 13 日发布。
1. 超分辨率(Beta)
为有效地提升本地用户看到的远端视频画面的分辨率,该版本新增支持超分辨率功能。你可以调用 enableRemoteSuperResolution
开启超分辨率。SDK 会触发 superResolutionEnabledOfUid
回调报告是否已成功开启该功能。如果未成功开启,请通过 reason
排查问题。
2. 背景虚化
为丰富虚拟背景的效果,该版本新增支持用户调用 enableVirtualBackground
开启虚拟背景时设置背景虚化。你需要将自定义的背景图类型设为 AgoraVirtualBackgroundBlur
,并根据用户希望的背景虚化程度设置 blur_degree
。
3. 打开闪光灯
为支持在 iOS 平台上调用 C++ API 打开设备闪光灯,该版本在 C++ 中新增如下 API:
isCameraTorchSupported
:检查设备是否支持打开闪光灯。setCameraTorchOn
:设置是否打开闪光灯。4. 暂停/恢复跨频道媒体流转发
为方便跨频道连麦中的主播快速暂停或恢复媒体流转发,该版本新增如下方法和和状态码:
pauseAllChannelMediaRelay
:暂停向所有目标频道转发媒体流。resumeAllChannelMediaRelay
:恢复向所有目标频道转发媒体流。AgoraChannelMediaRelayEventPauseSendPacketToDestChannelSuccess
(12):成功暂停向目标频道转发媒体流。AgoraChannelMediaRelayEventPauseSendPacketToDestChannelFailed
(13):暂停向目标频道转发媒体流失败。AgoraChannelMediaRelayEventResumeSendPacketToDestChannelSuccess
(14):成功恢复向目标频道转发媒体流。AgoraChannelMediaRelayEventResumeSendPacketToDestChannelFailed
(15):恢复向目标频道转发媒体流失败。成功调用 pauseAllChannelMediaRelay
或 resumeAllChannelMediaRelay
方法后,SDK 会触发 didReceiveChannelMediaRelayEvent
回调,并在回调中报告是否成功暂停或恢复媒体流转发。
5. 推送外部音频帧到指定位置
为满足不同场景对外部音频帧的不同处理要求,该版本废弃 pushExternalAudioFrameRawData
[1/2] 和 pushExternalAudioFrameSampleBuffer
[1/2],并新增带 sourcePos
参数的 pushExternalAudioFrameRawData
[2/2] 和 pushExternalAudioFrameSampleBuffer
[2/2] 替代。你可以将外部音频帧推送到音频采集后、编码前或本地播放前的位置。例如,在 KTV 场景中,将歌声推送到音频采集后的位置,将伴奏推送到音频编码前的位置,既让歌声经过 SDK 音频模块的处理,又让伴奏不受 SDK 音频模块的影响。
该版本还新增了 setExternalAudioSourceVolume
,你可以设置指定位置的外部音频帧音量。
6. 音乐文件高级设置
为设置音乐文件的播放速度、音轨和声道模式,该版本新增如下方法:
setAudioMixingPlaybackSpeed
: 设置当前音乐文件的播放速度。声网推荐取值范围为 [50,400],100 表示原始速度。getAudioTrackCount
: 获取当前音乐文件的音轨数量。selectAudioTrack
: 指定当前音乐文件的播放音轨。指定音轨的索引取值范围为 [0, getAudioTrackCount()
)。setAudioMixingDualMonoMode
: 设置当前音乐文件的声道模式为原始模式、左声道模式、右声道模式或混合模式。7. 获取音频文件信息
为获取任意音频文件的信息,该版本废弃 getAudioMixingDuration
并新增 getAudioFileInfo
替代。加入频道后,你可以调用 getAudioFileInfo
并通过 didRequestAudioFileInfo
回调获取指定音频文件的时长等信息。
1. 5G 移动网络的识别和质量测试
该版本新增对 5G 移动网络的识别和质量测试,具体如下:
AgoraNetworkType
中新增 AgoraNetworkTypeMobile5G (6)
枚举,当本地网络切换为 5G 时,SDK 触发 networkTypeChangedToType
回调报告该网络连接类型。enableLastmileTest
或 startLastmileProbeTest
测试 5G 网络连接质量。2. 其他改进
该版本还进行了如下改进:
该版本修复了如下问题:
AgoraAudioScenarioGameStreaming
场景下,偶现因音乐检测不准确导致的回声或噪声。enableLocalVideo(NO)
、enableLocalVideo(YES)
关、开本地视频采集或依次调用 muteLocalVideoStream(YES)
、muteLocalVideoStream(NO)
停止、恢复发送本地视频后,本地用户看远端用户偶现短暂黑屏。 pauseAudioMixing
,之后再调用 startAudioMixing
播放音频文件,播放失败。muteAllRemoteAudioStreams
,收到 remoteAudioStateChangedOfUid (AgoraAudioRemoteReasonLocalMuted)
15 秒后,错误地收到了 remoteAudioStateChangedOfUid (AgoraAudioRemoteReasonRemoteMuted)
。setAudioSessionOperationRestriction
后,偶现的远端音频无声。joinChannelByToken
方法时,返回值不准确。enableExternalAudioSourceWithSampleRate
不生效。 enableLocalAudio(NO)
后,SDK 额外触发 localAudioStateChange
回调报告 AgoraAudioLocalStateRecording(1)
。新增
enableRemoteSuperResolution
superResolutionEnabledOfUid
AgoraVirtualBackgroundSource
类中新增 blur_degree
属性和 AgoraBlurDegree
常量AgoraVirtualBackgroundSourceType
类中新增 AgoraVirtualBackgroundBlur
常量isCameraTorchSupported
(C++)setCameraTorchOn
(C++)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
该版本于 2021 年 9 月 26 日发布。
为改善使用蓝牙耳机时的音质,该版本优化了 SDK 选择蓝牙规范和音量类型的逻辑:
蓝牙规范:自该版本起,SDK 使用的蓝牙规范仅受用户角色影响:
音量类型:该版本规范了音量类型。用户使用蓝牙耳机时,SDK 使用的音量类型如下:
音频应用场景 | 通信场景下的用户或直播场景下的主播 | 直播场景下的观众 |
---|---|---|
Default |
通话音量 | 媒体音量 |
ChatRoomGaming |
通话音量 | 通话音量 |
GameStreaming |
媒体音量 | 媒体音量 |
ChatRoomEntertainment |
通话音量 | 通话音量 |
Education |
通话音量 | 媒体音量 |
ShowRoom |
通话音量 | 媒体音量 |
Meeting |
媒体音量 | 媒体音量 |
该版本修复了如下问题:
onRenderVideoFrame
和 onRenderVideoFrameEx
回调。didAudioMuted
、didVideoEnabled
、didLocalVideoEnabled
、firstRemoteVideoDecodedOfUid
函数。onCaptureVideoFrame
回调中进行耗时操作时,远端用户看本地用户的视频出现卡顿。startAudioMixing
成功播放音乐后,多次调用 setAudioMixingPosition
设置音乐文件的播放位置,音乐文件大概率会从头播放。getObservedFramePosition
的返回值为 AgoraVideoFramePositionPreEncoder (1 << 2)
后,SDK 会异常触发与设置的观测位置不符的 onCaptureVideoFrame
回调。AgoraAudioScenarioChatRoomGaming
的音频场景下,频道内用户将角色由观众切换为主播的瞬间,该用户听滋啦杂音。该版本于 2021 年 9 月 6 日发布,修复了如下问题:
AgoraReachability
命名冲突。FixedPortrait
模式时,分辨率宽高设置颠倒导致的大头问题。该版本于 2021 年 8 月 11 日发布,修复了特定场景下调用 setupLocalVideo
或 setupRemoteVideo
初始化本地或远端视图时出现的黑屏问题。例如:
setupLocalVideo(nil)
或 setupRemoteVideo(nil)
关闭本地或远端视图,再调用 setupLocalVideo
或 setupRemoteVideo
初始化本地或远端视图。remoteVideoStateChangedOfUid
回调中调用 setupRemoteVideo
初始化远端视图。该版本于 2021 年 8 月 4 日发布,修复了如下问题:
AgoraRtcEngineKit
强引用 AgoraRtcEngineDelegate
,导致 AgoraRtcEngineDelegate
对象只有在 AgoraRtcEngineKit
销毁时才释放且产生内存堆积。setupLocalVideo
和 setupRemoteVideo
时,注册原始视频数据观测器无法收到 onRenderVideoFrame
回调。AgoraRtcEngineKit
强引用 AgoraRtcEngineDelegate
的情况下会发生内存堆积。如果你设置了 AgoraRtcEngineKit
强引用 AgoraRtcEngineDelegate
,声网推荐你跳过该版本,升级到 3.5.0.2 版本。详见 3.5.0.2 版。该版本于 2021 年 7 月 20 日发布。
1. 虚拟背景(beta)
为满足用户对自定义虚拟背景的需求,该版本新增 enableVirtualBackground
方法,支持你开启虚拟背景,将用户的背景设为纯色或 PNG、JPG 格式的图片。同时,你可以通过 virtualBackgroundSourceEnabled
回调了解虚拟背景是否成功开启和相应的出错原因。
2. 原始音频数据多频道支持
在多频道场景下,为方便获取各频道的远端音频数据,该版本在 AgoraAudioFrame.h
中新增如下回调:
isMultipleChannelFrameWanted
onPlaybackAudioFrameBeforeMixingEx
成功注册音频观测器后,如果你将 isMultipleChannelFrameWanted
的返回值设为 YES
,并将 getObservedAudioFramePosition
的返回值设为 AgoraAudioFramePositionBeforeMixing (1 << 3)
,SDK 会触发 onPlaybackAudioFrameBeforeMixingEx
回调,向你发送多个频道的远端用户音频数据。
1. 视频画质
该版本对采集和接收的视频画质进行了如下改进:
setCameraAutoFocusFaceModeEnabled(NO)
。2. 其他改进
该版本还进行了如下改进:
该版本修复了如下问题:
enableLoopbackRecording
后,偶现本地用户听到自己的回声。muteLocalAudioStream(YES)
停止发布本地音频后,用户第一次加入频道可以听到远端用户,但退出频道后再次加入频道偶现无法听到远端用户。rxQuality
)不准确。reportRtcStats
回调报告的 memoryTotalUsageRatio
的值不准确。新增
enableVirtualBackground
virtualBackgroundSourceEnabled
isMultipleChannelFrameWanted
onPlaybackAudioFrameBeforeMixingEx
AgoraRtcEngineKit
强引用 AgoraRtcEngineDelegate
的情况下会发生内存堆积。如果你设置了 AgoraRtcEngineKit
强引用 AgoraRtcEngineDelegate
,声网推荐你跳过该版本,升级到 3.5.0.2 版本。详见 3.5.0.2 版。该版本于 2021 年 7 月 15 日发布。
为提升人脸检测结果的准确性,自该版本起,SDK 在检测到人脸消失后会立即触发 facePositionDidChangeWidth
回调。
该版本修复了如下问题:
nonnull
、 _Nullable
修饰符导致运行项目时出现警告。startAudioMixing
时传入经过百分号编码后的 URL,对应的在线音频文件播放失败。AgoraRtcEngineKit
强引用 AgoraRtcEngineDelegate
的情况下会发生内存堆积。如果你设置了 AgoraRtcEngineKit
强引用 AgoraRtcEngineDelegate
,声网推荐你跳过该版本,升级到 3.5.0.2 版本。详见 3.5.0.2 版。该版本于 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
和 muteLocalVideoStream
作为替代。你可以分别设置音频流和视频流的发布状态。AgoraRtcChannelMediaOptions
中新增 publishLocalAudio
和 publishLocalVideo
成员,默认值为 YES
。你可以在加入频道时设置音视频流的发布状态。如果用户已在一个频道中发流,则不论用户是主播还是观众,都需要在加入其他频道时设置 publishLocalAudio
和 publishLocalVideo
为 NO
。否则,加入频道会失败。setClientRole(AgoraClientRoleBroadcaster)
后,本地用户默认发布音视频流,无需再调用 publish
。publishLocalAudio = NO
和 muteLocalAudioStream(YES)
的功能相同。publishLocalVideo = NO
和 muteLocalVideoStream(YES)
的功能相同。上述优化也带来了 AgoraRtcEngineKit
类的部分行为变更:
AgoraRtcEngineKit
类的 muteLocalAudioStream
和 muteLocalVideoStream
对通过 AgoraRtcChannel
类创建的频道不生效,你需要改用 AgoraRtcChannel
类的 muteLocalAudioStream
和 muteLocalVideoStream
。options
参数的 joinChannelByToken
加入频道时,你可以设置音视频流的发布状态。options
参数的 joinChannelByToken
加入频道,muteLocalAudioStream
或 muteLocalVideoStream
只有在加入频道后调用才生效。如果你将 SDK 升级到 v3.4.5 或之后版本,为保证你的业务功能不受影响,声网推荐你修改 muteLocalAudioStream
、muteLocalVideoStream
、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
由同步调用改为异步调用。
原始视频数据和本地视频编码数据
为降低设备性能消耗和跨平台使用 C++ API 的开发难度,该版本在 iOS 平台新增如下 API 供你实现原始视频数据观测器和本地视频编码数据观测器。你可以用其实现各种自定义功能,如录制视频、截图、美颜。
原始视频数据观测器:
setVideoDataFrame
: 注册原始视频数据观测器。onCaptureVideoFrame
: 获取本地采集的视频数据。onPreEncodeVideoFrame
: 获取本地编码前的视频数据。onRenderVideoFrame
: 获取接收到的远端视频数据。getVideoFormatPreference
: 设置 SDK 输出的原始视频数据格式。getRotationApplied
: 设置是否旋转 SDK 输出的原始视频数据。getMirrorApplied
: 设置是否镜像 SDK 输出的原始视频数据。getObservedFramePosition
: 设置视频观测位置。isMultipleChannelFrameWanted
: 设置 SDK 是否输出多个频道内接收到的远端视频数据。onRenderVideoFrameEx
: 获取多个频道内接收到的远端视频数据。本地视频编码数据观测器:
setVideoEncodedFrame
: 注册本地视频编码数据观测器。onVideoEncodedFrame
: 获取本地视频编码数据。1.旁路推流
为向用户透明更多的旁路推流错误和事件,该版本新增如下:
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 响应时间过长而引起卡顿。新增
AgoraRtmpStreamingErrorCode
中新增 AgoraRtmpStreamingErrorCodeUnpublishOK (100)
AgoraRtmpStreamingEvent
中新增 AgoraRtmpStreamingEventUrlAlreadyInUse (2)
AgoraEncryptionMode
中新增 AgoraEncryptionModeAES128GCM2 (7)
和 AgoraEncryptionModeAES256GCM2 (8)
AgoraEncryptionConfig
中新增 encryptionKdfSalt
AgoraRtcChannel
中新增 muteLocalAudioStream
和 muteLocalVideoStream
AgoraRtcChannelMediaOptions
中新增 publishLocalAudio
和 publishLocalVideo
setVideoDataFrame
onCaptureVideoFrame
onPreEncodeVideoFrame
onRenderVideoFrame
getVideoFormatPreference
getRotationApplied
getMirrorApplied
getObservedFramePosition
isMultipleChannelFrameWanted
onRenderVideoFrameEx
setVideoEncodedFrame
onVideoEncodedFrame
AgoraAudioDataFrameProtocol
中新增:
修改
setAudioFrameDelegate
更名为 setAudioDataFrame
AgoraAudioFrameDelegate
更名为 AgoraAudioDataFrameProtocol
startAudioMixing
废弃
AgoraRtcChannel
类的 publish
和 unpublish
该版本于 2021 年 6 月 18 日发布,对 iOS 15 进行了兼容性适配。
该版本于 2021 年 6 月 16 日发布,修复了如下问题:
nonnull
、 _Nullable
修饰符导致运行项目时出现警告。startAudioMixing
无法播放扩展名为 m4a
的 MP3 本地音乐文件。setAudioProfile
并将 scenario
设置为 AgoraAudioScenarioEducation
。该版本于 2021 年 5 月 11 日发布,修复了如下问题:
该版本于 2021 年 4 月 22 日发布,修复了如下问题:
Non-public API usage
错误导致应用无法上架 Apple App Store。该版本于 4 月 16 日发布。
集成变更
为减少集成 SDK 后的 app 体积,该版本将部分功能以插件列表(命名以 Extension
为后缀)的形式发布,详见插件列表。如果你不需要使用相关插件功能,你可以直接删除对应的插件并重新编译项目。
行为变更
为监听音乐文件播放状态改变的原因,该版本对 localAudioMixingStateDidChanged
回调进行如下修改:
errorCode
参数修改为 reason
参数。AgoraAudioMixingErrorCode
,并新增 AgoraAudioMixingReasonCode
替代。通过 AgoraAudioMixingReasonCode
,你可以获取播放开始、暂停、停止或失败的原因。AgoraAudioMixingStateCode
的部分逻辑。例如,循环播放音乐时,播放完成或开始播放都会触发 AgoraAudioMixingStatePlaying
状态。如果你将 SDK 升级到 v3.4.0 或更高版本,为保证你的业务功能不受影响,声网推荐你修改 localAudioMixingStateDidChanged
的实现。
1. 虚拟节拍器
为满足在线教学等场景对节拍器的需求,该版本新增如下方法:
startRhythmPlayer
: 开启虚拟节拍器。stopRhythmPlayer
: 关闭虚拟节拍器。configRhythmPlayer
: 在开启虚拟节拍器后,重新配置虚拟节拍器。2. 音效文件播放进度
为控制音效文件的播放进度,该版本新增如下方法:
playEffect
3: 通过 startPos
参数,在播放音效文件时设置播放位置。setEffectPosition
: 在播放音效文件后,设置音效文件的播放位置。getEffectDuration
: 获取本地音效文件的总时长。getEffectCurrentPosition
: 获取音效文件的播放进度。同时,该版本废弃 playEffect
2,请使用 playEffect
3 替代。
1. 视频编码
声网 SDK 允许你通过 degradationPreference
设置带宽受限时本地视频编码降级偏好,如降低视频帧率保障视频质量,降低视频质量保障视频帧率。自该版本起,degradationPreference
新增支持设为 AgoraDegradationBalanced
,弱网下会降低视频帧率和视频质量,以在流畅性和视频质量之间取得平衡,适用于流畅性和画质均优先的场景,如一对一通话、一对一教学、多人会议。
2. 原始视频数据(C++)
getRotationApplied
和 getMirrorApplied
可将原始视频数据作旋转、镜像处理。为提升用户体验,该版本将这些回调函数支持处理的视频数据格式由 RGBA 拓展到 RGBA 和 YUV 420。
3. 音乐文件播放进度
为方便控制音乐文件的播放进度,该版本废弃 startAudioMixing
并新增同名方法替代。新方法允许你通过 startPos
参数在播放音乐文件时设置播放位置。
4. AirPlay 回调
该版本新增支持在 iOS 设备中触发 didAudioRouteChanged
回调并报告 AgoraAudioOutputRoutingAirPlay
。当用户在 iOS 设备上使用 Apple AirPlay 播放音频时,SDK 会触发该回调。
5. 客户端录音
为在录音时设置录音内容,该版本新增 startAudioRecordingWithConfig
方法并废弃 startAudioRecording
2。通过 startAudioRecordingWithConfig
的 config
参数,你可以设置录音音质、内容、采样率及录音文件的存储路径。
该版本还新增了错误码 AgoraErrorCodeAlreadyInRecording(160)
。如果你在当前录音结束前再次调用 startAudioRecordingWithConfig
,SDK 会报告该错误码。
6. 媒体设备出错
为方便用户了解本地视频出错原因,该版本在 AgoraLocalVideoStreamError
中新增错误码 AgoraLocalVideoStreamErrorCaptureNoDeviceFound(8)
,报告无法找到本地视频采集设备。
该版本修复了如下问题:
getMirrorApplied
设置镜像后,视频画面出现上下颠倒。onPreEncodeVideoFrame
获取 RGBA 格式的视频数据。getMirrorApplied
和 getRotationApplied
处理本地编码前的视频数据。enableSoundPositionIndication(YES)
后 reportAudioVolumeIndicationOfSpeakers
回调的音量信息不准确。setupLocalVideo
或 setupRemoteVideo
后调用如 getCallId
、getSdkVersion
的 get
方法或 destroy
方法,app 的用户界面会卡住。新增
startRhythmPlayer
stopRhythmPlayer
configRhythmPlayer
playEffect
3getEffectDuration
setEffectPosition
getEffectCurrentPosition
startAudioMixing
2startAudioRecordingWithConfig
3AgoraLocalVideoStreamError
中新增 AgoraLocalVideoStreamErrorCaptureNoDeviceFound(8)
AgoraErrorCodeAlreadyInRecording(160)
修改
废弃
startAudioRecording
2playEffect
2startAudioMixing
1AgoraAudioMixingErrorCode
该版本于 2021 年 3 月 29 日发布,修复了如下问题:
该版本于 2021 年 3 月 4 日发布。
基础变声
该版本新增 setVoiceConversionPreset
方法改变用户的声音。你可以把男声变得低沉、稳重,把女声变得甜美、中性。详见设置人声效果。
1. AES-GCM 加密模式
在安全要求高的场景中,为保证数据的保密性、完整性和真实性,提高数据加密的计算效率,该版本在 AgoraEncryptionMode
中新增如下枚举值:
AgoraEncryptionModeAES128GCM
: 128 位 AES 加密,GCM 模式。AgoraEncryptionModeAES256GCM
: 256 位 AES 加密,GCM 模式。2. 远端音频统计
为监测通话中与音频相关的主观体验,该版本在 remoteAudioStats
中增加 mosValue
,报告声网实时音频 MOS(平均主观意见分)评估系统对接收到的远端音频流的质量评分。
该版本修复了如下问题:
reportAudioVolumeIndicationOfSpeakers
回调获取远端用户音量。enableLocalVideo(NO)
有可能会崩溃。新增
setVoiceConversionPreset
AgoraEncryptionMode
中新增 AgoraEncryptionModeAES128GCM
和 AgoraEncryptionModeAES256GCM
AgoraRtcRemoteAudioStats
中新增 mosValue
该版本于 2021 年 1 月 22 日发布。
1. 集成变更
为符合 Apple 对使用模拟器运行项目的要求,该版本对 SDK 包修改如下:
ALL_ARCHITECTURE
文件夹。该版本还新增了声网基础计算框架 AgoraCore.xcframework
。
请参考集成 SDK 将 SDK 集成至你的项目。
2. 订阅行为变更
该版本废弃了 setDefaultMuteAllRemoteAudioStreams
和 setDefaultMuteAllRemoteVideoStreams
,并修改了 mute
相关方法的如下行为:
mute
相关方法需要在加入频道或切换频道后调用,否则会不生效。mute
相关方法都能独立控制用户的订阅状态。一起调用 muteAll
为前缀的方法和 muteRemote
为前缀的方法时,后调用的方法会生效。muteAll
为前缀的方法设置是否订阅所有音频或视频流,包含调用时刻之后加入频道的用户的音频或视频流,即 muteAll
为前缀的方法包含了 setDefaultMute
为前缀的方法的功能。声网不推荐一起调用 muteAll
和 setDefaultMute
为前缀的方法,否则设置可能会不生效。更多介绍见设置订阅状态。
3. 人声状态行为变更
在远端用户的 reportAudioVolumeIndicationOfSpeakers
回调中,该版本将 vad
成员的值由始终为 0 修改为始终为 1。
1. 频道媒体选项
为方便开发者更灵活地控制媒体流订阅,该版本新增 joinChannelByToken
2 和 switchChannelByToken
2 方法,支持设置用户加入频道和切换频道时是否订阅频道内所有的远端音频流或视频流。
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. 采集画质
为更好地控制摄像头采集的画质,该版本新增支持自定义采集分辨率并监听采集异常:
自定义采集分辨率:调用 setCameraCapturerConfiguration
方法,将采集偏好设为 AgoraCameraCaptureOutputPreferenceManual(3)
并设置采集视频的宽高。
监听采集异常:
localVideoStats
回调的 captureBrightnessLevel
监听。localVideoStateChange(AgoraLocalVideoStreamStateFailed, AgoraLocalVideoStreamErrorCaptureFailure)
回调监听。localVideoStateChange(AgoraLocalVideoStreamStateCapturing, AgoraLocalVideoStreamErrorCaptureFailure)
回调监听。同时,为提升用户体验,该版本在 localVideoStateChange
回调中新增本地采集出错的原因:
AgoraLocalVideoStreamErrorCaptureInBackGround(6)
:应用处于后台。AgoraLocalVideoStreamErrorCaptureMultipleForegroundApps(7)
:应用窗口处于侧拉、分屏、画中画模式。7. 创建数据流
为了支持歌词同步、课件同步等场景,该版本废弃了原有的 createDataStream
方法,并使用新的同名方法替代,用于创建数据流,并设置数据流是否与发布到声网频道内的音频流同步以及接收到的数据是否有序。
1. 原始音频数据
该版本补齐了 iOS 平台的原始音频数据接口。你可以从原始音频数据接口获取原始音频数据,并进行前处理或后处理,获取想要的播放效果。
setAudioFrameDelegate
onRecordAudioFrame
onPlaybackAudioFrame
onMixedAudioFrame
onPlaybackAudioFrameBeforeMixing
2. 远端音频统计
为方便监测通话中与音频有关的主观体验,该版本在 AgoraRtcRemoteAudioStats
中增加 qoeQuality
和 qualityChangedReason
,报告接收远端音频时的体验质量以及体验质量较差的原因。
新增
setVoiceBeautifierParameters
AgoraVoiceBeautifierPreset
常量中新增 AgoraSingingBeautifier
enableDeepLearningDenoise
joinChannelByToken
2switchChannelByToken
2createDataStream
AgoraRtcEngineConfig
类中新增 logConfig
属性setAudioFrameDelegate
onRecordAudioFrame
onPlaybackAudioFrame
onMixedAudioFrame
onPlaybackAudioFrameBeforeMixing
AgoraRtcRemoteAudioStats
类中新增 qoeQuality
和 qualityChangedReason
属性setCloudProxy
AgoraRtcLocalVideoStats
类中新增 captureBrightnessLevel
属性AgoraCameraCapturerConfiguration
类中新增 captureWidth
和 captureHeight
属性AgoraCameraCaptureOutputPreference
常量中新增 AgoraCameraCaptureOutputPreferenceManual(3)
AgoraLocalVideoStreamError
常量中新增 AgoraLocalVideoStreamErrorCaptureInBackGround(6)
和 AgoraLocalVideoStreamErrorCaptureMultipleForegroundApps(7)
AgoraErrorCodeModuleNotFound(157)
废弃
setDefaultMuteAllRemoteVideoStreams
setDefaultMuteAllRemoteAudioStreams
setLogFile
setLogFileSize
setLogFilter
createDataStream
该版本于 2020 年 12 月 17 日发布,修复了如下问题:
enableEncryption
后,firstLocalVideoFramePublished
回调无法被触发。该版本于 2020 年 11 月 30 日发布。
1. 集成变更
自该版本起,SDK 包中新增以下文件:
Agorafdkaac.framework
: Fraunhofer FDK AAC 动态库。AgoraSoundTouch.framework
: SoundTouch 动态库。Agoraffmpeg.framework
: FFmpeg 动态库。如果你将 SDK 升级到 v3.2.0 或更高版本,请务必参考下述步骤在集成 SDK 时添加上述动态库:
AgoraRtcKit.framework
所在文件夹中。Agorafdkaac.framework
、AgoraSoundTouch.framework
和 Agoraffmpeg.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)加密方式。
极速直播
该版本新增 setClientRole
方法,支持设置观众的延时级别。你可以通过该方法在互动直播和极速直播之间切换:
详见极速直播产品概述。
1. 本地采集视频画质
为提升本地采集的视频画质,该版本对摄像头采集本地视频进行如下优化:
2. 会议场景
为提升多人会议的音频体验,该版本在 setAudioProfile
方法中新增 AgoraAudioScenarioMeeting(8)
。
3. 美声与音效
为提升美声与音效 API 的易用性,该版本废弃 setLocalVoiceChanger
和 setLocalVoiceReverbPreset
,并新增如下方法替代:
setVoiceBeautifierPreset
: 与 setLocalVoiceChanger
相比,该方法删除了小男孩等变声音效和空旷音效。setAudioEffectPreset
: 与 setLocalVoiceReverbPreset
相比,该方法新增了小男孩等变声音效、空旷音效、3D 人声音效和电音音效,并删除了摇滚和嘻哈音效。setAudioEffectParameters
: 对指定的音效选项进行更细节的设置。该版本支持的音效选项有 3D 人声和电音音效。4. CDN 转码推流
该版本在 AgoraLiveTranscoding
类中新增 videoCodecType
属性,支持设置转码输出视频流的编解码类型为 H.264 或 H.265。
5. 互动直播延时
互动直播场景下,观众看直播的延时降低了约 500 ms。
该版本修复了如下问题:
stopChannelMediaRelay
不生效的问题。AgoraErrorCodeAdmStartRecording(1012)
错误码的问题。新增
setClientRole
setAudioEffectPreset
setVoiceBeautifierPreset
setAudioEffectParameters
AgoraAudioScenario
中新增 AgoraAudioScenarioMeeting(8)
AgoraLiveTranscoding
类中新增 videoCodecType
属性废弃
setLocalVoiceChanger
setLocalVoiceReverbPreset
getSmoothRenderingEnabled
(C++)该版本于 2020 年 9 月 14 日发布。
为提升用户体验,防止 app 在 iOS 14.0 版本上触发查看本地网络设备的弹窗提示,该版本默认关闭本地网络连通质量报告功能。reportRtcStats
中的 gatewayRtt
参数会失效,请不要使用该参数获取客户端到本地路由器的往返延时。详见 FAQ。
如果你不介意弹窗提示,且需启用该功能,请联系技术支持。
该版本修复了如下问题:
firstLocalVideoFrameWithSize
和 firstRemoteVideoFrameOfUid
回调的触发时机不准确。该版本于 2020 年 8 月 27 日发布。
该版本修改了区域访问限制的区域码 AgoraAreaCode
,最新区域码如下:
AgoraAreaCodeCN
: 中国大陆。AgoraAreaCodeNA
: 北美区域。AgoraAreaCodeEU
: 欧洲区域。AgoraAreaCodeAS
: 除中国大陆以外的亚洲区域。 AgoraAreaCodeJP
: 日本。AgoraAreaCodeIN
: 印度。AgoraAreaCodeGLOB
:(默认)全球。如你此前调用 sharedEngineWithConfig
方法时指定了访问区域,在由之前版本升级至该版本时,请确保使用正确的区域码。
该版本于 2020 年 8 月 11 日发布。
1. 发布和订阅状态转换回调
该版本新增以下回调方便你了解音视频流当前的发布及订阅状态,有助于订阅和发布相关的数据统计:
didAudioPublishStateChange
: 音频发布状态发生改变。didVideoPublishStateChange
: 视频发布状态发生改变。didAudioSubscribeStateChange
: 音频订阅状态发生改变。didVideoSubscribeStateChange
: 视频订阅状态发生改变。2. 本地首帧发布回调
为提示用户本地音视频首帧已发布,该版本新增如下回调:
firstLocalAudioFramePublished
:已发布本地音频首帧回调。该回调取代 firstLocalAudioFrame
回调,我们推荐你不再使用 firstLocalAudioFrame
回调。firstLocalVideoFramePublished
:已发布本地视频首帧回调。3. 自定义数据上报
该版本支持自定义数据上报。如需试用,请联系 sales@shengwang.cn 开通并商定自定义数据格式。
1. 指定访问区域完善
该版本新增以下枚举值,在调用 sharedEngineWithConfig
创建 AgoraRtcEngineKit
实例时提供更多区域选择。指定访问区域后,集成了声网 SDK 的 app 会连接指定区域内的声网服务器。
AgoraIpAreaCode_JAPAN
: 日本。AgoraIpAreaCode_INDIA
: 印度。2. 屏幕共享
为提升屏幕共享的用户体验,该版本在 AgoraVideoSourceProtocol
协议中增加以下回调:
captureType
: 指定自采集的视频源类型。contentHint
: 指定自采集屏幕共享视频的内容类型。3. CDN 直播推流
为提升 CDN 直播推流用户体验,该版本新增 rtmpStreamingEventWithUrl
回调,报告推流过程中发生的事件,如未成功添加背景图或水印。
4. 加密
该版本新增 enableEncryption
方法,用于开启内置加密,并废弃原加密方法:
setEncryptionSecret
setEncryptionMode
与原加密方法相比,该方法新增对国密 SM4 加密模式的支持,你可以根据需要选择合适的加密模式。
5. 通话中质量透明
该版本进一步扩充了 AgoraRtcLocalAudioStats
类、AgoraRtcLocalVideoStats
类、AgoraRtcRemoteAudioStats
类和 AgoraRtcRemoteVideoStats
类的成员,提供更多音视频质量相关数据。
AgoraRtcLocalAudioStats
类新增 txPacketLossRate
,表示本端到声网边缘服务器的物理音频丢包率 (%)。AgoraRtcLocalVideoStats
类新增txPacketLossRate
: 本端到声网边缘服务器的物理视频丢包率 (%)。captureFrameRate
: 本地视频采集帧率 (fps)。AgoraRtcRemoteAudioStats
和 AgoraRtcRemoteVideoStats
类中新增 publishDuration
,表示远端音频流和视频流的累计发布时长(毫秒)。6. 设置音频编码属性
为提升音频性能,该版本对音频编码码率最大值进行如下优化:
Profile | 3.1.0 版本 | 3.1.0 版本之前 |
---|---|---|
AgoraAudioProfileDefault |
||
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 |
7. 日志扩容
该版本中,声网 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. 优化弱网环境下的视频体验
9. 其他改进
该版本修复了如下问题:
setAudioMixingPitch
方法时,部分参数不生效。setMediaMetadataDataSource
回调。新增
didAudioPublishStateChange
didVideoPublishStateChange
didAudioSubscribeStateChange
didVideoSubscribeStateChange
firstLocalAudioFramePublished
firstLocalVideoFramePublished
enableEncryption
AgoraRtcLocalAudioStats
类中新增 txPacketLossRate
AgoraRtcLocalVideoStats
类中新增 txPacketLossRate
和 captureFrameRate
AgoraRtcRemoteAudioStats
和 AgoraRtcRemoteVideoStats
类中新增 publishDuration
AgoraVideoSourceProtocol
协议中新增 captureType
和 contentHint
rtmpStreamingEventWithUrl
AgoraWarningCodeAdmCategoryNotPlayAndRecord(1029)
和 AgoraWarningCodeApmResidualEcho(1053)
AgoraErrorCodeNoServerResources(103)
废弃
setEncryptionSecret
setEncryptionMode
firstLocalAudioFrame
删除
AgoraWarningCodeAdmImproperSettings(1053)
该版本于 2020 年 6 月 18 日发布。主要修复如下问题:
registerVideoRenderFactory
(已废弃)方法导致的崩溃问题。该版本于 2020 年 5 月 27 日发布。
1. iOS 静态库升级动态库
为提升开发体验,该版本将 SDK 由静态库升级为动态库,不再支持静态库。使用动态库可以提高库的安全等级,方便 app 上传至 App Store,且避免与第三方库产生不兼容等问题。
如果你由之前版本的静态库升级为当前版本,需要重新集成,详见升级指南。
2. 视频观测位置 (C++)
自 v3.0.1 起,如果你想要获取 onPreEncodeVideoFrame
回调中的视频数据,除实现该回调外,还需要在 getObservedFramePosition
中将 POSITION_PRE_ENCODER (1 << 2)
设置为观测位置。
1. 调整音乐文件音调
为方便调整混音时音乐文件的播放音调,该版本新增 setAudioMixingPitch
方法。通过设置该方法的 pitch
参数,你可以升高或降低音乐文件的音调。该方法仅对音乐文件音调有效,对本地人声不生效。
2. 变声与混响
为提高用户的音频体验,该版本在 setLocalVoiceChanger
和 setLocalVoiceReverbPreset
中分别新增以下枚举值:
AgoraAudioVoiceBeauty
为前缀和以 AgoraAudioGeneralBeautyVoice
为前缀的枚举值,分别实现美音或语聊美声功能。AgoraAudioReverbPresetFx
为前缀的枚举值和 AgoraAudioReverbPresetVirtualStereo
,分别实现增强版混响效果和虚拟立体声效果。你可以查看进阶功能变声与混响了解使用方法和注意事项。
3. 人脸检测
该版本新增人脸检测功能。通过 enableFaceDetection
方法开启人脸检测后,SDK 会实时触发 facePositionDidChangeWidth
回调,向本地用户报告检测出的一系列结果,包括人脸距设备屏幕的距离。该功能可用于提醒用户注意用眼卫生,和屏幕保持一定距离。
4. 全屏显示视频
为提高用户观看视频的体验,该版本在视频显示模式中新增 AgoraVideoRenderModeFill(4)
模式。设置该模式后,视频尺寸会进行缩放和拉伸直至充满显示视图。你可以在调用以下方法设置用户视图时选择该显示模式:
setupLocalVideo
setupRemoteVideo
setLocalRenderMode
setRemoteRenderMode
5. 自渲染远端视图多频道支持
在多频道场景下,为方便通过 AgoraRtcChannel
类加入频道的用户使用视频自渲染功能,该版本在 AgoraRtcChannel
类新增 setRemoteVideoRenderer
和 remoteVideoRendererOfUserId
方法。
6. 远端音视频数据后处理多频道支持
在多频道场景下,为方便后处理各频道的远端音视频数据,该版本新增如下 C++ 接口:
IAudioFrameObserver
类中新增 isMultipleChannelFrameWanted
和 onPlaybackAudioFrameBeforeMixingEx
。IVideoFrameObserver
类中新增 isMultipleChannelFrameWanted
和 onRenderVideoFrameEx
。成功注册音频或视频观测器后,如果你将 isMultipleChannelFrameWanted
的返回值设为 true
,就可以通过上述回调获取多个频道对应的音频、视频数据。在多频道场景下,我们建议你将返回值设为 true
。
设置视频观测位置 (C++)
成功注册视频观测器后,你可以在视频处理的各节点观测并获取想要的视频数据,如本地采集的视频数据,接收的远端视频数据等。为降低设备耗能,该版本允许自定义视频观测位置。你可以通过修改 getObservedFramePosition
的返回值,设置只观测以下某个或多个位置的视频数据:
其他改进
didRemoteAudioStateChanged
回调不准、音频无声、混音、声音卡顿等问题didClientRoleChanged
回调多次等问题该版本新增以下 API:
setAudioMixingPitch
AgoraAudioVoiceChanger
枚举中新增以 AgoraAudioVoiceBeauty
为前缀和以 AgoraAudioGeneralBeautyVoice
为前缀的枚举值AgoraAudioReverbPreset
枚举中新增以 AgoraAudioReverbPresetFx
为前缀的枚举值,以及 AgoraAudioReverbPresetVirtualStereo
枚举值enableFaceDetection
facePositionDidChangeWidth
AgoraVideoRenderMode
枚举中新增 AgoraVideoRenderModeFill
AgoraRtcChannel
中新增 setRemoteVideoRenderer
和 remoteVideoRendererOfUserId
AgoraRtcRemoteAudioStats
中新增 totalActiveTime
AgoraRtcRemoteVideoStats
中新增 totalActiveTime
该版本于 2020 年 4 月 22 日发布。
设置区域访问限制
该版本新增 sharedEngineWithConfig
方法,支持在创建 AgoraRtcEngineKit
实例时指定服务器的访问区域。该功能为高级设置,适用于有访问安全限制的场景。目前支持的区域有中国大陆、北美、欧洲、亚洲(中国大陆除外)和全球(默认)。
指定访问区域后,集成了声网 SDK 的 app 在指定区域使用时,正常情况下会连接指定区域的声网服务器;在非指定区域使用时,会从所在区域和指定区域的服务器地址中,择优选择服务器建立连接。
该版本修复了无法连接蓝牙耳机的问题。
新增
该版本于 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_FULL_Dynamic。
使用动态库可以提高库的安全等级,方便 app 上传至 App Store,且避免与第三方库产生不兼容等问题。如果选择动态库,则需要重新进行集成并导入类。该步骤大约需要 5 分钟。详见《快速开始》中的集成 SDK 和导入类章节。
库类型 | ipa 体积 | 解压后体积 | Frameworks 文件夹体积 | 二进制文件体积 | Frameworks 文件夹 + 二进制文件总体积 |
动态库 | 31.1 M | 65 M | 51.47 M | 2.4 M | 53.87 M |
静态库 | 30.6 M | 63.7 M | 30.1 M | 22.5 M | 52.6 M |
2. 通信场景上行默认不开启视频小流
从该版本起,声网在通信频道场景下,默认不开启视频上行小流。如需开启,请在成功加入频道后,调用 enableDualStreamMode (YES)
方法启用视频双流模式。在多人视频通信场景下,我们建议你开启视频双流。
1. 多频道管理
为方便用户在同一时间加入多个频道,该版本新增了 AgoraRtcChannel
和 AgoraRtcChannelDelegate
类。通过创建多个 AgoraRtcChannel
对象,用户可以加入各 AgoraRtcChannel
对象对应的频道中,实现多频道功能。
加入多个频道后,用户可以同时接收多个频道的流,但只能同时在一个频道内发流。该功能适用于用户需要同时接收多个频道的流,或频繁切换频道发流的场景。详细的集成步骤和注意事项,请参考加入多频道。
2. 视频原始数据
为方便开发者获取传输各阶段的视频原始数据,满足更多场景需求,该版本在 IVideoFrameObserver
类中新增如下 C++ 回调接口:
onPreEncodeVideoFrame
:获取前处理后、编码前的本地视频原始数据。该方法适用于有视频前处理需求的开发场景。getSmoothRenderingEnabled
:设置是否对获取的视频数据进行平滑处理。平滑处理后的视频帧,出帧时间间隔会更均匀,因此视频自渲染的体验更好。3. 调节本地播放的指定远端用户音量
该版本新增 adjustUserPlaybackSignalVolume
方法,用以调节本地用户听到的指定远端用户的音量。通话或直播过程中,你可以多次调用该方法,来调节多个远端用户在本地播放的音量,或对某个远端用户在本地播放的音量调节多次。
4. 媒体播放器组件
为丰富直播玩法,声网发布了媒体播放器组件,支持主播在直播过程中,播放本地或在线媒体资源,并同步分享给频道内所有用户。详情请参考媒体播放器组件发版说明。
1. 音频编码属性
为满足更高音质需求,该版本调整了直播场景下 AgoraAudioProfileDefault(0)
对应的音频编码属性,详见下表:
SDK 版本 | AgoraAudioProfileDefault(0) |
---|---|
3.0.0 | 48 KHz 采样率,音乐编码,单声道,编码码率最大值为 52 Kbps。 |
3.0.0 之前 | 32 KHz 采样率,音乐编码,单声道,编码码率最大值为 52 Kbps。 |
2. 镜像模式
为提升视频镜像的使用体验,该版本增加了视频编码镜像和视频渲染镜像的功能:
AgoraVideoEncoderConfiguration
结构体中,新增 mirrorMode
成员,方便设置本地视频编码的镜像模式,即远端看本地是否镜像。AgoraRtcVideoCanvas
结构体中,新增 mirrorMode
成员,方便用户在调用 setupLocalVideo
方法初始化本地视图时,设置本地看本地是否镜像,以及调用 setupRemoteVideo
方法初始化远端视图时,设置本地看远端是否镜像;同时在 setLocalRenderMode
和 setRemoteRenderMode
方法中新增 mirrorMode
参数,支持在通话中更新本地看本地,或本地看远端的镜像模式。3. 质量透明
为方便开发者获取更多通话统计信息,该版本在 AgoraChannelStats
类中新增 gatewayRtt
、memoryAppUsageRatio
、memoryTotalUsageRatio
和 memoryAppUsageInKbytes
成员,方便更好地监控通话的质量和通话过程中的内存变动。
4. 其他提升
该版本自动开启直播场景下 Native SDK 与 Web SDK 的互通,并废弃原有的 enableWebSdkInteroperability
方法。
行为变更
该版本在调用 enableLocalAudio (NO)
后,不会引起通话音量切换为媒体音量。
新增
setLocalRenderMode
setRemoteRenderMode
AgoraVideoEncoderConfiguration
结构体新增 mirrorMode
成员AgoraRtcVideoCanvas
结构体新增 channelId
、mirrorMode
成员AgoraRtcAudioVolumeInfo
结构体新增 channelId
成员createRtcChannel
AgoraRtcChannel
类AgoraRtcChannelDelegate
类AgoraChannelStats
类中新增 gatewayRtt
、memoryAppUsageRatio
、memoryTotalUsageRatio
和 memoryAppUsageInKbytes
成员废弃
enableWebSdkInteroperability
setLocalRenderMode
¹,使用新的 setLocalRenderMode
取代setRemoteRenderMode
¹,使用新的 setRemoteRenderMode
取代setLocalVideoMirrorMode
,使用 setupLocalVideo
和 setLocalRenderMode
中的 mirrorMode
取代firstRemoteAudioFrameDecodedOfUid
和 firstRemoteAudioFrameOfUid
,使用 remoteAudioStateChangedOfUid
取代streamPublishedWithUrl
和 streamUnpublishedWithUrl
,使用 rtmpStreamingChangedToState
取代该版本于 2020 年 2 月10 日发布。
该版本修复了如下问题:
setRemoteSubscribeFallbackOption
方法也生效。该版本于 2019 年 9 月 19 日发布。新增特性与修复问题列表详见下文。
1. 人声检测
为判断本地用户是否说话,该版本在启用说话者音量提示 enableAudioVolumeIndication
方法中新增 bool 型的 report_vad
参数。启用该参数后,你会在 reportAudioVolumeIndicationOfSpeakers
回调报告的 AgoraRtcAudioVolumeInfo
结构体中获取本地用户的人声状态。
2. 摄像头采集方向
为方便用户在加入频道前选择使用前置或后置摄像头进行采集,该版本在 AgoraCameraCapturerConfiguration
类中新增 AgoraCameraDirection
成员变量。你可以通过 AgoraCameraDirectionRear(1)
或 AgoraCameraDirectionFront(0)
选择使用前置或后置摄像头。
3. RGBA 视频原始数据
该版本新增支持 RGBA 格式的视频原始数据。你可以通过新增的 C++ 接口 getVideoFormatPreference
,设置想要获取的视频原始数据的格式。
同时为提高开发体验,声网支持对 RGBA 格式的视频原始数据分别通过 C++ 接口 getRotationApplied
和 getMirrorApplied
进行旋转和镜像处理。
1. 直播水印
为提高直播水印的用户体验,解决视频方向模式为 Adaptive
时,水印位置和方向可能和预期不符的问题,该版本废弃了原有的 addVideoWatermark
接口,并使用一个新的同名接口进行取代。同名接口下,声网使用 WatermarkOptions
类对水印进行设置,其中:
visibleInPreview
成员设置本地预览是否能看见水印。positionInLandscapeMode
/positionInPortraitMode
成员设置视频编码横屏/竖屏模式时的水印坐标。同时,该版本对水印功能的性能进行了优化。和之前版本相比,该功能的 CPU 占用降低了 5% - 20%。
2. 设置客户端录音采样率
为方便用户设置客户端录音的采样率,该版本废弃了原有的 startAudioRecording
方法,并使用新的同名方法进行取代。新的方法下,录音采样率可设为 16、32、44.1 或 48 kHz。原方法仅支持固定的 32 kHz 采样率,该版本继续保留原方法但我们不推荐使用。
音频
其他
joinChannelByUserAccount
接口,在未成功加入频道前,进行切换网络操作,导致此后无法正常正常收到 didUpdatedUserInfo
回调。为提升用户体验,声网 SDK 在该版本中对 API 进行了如下变动:
新增
startAudioRecording
addVideoWatermark
getVideoFormatPreference
getRotationApplied
getMirrorApplied
enableAudioVolumeIndication
,新增 report_vad
参数AgoraRtcAudioVolumeInfo
类,新增 vad
成员AgoraCameraCapturerConfiguration
类,新增 cameraDirection
成员废弃
startAudioRecording
addVideoWatermark
该版本于 2019 年 8 月 16 日发布。新增特性与修复问题列表详见下文。
1. 旁路推流
该版本起,声网删除如下接口:
configPublisher
setVideoCompositingLayout
clearVideoCompositingLayout
如果你的 App 使用上述接口实现 旁路推流功能,请确保将 Native SDK 升级至最新版本,并改用如下接口实现推流:
新的推流实现方法,详见旁路推流。
2. 远端视频状态
为方便用户了解远端视频状态,该版本删除了原有的 remoteVideoStateChangedOfUid
接口,并使用一个新的同名接口进行取代。新接口下, state
参数扩展为 Stopped(0)、Starting(1)、Decoding(2)、Frozen(3) 和 Failed(4)。同时,新接口还增加了 reason
参数,用以报告远端视频状态发生改变的原因。因此,如果你将 Native SDK 升级至该版本,请确保重新实现 remoteVideoStateChangedOfUid
接口。
同时,扩展后的 state
参数和新增的 reason
参数搭配使用,可以涵盖大部分远端视频状态,因此该版本废弃了 firstRemoteVideoDecodedOfUid
回调。你可以继续使用这个回调,但我们不再推荐。详细的取代方案,请参考 API 文档。
remoteVideoStateChangedOfUid
回调不同。新接口只有在远端视频流状态发生改变时,才会触发。3. 关闭/开启本地音频采集
为提高通信场景下,本地用户关闭麦克风后听到的音质,该版本在 enableLocalAudio
(true) 后,将系统音量修改为媒体音量。调用 enableLocalAudio
(false) 后,系统音量自动切换为通话音量。
1. 快速切换频道
为方便直播频道中的观众用户快速切换到其他频道,该版本新增 switchChannelByToken
方法。和先调 leaveChannel
,再调 joinChannelByToken
相比,该方法能实现更快的频道切换。调用 switchChannelByToken
方法切换到其他直播频道后,本地会先收到离开原频道的回调 didLeaveChannelWithStats
,再收到成功加入新频道的回调 didJoinChannel
。
2. 跨频道媒体流转发
跨频道媒体流转发,指将主播的媒体流转发至其他直播频道,实现主播跨频道与其他主播实时互动的场景。该版本新增如下接口,通过将源频道中的媒体流转发至目标频道,实现跨直播间连麦功能:
在跨频道媒体流转发过程中,SDK 会通过 channelMediaRelayStateDidChange
和 didReceiveChannelMediaRelayEvent
回调报告媒体流转发的状态和事件。
该场景的实现方法、API 调用时序、示例代码及开发注意事项,请参考 跨直播间连麦 指南。
3. 本地及远端音频状态
为方便用户了解本地及远端的音频状态,该版本新增 localAudioStateChange
和 remoteAudioStateChangedOfUid
回调。新的回调下,本地及远端音频有如下状态:
error
参数中返回的错误码定位及排查问题。reason
参数中了解引起远端音频状态发生改变的原因。4. 本地音频数据
为方便更好地了解通话质量,获取更多质量相关数据,该版本新增 localAudioStats
回调,通过 numChannels
、sentSampleRate
、sentBitrate
参数报告本地音频统计信息。
5. 远端音频帧拉取
为提升音频播放体验,该版本新增如下接口,支持使用拉取的方式获取远端音频数据。App 可以对拉取到的原始音频数据进行处理后再渲染,获取想要的音频效果。
enableExternalAudioSink
disableExternalAudioSink
pullPlaybackAudioFrameRawData
pullPlaybackAudioFrameSampleBufferByLengthInByte
该方法和 onPlaybackAudioFrame
回调相比,区别在于:
onPlaybackAudioFrame
:SDK 每 10 毫秒通过回调将音频数据传输给 App。如果 App 处理延时,可能会导致音频播放抖动。pullPlaybackAudioFrameRawData
/ pullPlaybackAudioFrameSampleBufferByLengthInByte
:App 主动拉取音频数据。通过设置音频数据,SDK 可以调整缓存,帮助 App 处理延时,从而有效避免音频播放抖动。1. 通话中质量透明
该版本进一步扩充了 AgoraChannelStats
、AgoraRtcLocalVideoStats
和 AgoraRtcRemoteVideoStats
类的成员。各类新增成员如下:
AgoraChannelStats
类:累计发送音频/视频字节数及累计接收音频/视频字节数AgoraRtcLocalVideoStats
类:本地视频的编码码率、宽高、发送帧数及编码类型AgoraRtcRemoteVideoStats
类:远端视频在网络对抗后的丢包率2. 直播视频质量提升
该版本改善了弱网条件下直播视频卡顿问题,提升了画面清晰度,优化了网络极端丢包情况下的直播画面流畅度。
3. 其他改进
音频
视频
其他
leaveChannel
后崩溃的问题。为提升用户体验,声网 SDK 在该版本中对 API 进行了如下变动:
新增
enableExternalAudioSink
disableExternalAudioSink
pullPlaybackAudioFrameRawData
pullPlaybackAudioFrameSampleBufferByLengthInByte
localAudioStateChange
remoteAudioStateChangedOfUid
remoteVideoStateChangedOfUid
localAudioStats
switchChannelByToken
startChannelMediaRelay
updateChannelMediaRelay
stopChannelMediaRelay
channelMediaRelayStateDidChange
didReceiveChannelMediaRelayEvent
AgoraChannelStats
类新增 txAudioBytes
,txVideoBytes
,rxAudioBytes
和 rxVideoBytes
成员AgoraRtcLocalVideoStats
类新增 encodedBitrate
,encodedFrameWidth
,encodedFrameHeight
,encodedFrameCount
和 codedType
成员AgoraRtcRemoteVideoStats
类新增 packetLossRate
成员废弃
didMicrophoneEnabled
,请改用 localAudioStateChange
回调的 AgoraAudioLocalStateStopped(0) 或 AgoraAudioLocalStateRecording(1)。audioTransportStatsOfUid
,请改用 remoteAudioStats
回调。videoTransportStatsOfUid
,请改用 remoteVideoStats
回调。删除
configPublisher
setVideoCompositingLayout
clearVideoCompositingLayout
remoteVideoStateChangedOfUid
该版本于 2019 年 7 月 8 日发布。新增特性与修复问题列表详见下文。
1. 全平台支持 String 型的用户 ID
很多 App 使用 String 类型的用户 ID。为降低开发成本,声网新增支持 String 型的 User account,方便用户通过如下接口直接使用 App 账号加入声网频道:
对于其他接口,声网沿用 Int 型的 UID。声网 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 如下:
如果你的频道内有不支持 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. 音视频卡顿回调
为监控通话过程中的音视频传输质量,方便开发者客观体验通信质量,该版本在远端音频统计数据 AgoraRtcRemoteAudioStats 类和远端视频统计数据 AgoraRtcRemoteVideoStats 类中新增 totalFrozenTime
和 frozenRate
成员,报告远端用户在加入频道后发生音视频的卡顿时长及卡顿率。
同时,该版本在 AgoraRtcRemoteAudioStats 类中还新增 numChannels
、receivedSampleRate
和 receivedBitrate
成员。
为方便开发者统计掉线率,该版本在 connectionChangedToState 回调的 AgoraConnectionChangedReason
参数中添加 AgoraConnectionChangedKeepAliveTimeout(14)
成员,表示 SDK 与服务器连接保活超时,引起 SDK 连接状态发生改变。
setRemoteSubscribeFallbackOption
行为不符预期的问题。MediaIO
类下方法时偶现的死循环问题。为提升用户体验,声网在 v2.8.0 版本中对 API 进行了如下变动:
新增
numChannels
,receivedSampleRate
,receivedBitrate
,totalFrozenTime
和 frozenRate
成员totalFrozenTime
和 frozenRate
成员废弃
lowLatency
成员该版本于 2019 年 6 月 12 日发布。新增特性、功能改进与修复问题列表详见下文。
如下内容涉及 SDK 的行为变更。如果你是由之前版本的 SDK 升级至该版本,升级前请务必阅读。
1. 旁路推流
为提高推流服务的易用性,该版本对推流接口的参数设置进行了如下限制:
类/接口 | 参数限制 |
---|---|
AgoraLiveTranscoding 类 | |
AgoraImage 类 | url :字符长度不得超过 1024 字节 |
addPublishStreamUrl | url :字符长度不得超过 1024 字节 |
removePublishStreamUrl | url :字符长度不得超过 1024 字节 |
同时,该版本在 LiveTranscoding
类中新增 audioCodecProfile 参数,支持设置音频编码的规格。默认规格为 LC-AAC。
此外,该版本还对 streamPublishedWithUrl 方法的 errorCode
参数新增了五个错误码,方便快速定位与排查问题。
2、RemoteVideoStats 类参数更名
为更精准地表达远端视频流的统计信息,该版本将 AgoraRtcRemoteVideoStats 类中的 receivedFrameRate
参数更名为 rendererOutputFrameRate。
1、添加媒体附属信息
常见的直播场景中,主播给观众分发商品链接、优惠券、在线答题等,能构建更为丰富的直播互动方式。为满足该部分社交类直播 App 开发者的需求,该版本新增 setMediaMetadataSource 和 setMediaMetadataDelegate 接口以及 AgoraMediaMetadataDataSource 和 AgoraMediaMetadataDelegate 协议,目前允许主播在发出的视频帧中添加 Metadata,发送媒体附属信息。
2、本地视频状态回调
为方便开发者了解本地视频状态,该版本新增 localVideoStateChange 回调。该回调下,本地视频有 Stopped
、Capturing
、Encoding
和 Failed
四种状态。当本地视频状态为 Failed
时,用户可以参考该回调 error
参数返回的错误码进行问题排查。该回调能帮助开发者辨别本地视频故障是由采集还是编码引起的。原有的 rtcEngineCameraDidReady
和 rtcEngineVideoDidStop
回调在该版本废弃,我们不再推荐。
3、推流状态回调
为方便推流用户了解当前的推流状态,并在推流出错时了解原因排查问题,该版本新增 rtmpStreamingChangedToState 回调。该回调下,推流有 Idle
、Connecting
、Running
、Recovering
和 Failure
五种状态。当推流状态为 FAILURE 时,用户可以参考该回调 errCode
参数返回的错误码进行问题排查。原有的 streamPublishedWithUrl
和 streamUnpublishedWithUrl
回调仍可以使用,但我们不再推荐。
4、网络连接失败原因梳理
为方便开发者更好地排查网络连接相关故障,该版本梳理并整合了网络连接相关的错误码,在原有 connectionChangedToState 回调的 reason
参数中新增八个导致网络连接失败的原因。新增后,只要网络连接发生错误,SDK 都会返回该回调。同时该版本废弃了原有的警告码 AgoraWarningCodeLookupChannelRejected(105)
和错误码 AgoraErrorCodeTokenExpired(109)
、AgoraErrorCodeInvalidToken(110)
。
5、本地网络连接类型回调
为方便用户了解本地网络的连接类型,该版本新增 networkTypeChangedToType 回调。该回调下,本地网络连接有 Unknown
、Disconnected
、Lan
Wifi
、2G
、3G
、4G
七种类型。当网络连接短暂中断时,该回调能帮助开发者辨别引起中断的原因是网络切换还是网络条件不好。
6、获取播放伴奏音量
为方便开发者获取伴奏的播放音量,排查音量相关问题,该版本新增 getAudioMixingPlayoutVolume 和 getAudioMixingPublishVolume 方法,用以分别获取音乐文件在本地和远端的播放音量。
7、精确回调远端音频首帧解码
为更精准地获取远端用户的出声时间,该版本新增 firstRemoteAudioFrameDecodedOfUid 回调,用以向 App 层报告 SDK 已完成远端音频首帧解码。在远端用户加入频道后首次发送音频,或远端用户 15 秒不发音频后再次发送时,该回调均会被触发。该回调与 firstRemoteAudioFrameOfUid
的区别在于,firstRemoteAudioFrameOfUid
在收到首个音频包时触发,先于 firstRemoteAudioDecodedOfUid
。
1、在线音效叠加
为提高用户体验,构造丰富有趣的实时音视频场景,该版本新增支持同时播放多个在线音效文件。开发者可以通过多次调用 playEffect 方法,传入不同的在线音效文件的 URL,实现音效叠加。
2、质量透明
3、美颜优化
为提升美颜效果,该版本结合主观测试的结果,对美颜选项 AgoraBeautyOptions 类中的各参数添加了默认值;同时,该版本优化了美颜算法的性能。声网实验室报告显示,优化后的算法下,GPU 消耗和 CPU 消耗均有不同程度的下降,功耗优化约 40% - 50%。
4、其他改进
GameStreaming
时的音质效果音频
视频
其他
networkQuality
回调的问题为提升用户体验,声网在 v2.4.1 版本中对 API 进行了如下变动:
全平台 C++ 接口行为一致
从该版本起,Native SDK 保证了各平台 C++ 接口的行为一致性,方便用户通过统一的 C++ 接口,在各平台保持业务逻辑一致。同时在 C++ 头文件的 IRtcEngine
类中实现了 RtcEngineParameters
类下的所有方法。各接口的适用范围及使用注意事项详见声网 C++ API Reference for All Platforms 首页。
新增
AgoraLiveTranscoding
类新增参数 audioCodecProfileAgoraChannelStats
类新增参数 txPacketLossRate 和 rxPacketLossRateAgoraRtcLocalVideoStats
类新增参数 encoderOutputFrameRate 和 rendererOutputFrameRateAgoraRtcRemoteVideoStats
类新增参数 decoderOutputFrameRate 和 rendererOutputFrameRate(替换 receivedFrameRate)废弃
enableAudioQualityIndication
rtcEngineCameraDidReady
,请改用 localVideoStateChange 回调中的 AgoraLocalVideoStreamStateCapturing(1)rtcEngineVideoDidStop
,请改用 localVideoStateChange 回调中的 AgoraLocalVideoStreamStateStopped(0)AgoraWarningCodeLookupChannelRejected(105)
,请改用 connectionChangedToState 回调中的 AgoraConnectionChangedRejectedByServer(10)AgoraErrorCodeTokenExpired(109)
,请改用 connectionChangedToState 回调中的 AgoraConnectionChangedTokenExpired(9)AgoraErrorCodeInvalidToken(110)
,请改用 connectionChangedToState 回调中的 AgoraConnectionChangedInvalidToken(8)AgoraErrorCodeStartCamera(1003)
,请改用 localVideoStateChange 回调中的 AgoraLocalVideoStreamErrorCaptureFailure(4)2.4.0 版
该版本于 2019 年 4 月 1 日发布。新增特性、功能改进与修复问题列表详见下文。
-视频 SDK(iOS)在 2.4.0 版本新增 CoreML.framework
库依赖。请确保在集成时添加该库,详见《快速开始》。
pod install
前,先运行 pop update
更新本地 CocoaPods 库。如果你希望通过指定 SDK 版本号获取最新版,请在 Podfile 中将版本号指定为 'AgoraRtcEngnine_iOS', '2.4.0.1'
。常见的视频社交、在线教育和连麦直播等场景中,用户普遍希望有基础的美颜功能。该版本新增接口 setBeautyEffectOptions
,用户可以调用该接口设置对比度、亮度、平滑度等参数,达到美白、磨皮、红润肤色等美颜效果。详情请参考美颜。
在语音聊天室场景中添加变声和混响效果,能有效增强社交的趣味性。该版本在原有音效设置接口的基础上,新增 setLocalVoiceChanger
和 setLocalVoiceReverbPreset
方法,开发者无需手动设置音效参数,直接选择想要的本地语音变声或混响效果。详情请参考变声与混响。
该版本新增 enableSoundPositionIndication
和 setRemoteVoicePosition
方法,支持本地用户听声辨位。用户需要在加入频道前调用 enableSoundPositionIndication
开启远端用户的语音立体声,然后在 setRemoteVoicePosition
中设置远端用户声音出现的位置,通过左右耳听到的声音差异,对远端用户的声音产生方位感。在多人在线游戏场景,如射击游戏中,该功能可以增加游戏角色的方位感,模拟真实场景。
在通话前进行 Last-mile 网络探测,可以有效帮助本地用户判断和预测上行网络质量是否良好。该版本新增通话前 Last-mile 网络探测接口 startLastmileProbeTest
、stopLastmileProbeTest
及 lastmileProbeResult
,向用户反馈开始通话前上下行网络的带宽、丢包、网络抖动和往返时延数据。
该版本新增接口 setRemoteUserPriority
用于设置远端用户媒体流的优先级。该方法可以与 setRemoteSubscribeFallbackOption
搭配使用。如果开启了订阅流回退选项,弱网下 SDK 会优先保证高优先级用户收到的流的质量。
该版本为播放音乐文件新增回调 localAudioMixingStateDidChanged
,方便用户获知音乐文件的播放状态(成功/失败),以及播放出错的原因。同时新增一个警告码 701,当播放音乐文件时,本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL 时,均会触发该警告码。
声网 SDK 有 2 个日志文件,每个文件默认大小为 512 KB。为解决该大小无法满足部分用户需求的问题,该版本新增接口 setLogFileSize
,用于设置 SDK 输出的日志文件大小。
支持使用云代理服务,方便部署企业防火墙的用户正常使用声网的服务,详见使用云代理服务。
startEchoTestWithInterval
接口取代原有的 startEchoTest
,新增参数 intervalInSeconds
,用于设置返回测试结果的时间间隔。AgoraRtcLocalVideoStats
类中新增 sentTargetBitrate
,sentTargetFrameRate
,qualityAdaptIndication
三个参数,分别反映目标码率、目标帧率与和上次返回的本地视频流统计信息相比,本地视频质量的自适应情况。一般场景下,声网默认的视频编码配置能满足需求。对于特定场景,该版本提供如下功能让用户选择视频偏好:
弱网下画质或流畅偏好设置。该版本在视频编码属性 AgoraVideoEncoderConfiguration
类中新增 2 个参数 minFrameRate
和 degradationPreference
,分别用于设置最低视频编码帧率,以及带宽受限时编码帧率的偏好。这两个参数需要搭配使用,详情请参考设置视频属性。
采集时预览或性能偏好设置。该版本新增接口 setCameraCapturerConfiguration
,通过设置摄像头采集偏好,用户可以根据实际场景选择优先保证设备性能还是视频质量。具体场景及参数选择,请参考 API 文档。
enableLocalAudio
接口导致的蓝牙断开的问题pushExternalAudioFrameSampleBuffer
成功的返回值为 YESrenderMode
的默认值,修复了用户在没有设置的情况下,窗口和画面比例不符合引发的拉伸问题为提升用户体验,声网在 v2.4.0 版本中对 API 进行了如下变动:
setBeautyEffectOptions
setLocalVoiceChanger
setLocalVoiceReverbPreset
enableSoundPositionIndication
setRemoteVoicePosition
startLastmileProbeTest
stopLastmileProbeTest
setRemoteUserPriority
startEchoTestWithInterval
setCameraCapturerConfiguration
setLogFileSize
localAudioMixingStateDidChanged
lastmileProbeResult
startEchoTest
setVideoQualityParameters
AgoraVideoEncoderConfiguration
类中的 frameRate
参数由 enum
型修改为 int
型。
2.3.3 版
该版本于 2019 年 1 月 24 日发布。修复问题详见下文。
修复了 networkQuality
回调不准确的问题。
2.3.2 版
该版本于 2019 年 1 月 16 日发布。新增特性与修复问题详见下文。
2.3.2 除了下文提到的功能和改进外,整体提升直播场景下视频弱网下抗丢包能力,提高流畅度,降低卡顿率。升级前,请了解版本兼容性:
为提升视频采集质量,该版本新增如下接口,支持摄像头曝光功能。开发者可以将需要自动曝光的区域位置发送给 声网 SDK,摄像头会基于该区域自动曝光。
isCameraExposurePositionSupported
:检查设备是否支持摄像头曝光setCameraExposurePosition
:设置摄像头曝光区域cameraExposureDidChangedToRect
:摄像头曝光区域已更改声网 SDK 会根据网络条件进行码率自适应。为满足用户在直播场景下对视频清晰度的要求,该版本在 setVideoEncoderConfiguration
接口中新增 minBitrate
参数,强制视频编码器输出高质量图片。如果将参数设为高于默认值,在网络状况不佳情况下可能会导致网络丢包,并影响视频播放的流畅度。因此如非对画质有特殊需求,声网建议不要修改该参数的值。
为方便用户控制混音音乐文件在本地及远端的播放音量,该版本在已有 adjustAudioMixingVolume
的基础上新增 adjustAudioMixingPlayoutVolume
和 adjustAudioMixingPublishVolume
接口,用于分别控制混音音乐文件在本地和远端的播放音量。
添加新的方法后,原有的 adjustPlaybackSignalVolume 由控制人声和音乐的音量改为仅控制人声的音量。因此,如果要静音本地播放,需同时设置 adjustPlaybackSignalVolume(0)
和 adjustAudioMixingPlayoutVolume(0)
。
该版本梳理了用户在音频采集到播放过程中可能会需要调整音量的场景,及各场景对应的 API,供用户参考使用。详见官网文档调整通话音量。
为提升质量透明的用户体验,该版本废弃了原有的 audioQualityOfUid
回调,并新增 remoteAudioStats
回调进行取代。和原来的接口相比,新接口使用更为综合的算法,通过引入音频丢帧率、端到端的音频延迟、接收端网络抖动的缓冲延迟等参数,使回调结果更贴近用户感受。同时,该版本优化了 networkQuality
的算法,对上下行网络质量采用不同的计算方法,使评分更精准。
remoteAudioStats
:通话中远端音频流的统计信息回调。用于替换 audioQualityOfUid
networkQuality
:通话中每个用户的网络上下行 Last mile 质量报告回调。声网 SDK 计划在下一个版本对如下 API 进行进一步改进:
lastmileQuality
:通话前网络上下行 Last mile 质量报告回调该版本对数据统计相关回调进行了统一梳理,相关回调及算法详见通话中数据统计。
为提升 SDK 使用数据统计的准确性和合理性,该版本新增如下接口,用以获取 SDK 的网络连接状态,以及连接状态发生改变的原因。
getConnectionState
:获取 SDK 的网络连接状态connectionChangedToState
:SDK 的网络连接状态已改变回调该版本废弃了原有的 rtcEngineConnectionDidInterrupted
和 rtcEngineConnectionDidBanned
回调。
在新的接口下,SDK 共有 5 种连接状态:未连接、正在连接、已连接、正在重新建立连接和连接失败。当连接状态发生改变时,都会触发 connectionChangedToState
回调。当条件满足时,原有的 rtcEngineConnectionDidInterrupted
和 rtcEngineConnectionDidBanned
回调也会触发,但声网不再推荐使用。
为方便用户(开发者)收集最终用户(应用程序使用者)对使用应用进行通话或直播的反馈,该版本将 rate
接口中的打分范围缩小为 1 - 5,减少最终用户的打分干扰。声网建议在应用程序中集成该接口,方便应用程序收集用户反馈。
该版本针对高音质需求场景,如音乐教学等进行了音质改进。通过调用 setAudioProfile
,将 AgoraAudioProfile
设置为 MusicHighQuality(4)
,AgoraAudioScenario
设置为 GameStreaming(3)
实现,在有效消除回声、降低噪音的同时,不损害音乐的音质。
startAudioMixing
播放音乐文件时出现的崩溃问题为提升用户体验,声网在 v2.3.2 版本中对 API 进行了如下变动:
isCameraExposurePositionSupported
setCameraExposurePosition
getConnectionState
adjustAudioMixingPlayoutVolume
adjustAudioMixingPublishVolume
connectionChangedToState
CameraExposureDidChangedToRect
remoteAudioStats
2.3.1 版
该版本于 2018 年 9 月 28 日发布。新增特性与修复问题列表详见下文。
应用程序在加入频道时,语音功能是默认打开的。为满足用户只接收而不发送音频流的需求,该版本新增 enableLocalAudio
接口,方便应用程序在进入频道后关闭或重新开启本地语音功能。关闭本地语音功能后,应用程序会收到 didMicrophoneEnabled
回调,并停止采集本地音频流。该方法不影响接收和播放远端音频流。
该功能与 muteLocalAudioStream
的区别在于前者不采集不发送,而后者是采集但不发送。
2.3.0 版
该版本于 2018 年 8 月 31 日发布。新增特性与修复问题列表详见下文。
声网 SDK 在 v2.3.0 版本中,全面提升了视频功能的稳定性及可用性,保证了更加可靠的实时通信。同时音视频质量也得到进一步提高。 视频方面,通过优化编码性能,增强了弱网对抗能力,减少卡顿时间,提升视频流畅度;音频方面,采用深度学习算法,改进了通话中的音频质量。
为满足场景中视频旋转的需要,提升自定义视频源画质,该版本引入 setVideoEncoderConfiguration
替换原 setVideoProfile
接口。 setVideoProfile
接口仍可用,但不再推荐。
直播场景下支持 Adaptive Mode,当发送端画面旋转时不再剪切画面,避免播放端画面出现“大头”或缩放模糊的现象。
自采集场景中,可以根据输入视频帧的宽和高,动态调整输出视频帧的宽和高,尽可能避免剪切,并提供更多的图像信息给到播放端。
该版本新增了一个系统库依赖:Accelerate.framework
。该系统库可以进行大规模的数学计算和图像计算,并针对高性能进行了优化。
为更好地提升用户体验,声网 SDK 在 v2.1.0 版本中对动态密钥进行了升级。如果你当前使用的 SDK 是 v2.1.0 之前的版本,并希望升级到 v2.1.0 或更高版本,请务必参考 动态密钥升级说明 。
本次发版新增如下功能:
网络不理想的环境下,直播音视频的质量都会下降。为提升直播效率,声网新增了 setLocalPublishFallbackOption
和 setRemoteSubscribeFallbackOption
两个接口。 用户设置这两个接口后,在网络条件差、无法同时保证音视频质量的情况下,SDK 会自动将视频流从大流切换为小流,或直接关闭视频流,从而保证或提高音频质量。同时 SDK 会持续监控网络质量, 并在网络质量改善时恢复音视频流。在推流回退为音频流时,或由音频流恢复为音视频流,触发 didLocalPublishFallbackToAudioOnly
) 或 didRemoteSubscribeFallbackToAudioOnly
回调。
由于 Token 具有一定的时效,在通话过程中如果 Token 即将失效,SDK 会提前 30 秒触发回调 tokenPrivilegeWillExpire
,提醒应用程序更新 Token。当收到该回调时,用户需要重新在服务端生成新的 Token,然后调用 renewToken
将新生成的 Token 传给 SDK。
为方便统计每个用户的音视频上下行码率、帧率及丢包率,该版本新增 audioTransportStatsOfUid
和 videoTransportStatsOfUid
回调。 通话或直播过程中,当用户收到远端用户发送的音视频数据包后,会周期性地发生该回调上报,频率约为 2 秒 1 次。 回调中包含用户的 UID、音/视频接收码率、丢包率、以及延迟时间(毫秒)。 并在统计频道内通话相关数据的 Rtcstats
类中增加 lastmileDelay
参数,返回客户端到 vos 服务器的延迟。
在默认情况下,SDK 和 App 对 Audio Session 都有控制权,但某些场景下,App 会希望限制声网 SDK 对 Audio Session 的控制权限, 而使用其他应用或第三方组件对 Audio Session 进行操控。为满足该需求,本版本新增 setAudioSessionOperationRestriction
接口。 用户可以选择相应的 Restriction,来实现 SDK 不同程度的管理限制。该方法可动态使用,在加入频道前,或频道中均能调用。
为满足场景中视频旋转的需要,提升自定义视频源画质,该版本引入 setVideoEncoderConfiguration
替换原 setVideoProfile
接口,来设置视频编码属性。 新接口中的 AgoraVideoEncoderConfiguration 类对应一套视频参数,支持用户根据实际需要,手动设置视频的分辨率(dimension)、帧率 (frame rate)、码率 (bitrate) 以及视频方向 (orientationMode)。原接口 setVideoProfile
仍可使用,但不再推荐。
在设置直播转码接口 setLiveTranscoding
中,新增 backgroundImage
参数,支持设置直播转码合图的背景图片。
优化了一对一音视频的质量,在降低延时、防止卡顿方面提升明显。优化效果重点覆盖东南亚、南美、非洲和中东等地区
直播场景下,改善了音频编码器的效率,保证通话质量的同时节省用户流量
采用深度学习算法,改进了通话及直播中的音频质量
修复了因视频编码问题引起的 Native 设备与 Web 端互通时,Web 端看不到 Native 端视频画面的问题
修复了多人视频直播连麦场景下,SDK 内存异常增长的问题
修复了某些 iOS 设备上 App 切换至后台后偶发的视频渲染崩溃的问题
修复了某些 iOS 设备上 App 偶发的闪退的问题
修复了特定场景下某些设备上偶发的无法看到远端视图的问题
修复了特定场景下偶发的 iOS 设备黑屏的问题
修复了特定场景下偶现的视频重影的问题
修复了通信场景下,由小流切换到大流时,偶现的视频画面下方出现绿边的问题。
修复了特定场景下某些 iOS 设备上推流后出现的崩溃问题
修复了某些 iOS 设备上偶现的崩溃的问题
修复了某些 iOS 设备上频繁暂停、恢复播放所有音效时出现的崩溃的问题
修复了多人连麦场景下,主播频繁进出频道时,偶现的主播内存异常增长的问题
修复了特定场景下偶现的主播加入频道、下麦再上麦后,远端用户听不到主播声音的问题
修复了偶现的设置推流背景图无效的问题
修复了通信场景下,某些设备上偶现的视频画面长宽和设置的长宽颠倒的问题
修复了某些设备上偶现的开启视频模式加入频道后,调用 destroy 方法无响应的问题
修复了特定场景下某些 iOS 设备上偶现的接听系统电话再回到频道后,听不到声音的问题
修复了特定场景下偶现的直播观众无法调节频道内通话音量的问题
修复了频繁进出频道时,某些 iOS 设备上出现的崩溃的问题
修复了通信场景下偶现的其他端看不到 iOS 端视频画面的问题
修复了直播场景下,主播和观众频繁切换角色时,观众切主播后偶现的采集不到画面的问题
修复了某些 iOS 设备上偶现的不开启双流模式,Web 端也能订阅 iOS 端小流的问题
修复了设置手动对焦位置并触发对焦时,某些设备上偶现的崩溃的问题
修复了 2 人连麦过程中,一端播放背景音乐时将自己静音或关闭音频后,另一端闪退的问题
修复了特定场景下,iOS 端和 Web 端互通时,Web 频繁进出频道后,iOS 设备上出现的崩溃的问题
修复了通信场景下,反复设置不同的视频编码属性后,无法进入频道的问题
修复了特定场景下,预加载音效时某些设备上偶现的崩溃问题
修复了直播场景下,主播端编码与解码端渲染的分辨率不一致的问题
修复了通信和直播场景下偶发的视频画面卡住的问题
修复了进入频道前暂停指定用户视频流后,某些设备上偶现的崩溃的问题
修复了特定场景下,某些 iOS 设备上出现的未开启弱网下视频自动回退,也能收到相关回调的问题
修复了直播场景下,对某些外部视频源设置编码属性时,某些 iOS 设备上出现的输出视频方向不正确的问题
修复了某些 iOS 设备上手动设置视频属性异常的问题
修复了偶现的 iOS 与 macOS 设备 无法进入频道互通的问题
修复了直播场景下,使用第三方应用播放音乐时,某些 iOS 设备上出现的退出频道时崩溃的问题
修复了特定场景下,某些 iOS 设备上出现的退出频道时崩溃的问题
修复了直播场景下,某些 iOS 设备上出现的拉流过程中,其他用户拉流也能成功的问题
修复了频繁开关摄像头时,某些 iOS 设备上出现的崩溃的问题
修复了直播场景下,由连麦切换回单主播时偶现的画面卡顿的问题
修复了特定场景下偶现的 SIP 设备和 SDK 视频不互通的问题
修复了小米 8 上出现的本地预览黑屏、远端也看不到它的问题
修复了部分设备上偶现的使用声卡时回声的问题
修复了部分 iOS 设备出现的视频画面由小到大跳变的问题
修复了特定场景下,部分 iOS 设备上出现的摄像头晃动时,频道内画面卡糊的问题
修复了部分 iOS 设备上偶现的视频延迟的问题
修复了特定场景下,某些 iOS 设备上无法调节音量的问题
为提升用户体验,声网在 v2.3.0 版本中对 API 进行了梳理,并针对部分接口进行了如下处理:
为避免在直播转码推流中添加多个相同 User,v2.3.0 版本中新增如下接口:
addUser
removeUser
以下接口与录制相关,在 v2.3.0 版本后不再支持。声网提供专门的 Recording SDK 用于更好的录制服务,详见声网 Recording SDK 发版说明。
startRecordingService
stopRecordingService
refreshRecordingServiceStatus
didRefreshRecordingServiceStatus
以下接口长期处于弃用状态,现进行删除,v2.3.0 版本后不再支持:
switchView
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 日发布。修复问题列表详见下文。
2.2.1 版
该版本于 2018 年 5 月 30 日发布。新增特性与修复问题列表详见下文。
修复了部分设备上偶现的 Crash 问题。
修复了部分设备上内存泄漏的问题。
修复了部分设备上播放网络伴奏时某些 App 闪退的问题。
2.2.0 版
该版本于 2018 年 5 月 4 日发布。新增特性与修复问题列表详见下文。
本次发版新增如下功能:
播放音效 playEffect
接口新增了一个 publish
参数,用于在播放音效时,远端用户可以听到本地播放的音效。
如果你的 SDK 是由之前版本升级到 v2.2 版本,请务必关注该接口功能的变动。
通过部署声网提供的代理服务器安装包,设有企业防火墙的用户可以设置代理服务器,使用声网的服务。
新增 onRemoteVideoStateChanged
接口,以获知远端视频流的状态。
在本地直播及旁路直播中增加水印功能,允许用户将一张 PNG 图片作为水印添加到正在进行的本地直播或旁路直播中。新增 addVideoWatermark
和 clearVideoWatermarks
接口,以添加或删除本地直播水印;LiveTranscoding
接口中新增 watermark
参数,用于控制旁路直播中水印的添加。
本次发版改进如下功能:
改进 enableAudioVolumeIndication
接口的功能,无论频道内是否有人说话,都会在回调中按设置的时间间隔返回说话者音量提示。
根据用户对频道内实时网络质量监测测的需求,在 onNetworkQuality
中改进了返回数据的准确度。
为方便用户在进频道前检查当前网络是否能支撑语音或视频通话,在 onLastmileQuality
中,由通过恒定码率监测优化为根据用户设定的 Video Profile 的码率进行监测,提高返回数据的准确度。且在网络状态为 unknown 时,依然以 2 秒的间隔返回回调。
提升了用户在播放音乐等场景下的音乐音质。用户可以通过设置 setAudioProfile
中的 Scenario:AgoraAudioScenarioGameStreaming = 3 来实现高保真的音乐传输。
新增支持 Bitcode 功能。支持 Bitcode 的 SDK 包大小约为普通包的 2.5 倍;使用 Bitcode 开发的 App 在上传 App Store 后,App Store 会对其进行优化及瘦身,瘦身程度视 App 的代码量而定,代码量越大,瘦身程度越高。
修复了某些 iOS 设备横屏时,偶现的其他用户看 iOS 设备画面异常的问题。
修复了大量用户同时直播连麦时,偶发的抖屏现象。
修复了某些 iOS 设备导致频道内其他端的回音问题。
2.1.3 版
该版本于 2018 年 4 月 19 日发布。新增特性与修复问题列表详见下文。
该版本的 SDK 修改了 setVideoProfile
方法在直播场景下的码率值,修改后的码率值与 2.0 版本一致。
修复了 SDK 没有设置 Delegate 时,偶尔收不到 Block 回调的问题。
修复了 SDK 的外链符号里,有 NSAssertionHandler 的问题。
修复了部分手机上,用户离开频道后,开启自带的录音设备时,偶现录音出错的问题。
修复了直播场景下,调用 enableWebSdkInteroperability
接口后,iOS 端偶尔看不到 Win 10 系统 Web 端视频画面的问题。
修复了使用 UIImagePickerController 调用系统相机后再回到直播中,偶现分辨率改变的问题。
修复了通信或直播过程中偶现 Crash 的问题。
改进了通信和直播场景下屏幕共享的效果,缩短了用户从屏幕共享模式切换回普通模式需要的时间间隔。
2.1.2 版
该版本于 2018 年 4 月 2 日发布。新增特性与修复问题列表详见下文。
SDK 升级至 2.1.2 的直播场景后,相同分辨率下,视频更清晰,但带宽也会变大。
在已有 setVideoProfile
接口的基础上,新增一个 setVideoResolution
接口。用户可以用此接口,根据自身业务需要,手动设置视频的分辨率、帧率和码率。
修复了之前版本 SDK 在 iOS 11 平台上崩溃的问题。
修复了之前版本 SDK 在 dtx+aac 模式下会视频卡顿的问题。
2.1.1 版
该版本于 2018 年 3 月 16 日发布。
请正在或已集成 2.1 SDK 的客户尽快升级更新! 本次发版修复了一个的系统风险,请尽快升级以免对服务造成影响。
2.1.0 版
该版本于 2018 年 3 月 7 日发布。新增特性与修复问题列表详见下文。
本次发版新增如下功能:
新增了一个游戏开黑场景,用于节省流量和去除杂音,通过调用 API setAudioProfile 实现。
在直播场景下,主播如果需要通过内置的麦克风美化和定制自己的语音输入,可以通过调用 API setLocalVoiceEqualization
和 setLocalVoiceReverb
轻易地设置音效均衡和混响来实现所需要的效果。
新增 RESTful API 查询用户在频道中的状态信息,查询指定频道内的分角色用户列表,查询厂商频道列表,查询用户是否为连麦用户等。详见 控制台 RESTful API
在直播场景下,同一频道内支持 17 位主播同时进行视频直播和连麦,详见文档:
声网 SDK 提供了摄像头采集的默认实现,同时允许开发者使用自定义视频源。
声网 SDK 提供了默认的渲染器实现,用来显示本地视频图像和对端视频图像。使用默认的渲染器就能满足大部分开发者需求,复杂的业务场景下,声网也开放了自定义渲染器接口。
直播场景下,可以将采集到的视频添加到正在进行的直播中,直播室里的主播和观众可以一起边看电影、比赛或演出,边进行点评、互动等功能,会让现有的直播话题更广、体验更好。 仅支持拉入一路流,格式包括: RTMP, HLS, FLV。赛事直播最多同时支持 5 人连麦直播。
新增回调接口提示相机的对焦区域已发生改变,新增了回调 cameraFocusDidChanged
。
本次发版改进如下功能:
改进 | 描述 |
卡顿 | 改善了观众模式下的卡顿现象 |
卡顿 | 改善了特定设备导致的卡顿现象 |
鉴权模型优化 | 旧鉴权模型一个密钥只能对应一个服务权限(例如加入频道),而新的一个 Token 包含了所有的服务权限(例如加入频道,连麦,推流等) |
硬件编码优化 | 在 Qualcomm、MTK、Hisilicon、和 Orion 芯片上适配硬件 264 编码器 |
硬件编码优化 | 改善硬件编码器优化码率控制 |
计费优化 | 计费系统针对极小分辨率统一按音频计费,例如 16 * 16 |
修复了自采集方案退出频道后 app 录不到声音的问题;
修复了偶现的崩溃;
修复了偶现的关闭麦克风无法听到声音的问题;
修复了偶现的黑屏问题;
2.0.2 版
该版本于 2017 年 12 月 15 日发布。新增特性与修复问题列表详见下文。
修复了 ffmpeg 符号冲突问题;
2.0 版
该版本于 2017 年 12 月 6 日发布。新增特性与修复问题列表详见下文。
通信场景支持视频大小流功能,新增 API setRemoteVideoStreamType()
和 enableDualStreamMode()
。
伴奏和音效回调更新如下:
名称 | 描述 |
rtcEngineMediaEngineDidAudioMixingFinish |
废弃,已经被 rtcEngineLocalAudioMixingDidFinish 替代 |
rtcEngineDidAudioEffectFinish |
新增,当本地结束音效播放时触发该回调 |
rtcEngineRemoteAudioMixingDidStart |
新增,当远端开始伴奏播放时触发该回调 |
rtcEngineRemoteAudioMixingDidFinish |
新增,当远端结束音效播放时触发该回调 |
通信和直播场景下支持摄像头管理功能,新增以下 API:
名称 | 描述 |
isCameraZoomSupported |
检测设备是否支持相机缩放功能 |
isCameraTorchSupported |
检测设备是否支持闪光灯常开 |
isCameraFocusPositionInPreviewSupported |
检测设备是否支持手动对焦功能 |
isCameraAutoFocusFaceModeSupported |
检测设备是否支持人脸对焦功能 |
setCameraZoomFactor |
设置相机缩放因子 |
setCameraFocusPositionInPreview |
设置手动对焦位置,并触发对焦 |
setCameraTorchOn |
设置是否打开闪光灯 |
setCameraAutoFocusFaceModeEnabled |
设置是否开启人脸对焦功能 |
通信和直播场景下支持音频自采集功能,新增以下 API:
名称 | 描述 |
enableExternalAudioSourceWithSampleRate |
开启外部音频采集 |
disableExternalAudioSource |
关闭外部音频采集 |
pushExternalAudioFrameRawData |
推送外部音频帧 |
修复了音频路由和蓝牙相关的若干问题。
1.14 版
该版本于 2017 年 10 月 20 日发布。新增特性与修复问题列表详见下文。
新增 API setAudioProfile
设置音频参数和应用场景。
新增 API setLocalVoicePitch
提供基础变声功能。
直播场景: 新增 API setInEarMonitoringVolume
提供调节耳返音量功能。
优化了在高码率下的音频体验。
秒开: 直播场景下,单流模式时观众加入频道 1 秒内看见主播图像(均值为 938 ms, 网络状态良好时可达 734 ms)。
节省带宽:
1.14 以前: 如果你选择不听某人的音频或不看某人的视频,音视频流会照发。
1.14 开始: 如果你选择不听或不看某人的流,则不会下发,从而节省带宽。
精准的码率控制:
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 版。
通信场景下针对 320 x 180 分辨率提供了以下改进方案:
网络和设备状态较差的情况下仍能保证画质流畅度。
网络和设备状态良好的情况下可以做到比 180P 更好的画质清晰度。
修复了部分机型上偶现的崩溃问题。