发布日期:2022.05.11
新增功能
直推 CDN 时,在不改变推流方式的情况下,SDK 从客户的 CDN 源站拉流,通过 L3 将音视频内容分发给观众,通过 [ZegoResourceType] 控制源站资源。该功能常用于直播场景。
相关 API 请参考 startPlayingStream
注意:目前只支持 RTC 场景,直推 CDN 和转推 CDN 场景下无效。
从 2.19.0 版本开始,支持在音视频场景下将 SEI(媒体补充增强信息)与音频帧同步发送。该功能常用于 SEI 与音频强相关的视频场景,例如实时 KTV。
在 2.19.0 之前版本中,SEI 数据是跟随视频帧数据一起发送,一般情况下视频帧率远低于音频帧率,导致混流对齐、伴奏对齐场景下等 SEI 精度/频率不足。
相关 API 请参考 onPlayerRecvAudioSideInfo, sendAudioSideInfo
改进优化
问题修复
发布日期:2022.04.13
问题修复
发布日期:2022.04.09
新增功能
注意:AI 降噪目前会对麦克风采集的音乐有较大损伤,包括人通过麦克风唱歌的声音。如需使用该功能,请联系 ZEGO 技术支持。
AI 降噪指的是 SDK 会对麦克风采集的声音进行降噪处理,在原有的稳态噪声正常处理的情况下,还会处理非稳态噪声,主要包括鼠标、键盘声、敲击、空调、厨房碗碟、嘈杂餐厅、环境风声、咳嗽、吹气 等非人声噪声。通过 [setANSMode] 接口中的 “ZegoANSMode” 参数设置 AI 降噪模式,并且可以实时调整降噪模式,详情请参考 AI 降噪。
该功能常用于通话、会议等没有背景音乐的场景,例如普通音质语聊房、语音会议、语音开黑、一对一视频通话。
相关 API 请参考 setANSMode
开始播放音效后, 调用 [SetPlaySpeed] 接口可以对音效设置四种播放速度(会同时设置本地播放速度和推流速度),分别为 0.5 倍速、原始速度、1.5 倍速和 2 倍速,默认为原始速度。
QUIC 协议推拉流主要用于改善弱网环境下 CDN 直播质量不稳定的情况,但是改善有限,推荐使用低延时直播,享受高质量且低延时的直播服务。当前支持使用腾讯、网宿两家 CDN 直播产品的 QUIC 协议推流及拉流。
通过 [enablePublishDirectToCDN] 接口中的 “ZegoCDNConfig” 参数配置推流协议和 QUIC 版本,若想进行 QUIC 协议的自定义 CDN 拉流,需要通过 [startPlayingStream] 中的 “ZegoPlayerConfig“ 参数配置拉流协议和 QUIC 版本。
相关 API 请参考 enablePublishDirectToCDN
发起推流后,可以通过 [onPublisherStreamEvent] 回调实时监听推流状态,该回调会返回当前使用的推流地址、资源类型和协议相关信息。
发起拉流后,可以通过 [onPlayerStreamEvent] 回调实时监听拉流状态,该回调会返回当前使用的拉流地址、资源类型和协议相关信息。
相关 API 请参考 onPublisherStreamEvent, onPlayerStreamEvent
调用 startMixerTask 开启或更新混流任务,支持通过 “backgroundUrl” 和 “inputVolume” 分别设置混流水印和混流的输入音量。
相关 API 请参考 startMixerTask
[loginRoom] 接口新增 “callback” 参数,支持从 “callback“ 返回登录房间结果。
[logoutRoom] 接口新增 “callback” 参数,支持从 “callback“ 返回退出房间结果。
相关 API 请参考 loginRoom, logoutRoom
当房间的连接状态发生变化时会触发 [onRoomStateChanged] 回调,通过“ZegoRoomStateChangedReason” 参数提供更加详细的连接状态及状态变化原因。
相关 API 请参考 onRoomStateChanged
改进优化
调用 startMixerTask 接口,通过 “ZegoFontStyle” 中的 “border” 属性可以设置字体是否有边框,通过 “borderColor” 属性可以设置字体边框颜色。
相关 API 请参考 startMixerTask
新增 1005000 错误码,表示未开通混流服务。出现此错误码时,请在 ZEGO 控制台 自助开通混流服务(开通步骤请参考 项目管理 - 服务配置 中的“混流”),或联系 ZEGO 技术支持开通。
相关 API 请参考 startMixerTask
问题修复
发布日期:2022.03.28
问题修复
发布日期:2022.03.11
问题修复
发布日期:2022.03.09
新增功能
新增 [setMinVideoFpsForTrafficControl] 和 [setMinVideoResolutionForTrafficControl] 接口,可以用于用户网络不佳且开启了流量控制时,通过调用接口设置最低视频帧率及分辨率,帮助用户综合控制视频的显示效果。
相关 API 请参考 setMinVideoFpsForTrafficControl, setMinVideoResolutionForTrafficControl
稳态语音默认检测周期为 3 秒,用户如需修改默认检测周期,可通过 [startAudioVADStableStateMonitor] 接口自定义检测周期参数。
相关 API 请参考 startAudioVADStableStateMonitor
新增枚举 [ZegoRangeAudioModeSecretTeam] 隐秘小队模式。在该模式下,同一房间下的用户,收听者既能与同一小队的人交流,也能听到所有在音频接收范围内且为全世界模式发声者的声音,如太空狼人杀游戏场景。
相关 API 请参考 setRangeAudioMode
注意:该功能仅在开发阶段使用,请勿在线上版本开启此功能。
新增 [enableDebugAssistant] 接口,开发者调用该接口开启调试助手功能,SDK 将会打印日志到控制台,并且在 SDK 其他接口的调用出现异常时,UI 会弹窗提示错误。
相关 API 请参考 enableDebugAssistant
改进优化
2.17.0 及以上版本,在创建引擎时将 AppSign 传空或不传,并且在登录房间时必须传入 Token,鉴权通过后即可使用实时音视频功能,具体请参考 使用 Token 鉴权。
2.17.0 以下版本,在创建引擎时传入 AppSign,鉴权通过后即可使用实时音视频功能。
相关 API 请参考 createEngine
问题修复
发布日期:2022.02.10
问题修复
发布日期:2022.01.26
问题修复
发布日期:2022.01.20
问题修复
发布日期:2022.01.14
新增功能
游戏语音模块新增 [muteUser] 接口,本地用户可以根据需要,在初始化游戏语音 [CreateRangeAudio] 之后,通过 [MuteUser] 接口设置是否接收指定远端用户的音频数据。
该功能常用于游戏场景,例如发声者被墙壁阻挡,则听众不需要接收该声音。
相关 API 请参考 muteUser
[onPlayerQualityUpdate] 回调新增 “mos” 参数,表示对拉流音质的评分。开发者对音频质量比较关注时,可通过该参数了解当前音频的质量情况。
相关 API 请参考 onPlayerQualityUpdate
注意:目前只有特定的视频编码器支持此功能,如需使用,请联系 ZEGO 技术支持。
开发者可以调用 [setCustomVideoCaptureRegionOfInterest] 接口设置指定推流通道自定义视频采集编码器的感兴趣区域(ROI),同样码率情况下,ROI 区域内的画质更加清晰。
该功能常用于远程控制、人脸检测 等场景。
相关 API 请参考 setCustomVideoCaptureRegionOfInterest
注意:如需使用该功能,请联系 ZEGO 技术支持。
在创建引擎 [createEngine] 之后,推流 [startPublishingStream] 或拉流 [startPlayingStream] 之前,可以调用 [useAudioDevice] 接口选择使用某个音频设备。
相关 API 请参考 useAudioDevice
注意:如需使用该功能,请联系 ZEGO 技术支持。
为了在弱网环境下让推流端可以推更高画质的视频流,SDK 支持基于 rtmp over quic 协议来推流。
该功能常用于单主播直推 CDN、直播 PK 场景。
注意:如需使用该功能,请联系 ZEGO 技术支持。
2.15.0 及之前版本:SDK 在使用 [startPlayingStream] 拉 H.265 编码的流时,如果拉流端出现因硬件性能较差导致解码帧率不足时,SDK 无法主动降级,需要用户先停止拉 H.265 编码的流,再转拉 H.264 编码的流。
2.16.0 及以上版本:新增 H.265 拉流自动降级策略,在使用 [startPlayingStream] 拉 H.265 编码的流时,SDK 可以根据拉流质量情况,在拉流端硬件性能较差导致解码帧率不足的情况下,会自动降级拉 H.264 编码的流。
相关 API 请参考 startPlayingStream
改进优化
从此版本开始 Android SDK 支持的 API 级别要求不低于 19,最低支持的操作系统版本从 Android 4.1 变更为 Android 4.4,如需支持 Android 4.1,请联系 ZEGO 技术支持。
ZEGO 提供了全新的基础美颜功能,为用户呈现出良好的肌肤状态,打造自然的美颜效果。开发者需要在推流前先调用 [startEffectsEnv] 接口初始化美颜环境,然后调用 [enableEffectsBeauty] 接口开启美颜功能。通过 [setEffectsBeautyParam] 接口可以按需调整美白、磨皮、锐化以及红润的程度,实现基础美颜能力。
该功能常用于视频通话、直播等场景。
相关 API 请参考 startEffectsEnv, stopEffectsEnv, enableEffectsBeauty, setEffectsBeautyParam
媒体播放器的 [onVideoFrame] 和 [onVideoFramePixelBuffer] 回调支持返回视频帧对应的时间戳。
调用 [getNetworkTimeInfo] 接口获取同步网络时间信息时,SDK 会定时更新 NTP 时间,减少获取到的 NTP 时间误差。
相关 API 请参考 getNetworkTimeInfo
调用 [createEngine] 创建引擎时,SDK 支持校验 jar 与 so 版本是否一致,如果校验到版本不一致则会抛出 RuntimeException 异常。
相关 API 请参考 createEngine
废弃删除
旧的美颜功能较为简单,不太符合开发者的预期,因此在 2.16.0 及以上版本废弃了 [enableBeautify] 接口,请使用 [enableEffectsBeauty] 接口代替;废弃了 [setBeautifyOption] 接口,请使用 [setEffectsBeautyParam] 代替。
相关 API 请参考 enableBeautify, enableEffectsBeauty, setBeautifyOption, setEffectsBeautyParam
发布日期:2021.12.09
新增功能
新增 [setCustomVideoCaptureDeviceState] 接口,在使用自定义视频采集时,开发者可以设置指定通道自定义视频采集的采集设备状态,远端可以通过 [onRemoteCameraStateUpdate] 回调获取推流端的状态变更。该功能常用于秀场直播场景。
相关 API 请参考 setCustomVideoCaptureDeviceState
媒体播放器新增声浪频谱回调和开关接口,可以控制是否开启回调以及回调的频率,从而获取媒体播放器当前的声浪和频谱。在通过媒体播放器播放资源,如一起看电影、游戏语聊房场景时,通过该功能可以做频谱动画的功能,增加趣味性。
创建媒体播放器后,调用 [enableSoundLevelMonitor] 接口可以开启声浪监听,开启后可以通过 [onMediaPlayerSoundLevelUpdate] 回调监听声浪的变化。
创建媒体播放器后,调用 [enableFrequencySpectrumMonitor] 接口可以开启频谱监听,开启后可以通过 [onMediaPlayerFrequencySpectrumUpdate] 回调监听频谱的变化。
相关 API 请参考 enableSoundLevelMonitor, onMediaPlayerSoundLevelUpdate, enableFrequencySpectrumMonitor, onMediaPlayerFrequencySpectrumUpdate
在使用自定义视频采集功能时,调用 [sendSEISyncWithCustomVideo] 接口可以实现在推流传输视频流数据的同时,发送流媒体增强补充信息来同步一些其他附加信息,该信息与当前视频帧同步。该功能常用于需要播放内容与视频帧强同步的场景,比如视频 K 歌,视频跟歌词强同步。
相关 API 请参考 sendSEISyncWithCustomVideo
新增支持全方位虚拟立体声,将单声道的声音,通过算法处理,模拟成立体感的声音。该功能常用于 KTV 场景中,可以使唱歌的声音更加有立体感。
当调用 [enableVirtualStereo] 接口,将 angle 参数设置为 -1 时,表示立体声效果为全方位立体声。
相关 API 请参考 enableVirtualStereo
通过 [onLocalDeviceExceptionOccurred] 回调可以设置要检测的设备类型,如摄像头、扬声器、麦克风等,开发者可以根据不同设备类型的错误回调进行相应的处理。
相关 API 请参考 onLocalDeviceExceptionOccurred
改进优化
混流输出视频配置 [ZegoMixerOutputVideoConfig] 新增 encodeProfile 和 encodeLatency 参数、分别用于设置混流输出视频编码规格和混流输出视频编码延时。
登录房间导致网络测试停止,由于网络测试会占用带宽,请在登录房间之前进行。
用户登录房间时如果在服务器黑名单中,则会返回此错误码,表示禁止登录房间。
当使用 SDK 拉低延迟直播流时,若您未开通低延迟直播服务,则会返回此错误码。
问题修复
废弃删除
为了让开发者直观的了解出现异常的设备类型以及具体的异常情况,在 2.15.0 及以上版本废弃了 [onDeviceError] 回调,请使用 [onLocalDeviceExceptionOccurred] 回调代替。
相关 API 请参考 onDeviceError, onLocalDeviceExceptionOccurred
发布日期:2021.11.16
新增功能
开发者在需要做远程控制、云游戏等指令分发时,通过实时信令,可以低延迟获取发布端消息。
相关 API 请参考 createRealTimeSequentialDataManager
注意:如需使用该功能,请联系 ZEGO 技术支持。
支持通过版权音乐功能,获取版权歌曲或伴奏资源,并结合媒体播放器进行本地播放控制。可以用于在线 KTV 、语聊房等合唱或使用背景音乐的场景。
新增 H.265 解码性能不足的告警回调,在通过 CDN 拉流的场景下,用于提示用户是否做降级处理。如果开发者在拉 H.265 流的过程中收到低帧率回调 [onPlayerLowFpsWarning],建议开发者停止拉 H.265 流,转拉 H.264 流。
推流状态回调 [onPublisherStateUpdate] 和拉流状态回调 [onPlayerStateUpdate] 中新增了 H.265 编解码错误提示。
相关 API 请参考 onPlayerLowFpsWarning, onPublisherStateUpdate, onPlayerStateUpdate
注意:如需使用该功能,请联系 ZEGO 技术支持。
允许开发者自定义监听音频和视频帧到达的回调通知,包括音频首帧到达回调、视频首帧到达回调、视频首帧渲染回调。
相关 API 请参考 callExperimentalAPI
媒体播放器新增 [loadResourceWithPosition] 接口,支持加载媒体资源时指定开始播放进度,单位为毫秒。
相关 API 请参考 createMediaPlayer > loadResourceWithPosition
注意:仅当自定义视频采集帧数据类型 “bufferType” 设置为 GLTexture2D 时,该功能才有效。
开发者收到 [onStart] 回调后,可以调用 [setCustomVideoCaptureRotation] 接口设置指定推流通道自定义采集画面的顺时针旋转角度。调用 [setCustomVideoCaptureTransformMatrix] 接口可以设置指定通道的自定义采集画面转换矩阵,包括旋转、翻转、缩放。
当 [setCustomVideoCaptureTransformMatrix] 和 [setCustomVideoCaptureRotation] 接口同时调用时,则先执行 [setCustomVideoCaptureTransformMatrix] 后,再执行 [setCustomVideoCaptureRotation]。
相关 API 请参考 setCustomVideoCaptureRotation, setCustomVideoCaptureTransformMatrix
SDK 支持设置摄像头对焦和曝光模式,常用于鉴宝直播场景,用于放大和对焦一些物体的细节。
在启动本地预览后,可以调用 [isCameraFocusSupported] 接口开启摄像头对焦功能,通过 [setCameraFocusPointInPreview] 和 [setCameraExposurePointInPreview] 接口可以分别设置预览视图中的对焦点和曝光点(每次摄像头重新启动采集,两者的设置都会失效,需要重新设置)。调用 [setCameraFocusMode] 和 [setCameraExposureMode] 接口可以分别设置摄像头对焦模式和曝光模式。
相关 API 请参考 isCameraFocusSupported, setCameraFocusPointInPreview, setCameraFocusMode, setCameraExposureMode, setCameraExposurePointInPreview
该功能常用于 KTV 等需要混流对齐的场景,当拉流端播放时,通过 [setPlayStreamsAlignmentProperty] 接口控制播放的实时音视频流是否需要精准对齐。若需要,则拉取的所有流中包含精准对齐参数的会进行对齐;若不需要,则所有流都不对齐。
相关 API 请参考 setPlayStreamsAlignmentProperty
音频设备模式新增 GENERAL3 和 COMMUNICATION4 两种模式。GENERAL3 模式表示关闭系统前处理,始终占用麦克风,全程使用媒体音量。COMMUNICATION4 模式表示开启系统前处理,上麦占用麦克风,下麦释放麦克风,全程使用通话音量。
相关 API 请参考 setEngineConfig
通过该功能可以判断一定时间内是否有人对着麦克风说话,用于检测采集后或音频前处理后的音频数据是人声还是噪声。
相关 API 请参考 startAudioVADStableStateMonitor, stopAudioVADStableStateMonitor, onAudioVADStateUpdate
注意:如需使用该功能,请联系 ZEGO 技术支持。
支持生成 Token 的密钥,实现 ServerSecret 平滑迁移能力。通过后台配置同时启用两个 ServerSecret,当其中一个 ServerSecret 暴露的情况下,可以平滑迁移到另一个 ServerSecret。
注意:如需使用Token 加入黑名单的功能,请联系 ZEGO 技术支持。
Token 支持加入黑名单:为防止旧 Token 释放后攻击新 Token,新增支持将 Token 加入黑名单。Token 黑名单,是指该 Token 在有效期内的 AppID 下无法使用。
Token 支持通过流 ID 鉴权:为防止通过鉴权后,使用相同 Token 推其他的流,新增支持生成绑定流 ID 的 Token。
为确保客户端下麦成功,服务端新增批量禁止 RTC 推流和批量恢复 RTC 推流能力。
调用批量禁止 RTC 推流接口,可以批量禁止指定流 ID 推送到 RTC 服务,禁止推流操作会向正在推流的客户端和正在拉流的客户端发送推流被禁止的通知。调用批量恢复 RTC 推流接口,可批量恢复被禁止推往 RTC 媒体服务的流 ID。
相关 API 请参考 批量禁止 RTC 推流/批量恢复 RTC 推流
改进优化
2.10.0 至 2.13.1 版本的处理逻辑为:1. 自身必须既推流又拉流,才会收到自身的网络质量回调。2. 当拉一条流时,推流端有拉流且推流端在自己所在房间内,才会收到该用户的网络质量。
2.14.0 及以上版本的处理逻辑为:1. 自身只要推流或拉流,就会收到自身的网络质量回调。2. 当拉一条流时,推流端在自己所在房间内,就会收到该用户的网络质量。
相关 API 请参考 onNetworkQuality
2.14.0 之前版本默认最大推流通道数量为 2 路,如需支持更多则需要 ZEGO 技术支持特殊编包。为了配合实时信令功能,该版本默认最大推流数新增至 4 路。
相关 API 请参考 startPublishingStream
完成了对全量 API 接口与错误码的注释优化, API 注释中新增了“支持版本”、“详情描述”、“业务场景”、“调用时机”、“使用限制”、“注意事项”等信息,便于开发者更清晰的了解 API 的功能。错误码新增了“可能原因”和“处理建议”,帮助开发者更好的定位和解决问题。
为了降低开发者对环境的理解成本,ZEGO 已统一环境概念,从该版本开始,废弃了测试环境,统一使用正式环境。在 2.14.0 版本之前已接入过 SDK 的开发者,可以参考“测试环境废弃说明(https://doc-zh.zego.im/article/12997)”进行 SDK 升级及代码调整。
相关 API 请参考 createEngine
混流转推地址长度限制由 512 字节扩展到 1024 字节。
废弃删除
为了降低开发者对环境的理解,废弃了掉测试环境,统一使用环境。在 2.14.0 及以上版本废弃了原有的 [createEngine] 接口,请使用不带 “isTestEnv” 参数的同名接口代替。
相关 API 请参考 createEngine
发布日期:2021.10.15
问题修复
发布日期:2021.10.15
新增功能
电音音效指的是可以让人说话、唱歌的声音,经过处理后带有电音的效果。该功能常用于KTV、语聊房场景。
在 [createEngine] 初始化 SDK 之前,调用 [setElectronicEffects] 接口可以开启电音音效,并可根据需要设置不同模式的电音调式以及对应调式的起始音高。未调用此接口时,默认关闭电音音效。
开发者也可以通过 [setVoiceChangerPreset] 接口预设常见的电音音效,目前支持预设 C 大调电音音效、A 小调电音音效、和声小调电音音效。
相关 API 请参考 setElectronicEffects
注意:使用此功能需要升级 SDK 并联系 ZEGO 技术支持配置。
不同的业务场景,对用户登录房间、推流等权限有时效限制,可以通过 Token 来实现。
当 Token 过期后,服务端会主动将用户的权限进行回收,客户端的用户会被踢出房间并停止推流。该机制可以使用户权限管理更安全,常用于 KTV、语聊房场景。
相关 API 请参考 renewToken, onRoomTokenWillExpire
直播使用混流时,可以在混流输出画面上实时更新水印,以达到实时更新混流的时候同步刷新水印。该功能常用于在线教育场景,例如上课时在混流画面上标注每条输入流对应的老师名字或者班级名字。
[ZegoMixerTask] 的混流输入列表 [ZegoMixerInput] 中新增 [label] 字段,可设置混流输入视频画面上的相关文字水印信息,进行混流的每一条流,只支持一个水印。
相关 API 请参考 startMixerTask
在进行混流时,可以对每一条流进行渲染模式的设置。当混流输入流的分辨率比例与对应输入流在混流输出画面上的布局比例不一致时,可以按照不同的业务场景,选择不同的渲染模式。
[ZegoMixerTask] 的混流输入列表 [ZegoMixerInput] 中新增 [renderMode] 字段,可设置混流输入视频画面的渲染模式,支持“填充模式”和“适应模式”。
相关 API 请参考 startMixerTask
改进优化
推流端,配置混流时可以指定某些流进行精准对齐。
相关 API 请参考 setStreamAlignmentProperty
调用 [startPublishingStream] 接口且将 [ZegoPublisherConfig] 中的 [forceSynchronousNetworkTime] 值设置为 1,则 SDK 内部会等到 NTP 网络时间同步完成后再推流,此时再调用 [setStreamAlignmentProperty] 接口开启混流精准对齐功能。
相关 API 请参考 startPublishingStream, setStreamAlignmentProperty, onNetworkTimeSynchronized
问题修复
废弃删除
因为在回调里增加了 timestamp 采集时间戳,在 2.13.0 及以上版本废弃 [onProcessCapturedAudioData] 回调,使用带 timestamp
参数的同名回调代替。
相关 API 请参考 onProcessCapturedAudioData
因为在回调里增加了 timestamp 采集时间戳,在 2.13.0 及以上版本废弃 [onProcessRemoteAudioData] 回调,使用带 timestamp
参数的同名回调代替。
相关 API 请参考 onProcessRemoteAudioData
因为在回调里增加了 timestamp 采集时间戳,在 2.13.0 及以上版本废弃 [onProcessPlaybackAudioData] 回调,使用带 timestamp
参数的同名回调代替。
相关 API 请参考 onProcessPlaybackAudioData
发布日期:2021.09.09
新增功能
H.265 编解码完整方案上线,适用于单主播直播和多人互动直播场景。开发者可以在编码或混流时输出 H.265 格式的视频码流,H.265 在同等画质下相对于 H.264 节约了 30% 的流量。使用该功能前,需要联系 ZEGO 技术支持开通。
相关 API 请参考 isVideoEncoderSupported, isVideoDecoderSupported, enableH265EncodeFallback, onPublisherVideoEncoderChanged
支持获取和修改混音后将要播放的音频数据。在初始化 SDK 之后,[startPublishingStream]、 [startPlayingStream]、 [startPreview]、 [createMediaPlayer] 和 [createAudioEffectPlayer] 之前,调用 [enableCustomAudioPlaybackProcessing] 接口可以开启自定义混音后处理功能,通过 [setCustomAudioProcessHandler] 可以设置自定义音频处理回调。
相关 API 请参考 enableCustomAudioPlaybackProcessing, setCustomAudioProcessHandler, onProcessPlaybackAudioData
与远端用户连麦成功后,当远端扬声器设备状态发生变更时,例如开/关扬声器,可以通过 [onRemoteSpeakerStateUpdate] 回调监听。
相关 API 请参考 onRemoteSpeakerStateUpdate
在加载资源完成后,调用 [setPlaySpeed] 接口可以设置媒体播放器的视频播放倍速,支持 0.5 ~ 2.0 倍,默认为 1.0,即正常速度。
相关 API 请参考 ZegoMediaPlayer > setPlaySpeed
使用混流功能时,支持通过 [ZegoMixerInput] 中的 audioDirection 参数设置每路音频流的空间音频效果。
相关 API 请参考 ZegoMixerInput
改进优化
优化了混流接口的调用逻辑,使代码更加清晰简单。
相关 API 请参考 ZegoMixerTask
优化了耳返逻辑,使耳返的延迟缩短至 50+ ms。
新增支持小米机型的耳返能力。
广播消息和弹幕消息从此版本开始,支持发送长度更大的消息(默认限制为 1 KB),如有需要请联系 ZEGO 技术支持配置。
相关 API 请参考 ZegoMediaPlayer > loadResource
问题修复
发布日期:2021.08.27
新增功能
新增范围语音功能模块,可提供范围语音、3D音效、小队语音等功能。适用于吃鸡类游戏、元宇宙类场景。
范围语音:房间内的收听者对音频的接收距离有范围限制,若发声者与自己的距离超过该范围,则无法听到声音。为保证语音清晰,附近超过 20 人发声时,只能听到离自己最近的 20 个发声者的声音。
3D音效:声音有 3D 空间感且按距离衰减。
小队语音:玩家可以选择加入小队,并支持在房间内自由切换“全世界”模式和“仅小队”模式。
相关 API 请参考 createRangeAudio, destroyRangeAudio, setEventHandler, setAudioReceiveRange, updateSelfPosition, updateAudioSource, enableSpatializer, enableMicrophone, enableSpeaker, setRangeAudioMode, setTeamID
改进优化
发布日期:2021.08.20
问题修复
相关 API 请参考 loginRoom
相关 API 请参考 uploadLog
发布日期:2021.08.10
新增功能
SDK 可以指定房间,由 ZEGO 实时音视频服务器自动将房间内的所有音频流进行混流(目前只支持混音频流),常用于纯语聊场景。该功能相对手动混流降低了开发者接入的复杂程度,不需要管理指定房间音频流的生命周期。
相关 API 请参考 startAutoMixerTask, stopAutoMixerTask
在混流任务对象 [ZegoMixerTask] 中新增 [setBackgroundColor] 用于设置混流背景色。
相关 API 请参考 ZegoMixerTask > setBackgroundColor
开发者在监听声浪回调时,往往只关注人声部分,可调用 [startSoundLevelMonitor] 接口,传入 “ZegoSoundLevelConfig”,开启 VAD 人声检测。SDK 在本地采集声浪回调 [onCapturedSoundLevelInfoUpdate]、远端音频声浪回调 [onRemoteSoundLevelInfoUpdate] 中也新增是否包含人声检测的参数。
相关 API 请参考 startSoundLevelMonitor, onCapturedSoundLevelInfoUpdate, onRemoteSoundLevelInfoUpdate
当开发者已经将播放数据写入内存后,可直接使用媒体播放器进行播放,无需再写成文件进行播放。
相关 API 请参考 ZegoMediaPlayer > loadResourceFromMediaData
开发者可以在开启预览后调用 [setCameraExposureCompensation] 接口设置摄像头曝光补偿数值,取值范围为 [-1, 1],取值越小画面越暗,取值越大画面越亮。
相关 API 请参考 setCameraExposureCompensation
改进优化
在使用多个视频或音频设备时,可以通过 "deviceID" 参数精确分辨出报错的设备,更高效地排查问题。
相关 API 请参考 onDeviceError
在开发者需要支持超过 12 路拉流时,需要联系 ZEGO 技术支持设置。
问题修复
废弃删除
参数定义不准确,在 2.10.0 及以上版本废弃 [onNetworkQuality] 回调,使用带 ZegoStreamQualityLevel
枚举的同名回调代替。
相关 API 请参考 onNetworkQuality
发布日期:2021.07.13
问题修复
发布日期:2021.07.09
新增功能
关闭摄像头时,支持持续推送 JPEG/JPG、BMP 和 HEIF 格式的静态图片。例如,主播退后台的时候,会主动关闭摄像头,此时观众侧需要展示主播暂时离开的图片。
初始化 SDK 后,关闭摄像头之前通过 [setDummyCaptureImagePath] 接口设置所推静态图片的路径,开始正常推流后,调用 [enableCamera] 接口关闭摄像头时会开始推静态图片,调用 [enableCamera] 接口打开摄像头时会结束推静态图片。
相关 API 请参考 setDummyCaptureImagePath
新增本地和远端用户的上下行网络质量回调 [onNetworkQuality],默认每两秒回调一次本地和每个拉取的远端用户的网络状况(包括未知、优秀、良好、中等、较差、网络断线)。当开发者希望分析链路上的网络情况,或想要了解本地和远端用户的网络状况时可以使用该功能。
相关 API 请参考 onNetworkQuality
在进行多端同步行为或耗时统计时,需要网络时间同步。SDK 新增获取 NTP 时间功能,可通过 [getNetworkTimeInfo] 接口获取 NTP 时间戳。使用该功能前请先联系 ZEGO 技术支持。
相关 API 请参考 getNetworkTimeInfo
基于 ZEGO 服务器的 NTP 时间,在混流时自动对齐各路流的播放时间。使用该功能前请先联系 ZEGO 技术支持。
改进优化
同一个用户可以同时加入多个房间,并同时在多个房间内(目前默认最多同时加入 5 个房间)推流、拉流、发送实时消息和接收消息回调。本功能可以隔离多个房间的消息及回调,实现更灵活的连麦业务。ZEGO 推荐用于跨房间连麦和在线教育的超级小班场景。
需要在初始化 SDK 之前,调用 [ZegoRoomMode] 设置多房间模式,然后调用 [loginRoom] 接口登录多房间。
相关 API 请参考 setRoomMode, loginRoom
开发者不需要填写 roomID 就可以调用 [logoutRoom] 接口退出当前所在的房间。若使用了多房间功能,则调用该接口会退出所有房间。
相关 API 请参考 logoutRoom
拉流质量回调中新增 audioCumulativeBreakCount、audioCumulativeBreakTime、audioCumulativeBreakRate 等参数,提供了更多拉流卡顿的细化数据。
相关 API 请参考 onPlayerQualityUpdate
调用 [startNetworkSpeedTest] 接口开启网络测速时,支持设置回调周期(默认 3000 ms)。
相关 API 请参考 startNetworkSpeedTest
问题修复
废弃删除
为了更完善多房间功能,去除旧有主从房间概念,在 2.9.0 及以上版本废弃了 [loginMultiRoom] 接口。若需实现新的多房间功能,请先在引擎初始化之前调用 [setRoomMode] 函数设置多房间模式,再使用 [loginRoom] 登录多房间,如果调用 [loginRoom] 函数登录多房间,请确保传入相同的用户信息。
相关 API 请参考 setRoomMode, loginRoom
发布日期:2021.06.11
新增功能
用户权限控制指的是用户登录房间,或是在房间内进行推/拉流等操作时,ZEGO 服务端根据用户登录时携带的 Token 参数,判断用户是否有对应的权限,避免因权限控制缺失或操作不当引发的风险问题。 目前仅支持用户登录房间和用户房间内推流两个权限的校验。
相关 API 请参考 loginRoom, renewToken, onRoomTokenWillExpire
开放辅路流复制主路流的视频数据能力,通过此能力开发者可以在主路、辅路流用不同协议推相同数据。开发者若需要此能力请联系 ZEGO 技术支持提供试验性 API。
相关 API 请参考 callExperimentalAPI
空间音频能够感知空间内 360° 的声音位置。开发者可以通过空间音频功能在音视频房间内营造更逼真的“座位”效果,用户可以通过空间音频感知声音的来源方向,还原线下场景。适用于语聊房、剧本杀和线上会议等场景。
相关 API 请参考 enablePlayStreamVirtualStereo
改进优化
Android 10 引入 scoped storage 概念后,一般情况下,App 只能访问 SD 卡上属于 App 的私有数据,开发者可在 AndroidManifest.xml 中添加声明来关闭 scoped storage。但 Android 11 及以后版本将忽略该声明,强制开启 scoped storage。开发者可使用 SDK 提供的接口,使 SDK 支持直接使用文件路径读写文件。
相关 API 请参考 setPublishWatermark, startRecordingCapturedData, loadResource
问题修复
发布日期:2021.04.29
新增功能
ZEGO 通过此 API 提供 RTC 业务中的部分技术预览或特别定制功能,需要获取该功能的使用方法或其详情可咨询 ZEGO 技术支持。
相关 API 请参考 callExperimentalAPI
问题修复
废弃删除
在 2.7.0 及以上版本废弃 [enableAudioDataCallback] 接口,请使用 [startAudioDataObserver] 接口代替。
相关 API 请参考 startAudioDataObserver
发布日期:2021.04.15
新增功能
在混流时,开发者通过设定拉流端需要突出的目标流,实现在多人同时说话的嘈杂环境下,突出特定用户的语音。例如在会议场景下,可以保障重点人物发言的声音。在调用 [startMixerTask] 接口开启混流时,首先将传入的 [ZegoMixerAudioConfig] 混流音频配置参数中的 "mixMode" 设置为 "focused",同时在需要突出发言的流中,配置 [ZegoMixerInput] 的 "isAudioFocus" 为 "true",即可指定该流为焦点语音流。
相关 API 请参考 startMixerTask
问题修复
发布日期:2021.04.01
新增功能
开发者可根据实际需要在加载资源前,通过 [setNetWorkResourceMaxCache] 接口设置媒体播放器网络资源的最大缓存时长和最大缓存数据大小(两者不能同时为 0),可通过 [getNetWorkResourceCache] 接口获取当前网络资源缓存队列中缓存数据可播放的时长和大小。
相关 API 请参考 ZegoMediaPlayer > setNetWorkResourceMaxCache, ZegoMediaPlayer > getNetWorkResourceCache
当网络状态较差且媒体播放器将缓存的网络资源都播放完时,就会停止播放。只有当缓存的网络资源大于 SDK 设置的阈值时(默认值为 5000 ms,有效值为大于等于 1000 ms),媒体播放器才会在原来暂停的位置自动恢复播放。
相关 API 请参考 ZegoMediaPlayer > setNetWorkBufferThreshold
发布日期:2021.03.25
问题修复
发布日期:2021.03.18
新增功能
对媒体播放器当前播放的画面进行截图。
相关 API 请参考 ZegoMediaPlayer > takeSnapshot
可根据需要设置和获取音频编码类型、码率,音频声道的组合值。
相关 API 请参考 setAudioConfig, getAudioConfig
当通过 [enableTrafficControl] 接口开启了指定推流通道的流量控制后,可通过 [setTrafficControlFocusOn] 接口控制是否因为远端网络状况差而启动流量控制。
相关 API 请参考 setTrafficControlFocusOn
第一帧视频数据被渲染完之后会收到此回调。
相关 API 请参考 onPublisherRenderVideoFirstFrame
相关 API 请参考 ZegoMediaPlayer > enableAccurateSeek
当拉流时需要一次性关闭所有远端用户的音频或视频流时,可通过该功能实现。
相关 API 请参考 muteAllPlayStreamAudio, muteAllPlayStreamVideo
改进优化
问题修复
发布日期:2021.03.05
问题修复
发布日期:2021.03.04
新增功能
当开发者需要自定义日志文件大小和路径时,可调用 [setLogConfig] 接口来完成配置,且必须在调用 [createEngine] 之前设置才能生效。若在 [createEngine] 之后设置,则在 [destroyEngine] 后的下一次 [createEngine] 时生效。一旦调用了 [setLogConfig] 接口,在 [destroyEngine] 之前,即 engine 的整个生命周期里,旧的通过 [setEngineConfig] 设置日志大小和路径的方式将无效。建议一旦使用该接口,就始终只通过其完成设置日志路径和大小的需求。
相关 API 请参考 setLogConfig
设置 [setApiCalledCallback] 后,可以通过 [onApiCalledResult] 回调获取到 ZEGO SDK 方法执行结果的详细信息。
相关 API 请参考 setApiCalledCallback
当推流方通过 [setVideoConfig] 设置了 “codecID” 为 “SVC” 时(在拉流前后均可设置),拉流方可以动态设置选用不同的流类型(小分辨率为标准图层的二分之一)。 在网络较弱或者渲染的 UI 窗体较小的情况下,可以选择使用拉取小分辨率的视频来达到节省带宽的目的。
相关 API 请参考 setPlayStreamVideoType
通过 [setAudioRouteToSpeaker] 可以设置音频路由到扬声器,当选择不使用内置扬声器播放声音时,即设为 “false” 时,SDK 会根据系统调度选择当前优先级最高的音频输出设备播放声音。
相关 API 请参考 setAudioRouteToSpeaker
本端用户可控制所有音频流的播放音量。
相关 API 请参考 setAllPlayStreamVolume
在推拉流之前通过网络探测定位一些可能存在的网络问题。
相关 API 请参考 startNetworkProbe, stopNetworkProbe
改进优化
问题修复
废弃删除
因为定义了更通用更利于理解的的视图类型参数,在 2.3.0 及以上版本废弃 [setPlayStreamVideoLayer] 接口, 使用 [setPlayStreamVideoType] 接口代替。
相关 API 请参考 setPlayStreamVideoType
相关 API 请参考 setLogConfig
通过设置 "advancedConfig" 的 "key" 为 "language","value" 为 "chinese" 或者 "english" 来切换中英文。通过设置 “key” 为 “set_verbose”,“value” 为 “true” 或 “false” 来开关控制台打印功能。
相关 API 请参考 setEngineConfig
因为命名规范问题,在 2.3.0 及以上版本废弃 [setBuiltInSpeakerOn] 接口,请使用 [setAudioRouteToSpeaker] 来实现原来的功能。
相关 API 请参考 setAudioRouteToSpeaker
发布日期:2021.02.04
问题修复
相关 API 请参考 sendCustomAudioCaptureAACData, sendCustomAudioCapturePCMData
相关 API 请参考 onRemoteVideoFrameEncodedData
发布日期:2021.01.28
新增功能
当开发者需要对采集视频进行前处理,如使用第三方美颜 SDK 时,则可以使用自定义视频前处理功能,很方便地对接视频前处理操作。相比于自定义视频采集功能,此功能无需开发者管理设备输入源,仅需对 SDK 抛出来的原始数据进行操作,然后发回 SDK 侧即可。
相关 API 请参考 enableCustomVideoProcessing
多个用户在房间内进行音视频通信,每一次音视频通信都会有唯一的 RoomSessionID (当用户收到 [onRoomStateUpdate] 回调时,可通过回调中的 [extendedData] 参数获取 RoomSessionID),标识房间内首个用户发起音视频通信到最后一个用户结束通信的持续通信。可用于通话质量评分、通话问题诊断等场景中。
相关 API 请参考 onRoomStateUpdate
使用媒体播放器播放媒体文件,当媒体播放器解析到媒体文件中含有 SEI 时,将触发 [onMediaPlayerRecvSEI] 回调。
相关 API 请参考 ZegoMediaPlayer > onMediaPlayerRecvSEI
“[ZegoMixerTask] 中添加 [advancedConfig] 以支持混流高级配置。如需使用,请联系 ZEGO 技术支持。”
相关 API 请参考 startMixerTask
新增棱镜相关质量上报,方便开发者及时发现问题、定位问题、解决问题,更好、更全面地提升用户体验。
改进优化
发布日期:2021.01.21
问题修复
发布日期:2021.01.14
新增功能
该功能用于指定播放缓存自适应调整的区间范围,开发者可根据场景进行设置。
相关 API 请参考 setPlayStreamBufferIntervalRange
改进优化
问题修复
发布日期:2021.01.07
问题修复
发布日期:2020.12.31
新增功能
低延迟直播专注于提供稳定可靠的直播服务,相比于标准视频直播产品,音画延迟更低,同步性更强,弱网抗性更好,能为用户带来毫秒级的直播体验。通常用于教育大班课、秀场直播、电商直播、一起看、在线拍卖等场景。详情请参考:低延迟直播。
相关 API 请参考 startPlayingStream
新增对 H.265 编码的支持,在同等分辨率、帧率的情况下可以降低码率。
相关 API 请参考 setVideoConfig
问题修复
相关 API 请参考 sendCustomCommand
废弃删除
旧接口跟随了 [setEngineConfig] 接口的生命周期,不够灵活。在允许了引擎启动前设置 [自定义视频采集] 之后,Express SDK 新增了独立的 [enableCustomVideoCapture] 接口用于设置自定义视频采集,详情请参考 接口变更说明。
相关 API 请参考 enableCustomVideoCapture
旧接口跟随了 [setEngineConfig] 接口的生命周期,不够灵活。在允许了引擎启动前设置 [自定义视频渲染] 之后,Express SDK 新增了独立的 [enableCustomVideoRender] 接口用于设置自定义视频渲染,详情请参考 接口变更说明。
相关 API 请参考 enableCustomVideoRender
新增了一个带 [callback] 参数的销毁引擎接口,若开发者有切换多个音视频 SDK 的需求,则可以通过收到回调时认为 ZEGO SDK 对设备硬件资源的占用已释放完成。若无监听必要,对 [callback] 参数传 null 即可,详情请参考 接口变更说明。
相关 API 请参考 destroyEngine
旧回调命名与实际功能不符,因此删除改名,详情请参考 接口变更说明。
相关 API 请参考 onPlaybackAudioData
旧接口命名风格和语义不清晰,[muteSpeaker] 使用 Speaker 的定义与 Microphone 对应,详情请参考 接口变更说明。
相关 API 请参考 muteSpeaker
媒体播放器的生命周期跟随引擎,故变更为 ZegoExpressEngine 类的同名实例方法,详情请参考 接口变更说明。
相关 API 请参考 createMediaPlayer
引擎提供了分别获取播放器推流音量和本地播放音量的功能,故废弃原来的统一获取接口,详情请参考 接口变更说明。
相关 API 请参考 ZegoMediaPlayer > setPublishVolume, ZegoMediaPlayer > getPublishVolume, ZegoMediaPlayer > setPlayVolume, ZegoMediaPlayer > getPlayVolume
发布日期:2020.12.24
问题修复
发布日期:2020.12.17
新增功能
该功能支持上行/下行网络测速,可用于检测网络环境是否适合推/拉指定码率的流。调用 [startNetworkSpeedTest] 接口开启该功能,配置“ZegoNetworkSpeedTestConfig”参数以控制测速过程,测速结果将通过 [onNetworkSpeedTestQualityUpdate] 回调通知。
相关 API 请参考 startNetworkSpeedTest, stopNetworkSpeedTest, onNetworkSpeedTestQualityUpdate
当设备的网络模式改变时,例如从 WiFi 切换到 5G,或断网等情况时,将会抛出此回调。
相关 API 请参考 onNetworkModeChanged
通过 SDK 设置摄像头的变焦倍数,可实现拍摄时放大远方物体的效果,详细功能实现请参考 [进阶功能 - 变焦]。
相关 API 请参考 getCameraMaxZoomFactor, setCameraZoomFactor
当有耳机插拔、扬声器和听筒切换等音频路由发生变化时会抛出此回调。
相关 API 请参考 onAudioRouteChange
调用 [enableCustomVideoCapture] 接口时可以选择设置“GL_TEXTURE_EXTERNAL_OES”类型,并通过 [sendCustomVideoCaptureTextureData] 接口发送自定义采集的视频帧数据。
相关 API 请参考 enableCustomVideoCapture, sendCustomVideoCaptureTextureData
问题修复
相关 API 请参考 startRecordingCapturedData, stopRecordingCapturedData
发布日期:2020.12.10
改进优化
登录房间后,如果退出或切换房间,且传入的 RoomID 为空或者 RoomID 不存在,则抛出 1002002 错误码。
相关 API 请参考 loginRoom, logoutRoom, switchRoom
问题修复
相关 API 请参考 setSEIConfig
相关 API 请参考 startPlayingStream
相关 API 请参考 seekTo
发布日期:2020.12.03
新增功能
调用 [createEngine] 接口创建引擎后可以启动性能监控,并支持设置监控回调间隔(默认为 2s),一般可用于对比推拉流前后的内存增长情况。
相关 API 请参考 startPerformanceMonitor, stopPerformanceMonitor
支持使用 AES-128/192/256 对流媒体数据加密。
相关 API 请参考 setPublishStreamEncryptionKey, setPlayStreamDecryptionKey
该时间戳差值小于 0 表示视频超前音频的毫秒数, 大于 0 表示视频滞后音频的毫秒数, 等于 0 表示无差别。当绝对值小于 200,可基本认为音画同步,当绝对值连续 10 秒大于 200 可以认为异常。
相关 API 请参考 onPlayerQualityUpdate
当推流方调用 [setVideoConfig] 接口设置视频编码器(codecID)为 SVC 时,拉流方可以调用 [setPlayStreamVideoLayer] 接口来自行选择拉取标准图层或者基础图层(基础图层的分辨率为标准图层的二分之一),以达到节省带宽的目的。
相关 API 请参考 setPlayStreamVideoLayer
改进优化
相关 API 请参考 loginRoom
相关 API 请参考 sendBroadcastMessage
相关 API 请参考 startRecordingCapturedData
相关 API 请参考 ZegoMediaPlayer > loadResource
废弃删除
相关 API 请参考 setPlayStreamVideoLayer
发布日期:2020.11.24
问题修复
发布日期:2020.11.19
新增功能
通过混响高级参数可以根据需要调节更精细的混响效果,并在原有预设混响中新增了录音室、KTV、摇滚、演唱会等效果,在预设变声中新增了磁性男和清新女音效,增加实时语音趣味性,能够适应更多的场景。
相关 API 请参考 setReverbAdvancedParam, setReverbPreset, setVoiceChangerPreset
通过设置 SEI 类型,使开发者使用其他解码器解码时能够正确解析出 SEI。
相关 API 请参考 setSEIConfig
相关 API 请参考 onRoomStreamUpdate
相关 API 请参考 onPlayerAudioData
问题修复
相关 API 请参考 startPlayingStream
相关 API 请参考 mutePlayStreamAudio, mutePlayStreamVideo
废弃删除
为了支持更多混响参数,在 1.18.0 及以上版本废弃 [setReverbParam] 接口,请使用带 ZegoReverbAdvancedParam
类型参数的 [setReverbAdvancedParam] 接口代替。
相关 API 请参考 setReverbAdvancedParam
在 1.18.0 及以上版本废弃 [onRoomStreamUpdate] 回调,请使用带 extendedData
扩展信息参数的同名回调代替。
相关 API 请参考 onRoomStreamUpdate
发布日期:2020.11.05
改进优化
相关 API 请参考 loginRoom, sendBroadcastMessage, sendBarrageMessage, sendCustomCommand
问题修复
相关 API 请参考 sendSEI
发布日期:2020.10.22
新增功能
新增外国人、擎天柱、机器人、空灵 4 种变声效果,轻松创建特色音效,使用户的声音更加妙趣横生。在语音场景中,营造好友语音之间的搞怪气氛,增强娱乐性。
相关 API 请参考 setVoiceChangerPreset
用户可以根据需要设置混响回声参数,最多允许设置 7 次回声 (delay),并支持单独设置每个回声的延迟、衰减,以及整体的输入输出增益值。也可以搭配变声、混响以实现自定义各式各样的声音效果。
相关 API 请参考 setReverbEchoParam
通过改变用户的音调,使输出的声音在感官上与原始声音不同,实现男声变女生等多种效果。
相关 API 请参考 ZegoMediaPlayer > setVoiceChangerParam
支持在推拉流过程中对画面进行截图,可用于鉴黄等场景。
相关 API 请参考 takePublishStreamSnapshot, takePlayStreamSnapshot
该功能可用于抑制敲击键盘、桌子等瞬态噪声。
相关 API 请参考 enableTransientANS
当媒体文件中包含多个音轨时(例如原声和伴奏),支持切换音轨进行播放。
相关 API 请参考 ZegoMediaPlayer > getAudioTrackCount,ZegoMediaPlayer > setAudioTrackIndex
改进优化
从此版本开始 Android SDK 支持的 API 级别要求不低于 16,最低支持的操作系统版本从原来的 Android 4.0.3 提升到 Android 4.1。
相关 API 请参考 onPlayerQualityUpdate
问题修复
废弃删除
param
参数的预设枚举构造函数,该函数仅用于微调设置 pitch
值,如需使用预设枚举来设置变声,请使用新增的 [setVoiceChangerPreset] 函数。相关 API 请参考 setVoiceChangerPreset, setVoiceChangerParam
param
参数的预设枚举构造函数,该函数仅用于微调设置具体的混响参数值,如需使用预设枚举来设置混响,请使用新增的 [setReverbPreset] 函数。相关 API 请参考 setReverbPreset, setReverbAdvancedParam
发布日期:2020.10.15
改进优化
问题修复
发布日期:2020.09.24
新增功能
音效是指为了增强真实感或者烘托场景氛围播放的简短效果音,例如:在直播期间播放掌声、礼物音效、提示音等;在游戏中,播放子弹声、碰撞打击声。
音效播放器支持音效播放(可以多音效重叠播放)、播放控制(如暂停播放、音量调节、设置播放进度)、预加载音效等功能。
相关 API 请参考 createAudioEffectPlayer, destroyAudioEffectPlayer
问题修复
相关 API 请参考 onRoomStreamExtraInfoUpdate
IZegoEventHandler
后,某些回调可能引起 crash 的问题。相关 API 请参考 setEventHandler
发布日期:2020.09.17
问题修复
相关 API 请参考 onRoomUserUpdate
发布日期:2020.09.10
新增功能
允许单独设置和获取媒体播放器的本地播放音量和推流音量。
相关 API 请参考 ZegoMediaPlayer
类的 setPlayVolume
, setPublishVolume
, getPlayVolume
, getPublishVolume
方法。
双声道即两个声音通道,听到声音时可以根据左耳和右耳对声音相位差来判断声源的具体位置。当开发者开启双声道采集后,使用专门的双声道采集设备,可以采集到双声道的音频数据并进行推流(推流需同时通过 setAudioConfig
接口开启双声道音频编码功能)。
相关 API 请参考 setAudioCaptureStereoMode, setAudioConfig
开发者可自行控制声浪/音频频谱监控的回调间隔,默认为 100 ms,取值范围为 [100, 3000]。
相关 API 请参考 startSoundLevelMonitor, startAudioSpectrumMonitor
切换房间时允许对新房间的属性进行配置,如登录鉴权等。
相关 API 请参考 switchRoom
改进优化
问题修复
废弃删除
getVolume
接口,请使用 getPlayVolume
和 getPublishVolume
代替onRemoteAudioData
, 请使用 onPlaybackAudioData
代替ZegoAudioDataCallbackBitMaskRemote
, 请使用 ZegoAudioDataCallbackBitMaskPlayback
代替发布日期:2020.08.27
新增功能
该功能支持用户切换房间,调用 switchRoom 接口后停止上一个房间的推拉流并进入新房间,切换房间成功会收到新房间登录成功的回调。与之前通过调用登出原房间和加入新房间两个接口实现的方法相比,更易用也更高效。
相关 API 请参考 switchRoom
自定义采集使用码流推流时,当网络环境发生变化后,SDK 会向开发者抛出需要进行流控的通知。
相关 API 请参考 onEncodedDataTrafficControl
改进优化
当用户进入房间,房间内有流且带有附加信息时,onRoomStreamExtraInfoUpdate 将会回调,因此开发者只需要关心此回调即可处理流附加信息的逻辑。
相关 API 请参考 onRoomStreamExtraInfoUpdate
问题修复
相关 API 请参考 enableCustomVideoCapture, enableCustomVideoRender, enableCustomAudioIO
相关 API 请参考 onPlayerRecvSEI
发布日期:2020.08.13
新增功能
该功能支持同一用户可以同时加入多个房间,目前可进入的总房间数最多为两个。用户加入房间后,只能在主房间中推流,但可以在所有房间中拉流,并且可以正常接收每个房间的信令和回调。该功能通常用于“超级小班”等场景,若需要开启,请联系 ZEGO 技术支持。
相关 API 请参考 loginMultiRoom
该功能可以设置一个以房间为单位的附加消息,该消息跟随整个房间的生命周期,每个登录到房间的用户都能够同步消息。开发者可用于实现各种业务逻辑,如房间公告等等。目前房间附加消息只允许设置一个键值对,且 key 最大长度为 10 字节,value 最大长度为 100 字节。
相关 API 请参考 setRoomExtraInfo
允许开发者在采集音频数据后,或者拉取远端音频数据渲染前,对音频数据进行自定义处理。该功能通常用于 “变声”、“美声” 等场景。
相关 API 请参考 enableCustomAudioCaptureProcessing, enableCustomAudioRemoteProcessing
开发者自行采集纹理时,常出现图像上下颠倒的问题,该功能允许开发者在使用传入纹理 ID (Texture) 的类型进行自定义视频采集时,对视频图像进行翻转。仅当 enableCustomVideoCapture
API 的 ZegoCustomVideoCaptureConfig
参数中的 bufferType
属性为 GLTexture2D
时,该设置才有效。
改进优化
推流采集音量与拉流播放音量范围由 0 ~ 100 扩大至 0 ~ 200,默认值为 100。
相关 API 请参考 setCaptureVolume, setPlayVolume
发布日期:2020.08.06
问题修复
超过最大房间登录数量
错误码的问题。setEngineConfig
的已废弃参数开启辅路推流通道的自定义视频采集功能时的崩溃问题。发布日期:2020.07.30
新增功能
支持调整 10 个频带的增益值,从而达到调整音色的目的。
相关 API 请参考 setAudioEqualizerGain
发布日期:2020.07.23
问题修复
AudioDataCallback
可能不回调的问题。destroyEngine
时个别功能组件销毁失败的问题。发布日期:2020.07.15
新增功能
ZegoWhiteboardView
实现互动白板的功能。改进优化
broadcast message
和房间弹幕消息 barrage message
。setVideoMirrorMode
和 setPublishWatermark
均可生效。问题修复
发布日期:2020.06.30
新增功能
开发者基于此可实现一些音频前处理效果。
相关 API 请参考 enableVirtualStereo, setVoiceChangerParam, setReverbAdvancedParam
开发者可将音视频流录制成本地文件,便于日后作回放等用途。
相关 API 请参考 startRecordingCapturedData, stopRecordingCapturedData
开发者通过监听音频数据回调获取 PCM 数据后可作进一步用途,如对接第三方音频鉴黄、字幕生成等功能。
相关 API 请参考 enableAudioDataCallback
开发者可通过此回调获取未解码数据之后自行解码渲染:ZegoCustomVideoRenderConfig
中允许将 bufferype
的类型设置为 EncodedData
Medium
中等模式。相关 API 请参考 setANSMode
开发者可通过此功能自行采集音频数据发送给 SDK,并且自行获取远端拉流的音频数据来处理或播放。
相关 API 请参考 enableCustomAudioIO
getCustomVideoCaptureSurfaceTexture
新增重载参数,支持选择 ZegoPublishChannel
setCustomVideoCaptureFillMode
新增重载参数,支持 ZegoPublishChannel
改进优化
1001011
当开发者使用了未支持的 bufferType 传入自定义视频渲染配置时,会报错此错误,提醒开发者设置有误。
发布日期:2020.06.28
问题修复
发布日期:2020.06.20
问题修复
onMixerSoundLevelUpdate
回调的问题。发布日期:2020.06.17
问题修复
onAudioMixingCopyData
回调数据的拷贝和越界问题。发布日期:2020.06.15
新增功能
enableCustomVideoCapture
, enableCustomVideoRender
接口,允许在createEngine
之后,预览/推拉流之前,选择是否使用自定义视频采集/渲染功能。enableHeadphoneMonitor
接口,支持耳返功能。sendCustomVideoCaptureEncodedData
,支持发送已编码好的码流数据。问题修复
rotation
参数有误的问题。destroyEngine
之后将不再回调的问题。废弃删除
ZegoEngineConfig
类里的 customVideoCaptureMainConfig
, customVideoCaptureAuxConfig
, customVideoRenderConfig
成员,请使用上述新增的 enableCustomVideoCapture
, enableCustomVideoRender
接口。发布日期:2020.06.11
问题修复
advancedConfig
含有特殊字符时设置失败的问题。发布日期:2020.05.31
新增功能
getAudioConfig
和 getVideoConfig
,方便开发者随时获取和管理当前音视频质量参数。isMuteMicrophone
和 isMuteSpeaker
,方便开发者管理音频设备的状态。问题修复
发布日期:2020.05.18
问题修复
setEngineConfig
显式设置日志路径不生效的问题。createEngine
时没有日志的问题setEventHandler
设置为 null 不生效的问题。发布日期:2020.05.15
新增功能
1000008
。再次调用 setEventHandler
更改 Event Handler 前需要显式置空。
问题修复
setEngineConfig
接口在 createEngine
之后调用不生效的问题。sendBarrageMessage
与 sendCustomCommand
接口参数顺序不正确的问题。发布日期:2020.04.30
新增功能
onRoomOnlineUserCountUpdate
;开发者基于此回调可以实时监听当前房间人数的变更情况,并以 UI 形式向用户展示。问题修复
发布日期:2020.04.15
新增功能
onPublisherQualityUpdate
回调新增几个质量属性,包括 totalSendBytes
(已发送的总字节数)、audioSendBytes
(已发送的音频字节数)、videoSendBytes
(已发送的视频字节数)。开发者可以根据这些属性进行推流数据的统计。onPlayerQualityUpdate
回调新增几个质量属性,包括 totalRecvBytes
(已接收的总字节数)、audioRecvBytes
(已接收的音频字节数)、videoRecvBytes
(已接收的视频字节数)、peerToPeerDelay
(端到端延迟)、peerToPeePacketLostRate
(端到端丢包率)。开发者可以根据这些属性进行拉流数据和拉流延迟的统计。改进优化
问题修复
发布日期:2020.04.05
问题修复
发布日期:2020.03.31
改进优化
发布日期:2020.03.19
问题修复
发布日期:2020.03.14
新增功能
开发者在调用 createEngine
时,可选择应用场景,SDK 会针对实时通讯场景和直播场景进行最优预配置。
当开发者需要实现一路流推摄像头,另一路流推如屏幕采集等输入源时,可使用推辅流功能。该功能可用于实现教学、会议等场景。
开发者通过在 setVideoConfig
中设置 codecID 为 multi layer,可使用分层编码的功能。
开发者可通过调用 enableTrafficControl
选择流控的自适应属性,包括:自适应分辨率、自适应码率、自适应帧率。
开发者可通过指定具体 CDN 的 URL(或使用Zego后台配置),直接将音视频流推送到 CDN,需在推流前设置。
相关 API 请参考 enablePublishDirectToCDN
startPlayingStream
增加一个重载 API ,实现进阶拉流功能。开发者可通过设置拉流CDN配置,直接通过 URL 进行拉流。当推流方使用了直推或转推 CDN 功能的情况下,拉流方需要使用 URL 进行拉流。当推流方开启了分层编码功能后,拉流方可通过设置 videoLayer 为 base 以拉取低分辨率图层。
当开发者需要让拉混流的观众知道当前每条流的声浪状态时,可在发起混流时调用 enableSoundLevel
开启 sound level,且在每条输入流配置中标记一个唯一的音浪ID,则拉流方可以通过监听 onMixerSoundLevelUpdate
获取每条流的音浪通知。
当开发者需要在超过 500 人的房间中发送一些业务不可靠的消息时(如弹幕消息,房间每位观众不一定都必须收到每一条信息),可使用房间弹幕消息功能。
相关 API 请参考 sendBarrageMessage
当开发者使用自定义采集功能时,无需再自行进行渲染,方便使用。
改进优化
destroyEngine
接口,增加同名但带一个 callback 参数的 destroyEngine
接口。当开发者销毁 SDK 且收到回调时,则可认为 SDK 内部占用资源已释放,此时开发者可进行多家 SDK 的切换。
发布日期:2020.02.13
新增功能
发布日期:2020.01.17
问题修复
发布日期:2019.12.27
新增功能
setAudioConfig
接口,可选择配置推流前音频参数(音频编码类型/音频码率/声道数)发布日期:2019.12.13
新增功能
改进优化
发布日期:2019.11.27
新增功能
发布日期:2019.11.11
新增功能
问题修复
发布日期:2019.11.01
新增功能
联系我们
文档反馈