发布日期: 2024-08-19
新增功能
电音音效指的是可以让人说话、唱歌的声音,经过处理后带有电音的效果。该功能常用于KTV、语聊房场景。
在 [CreateEngine] 初始化 SDK 之前,调用 [SetElectronicEffects] 接口可以开启电音音效,并可根据需要设置不同模式的电音调式以及对应调式的起始音高。未调用此接口时,默认关闭电音音效。
开发者也可以通过 [SetVoiceChangerPreset] 接口预设常见的电音音效,目前支持预设 C 大调电音音效、A 小调电音音效、和声小调电音音效。
相关 API 请参考 SetElectronicEffects
支持调整 10 个频带的增益值,从而达到调整音色的目的。
相关 API 请参考 SetAudioEqualizerGain
注意:仅 Windows、macOS 及 Linux 支持该功能。
支持通过 [SetAudioDeviceVolume] 接口设置音频设备(扬声器或麦克风)的采集音量后再推拉流,但由于系统限制可能导致此接口调用失败,推荐直接使用 [SetCaptureVolume] 和 [SetPlayVolume] 接口来调节推拉流音量。
相关 API 请参考 SetAudioDeviceVolume, GetAudioDeviceVolume, SetCaptureVolume, SetPlayVolume
注意:仅 Windows 及 macOS 平台支持该功能。
可以监控音频输入或输出设备的音量。
相关 API 请参考 StartAudioDeviceVolumeMonitor, StopAudioDeviceVolumeMonitor
注意:仅 Windows、macOS 及 Linux 平台支持该功能。
可根据需要对音频输入或输出设备静音或取消静音。
相关 API 请参考 MuteAudioDevice, IsAudioDeviceMuted
注意:仅 Windows 和 macOS 平台支持该功能。
调用 [GetCurrentAudioDevice] 接口,可以获取当前使用的音频设备信息,包括设备 ID 和设备名称,减少开发者的开发量。
相关 API 请参考 GetCurrentAudioDevice
关闭摄像头时,支持持续推送 JPEG/JPG、BMP 和 HEIF 格式的静态图片。例如,主播退后台的时候,会主动关闭摄像头,此时观众侧需要展示主播暂时离开的图片。
初始化 SDK 后,关闭摄像头之前通过 [SetDummyCaptureImagePath] 接口设置所推静态图片的路径,开始正常推流后,调用 [EnableCamera] 接口关闭摄像头时会开始推静态图片,调用 [EnableCamera] 接口打开摄像头时会结束推静态图片。
相关 API 请参考 SetDummyCaptureImagePath
相关 API 请参考 OnPublisherDummyCaptureImagePathError
支持在本地缓存网络资源,如果需要播放同一个网络资源时,将优先使用缓存数据,提升用户体验。
相关 API 请参考 EnableLocalCache
注意:若某条流设置为允许审核,如果开发者没有发起审核任务,这条流也不会被送审。
当调用审核接口时,默认会对房间内的所有流进行审核。如果客户端要控制某条流不可以被送审,可以在调用 [StartPublishingStream] 接口开始推流时,将送审标识 [streamCensorFlag] 参数设置为 1(不允许)。
相关 API 请参考 StartPublishingStream, ZegoPublisherConfig > StreamCensorFlag
发布日期: 2024-05-07
新增功能
注意:从该版本起,不再支持 iOS 11.0 及之前的版本。
从 2024-04-29 开始,所有上架 App Store 的应用必须支持 iOS 17.0 版本,详情请参考 Apple 开发者网站官方说明。
改进优化
PrivacyInfo.xcprivacy
注意:如客户集成的是 3.13.2 版本之前的 SDK,如想发布到 App Store,需下载最新版本的 SDK,并拷贝 PrivacyInfo.xcprivacy 文件到旧版 SDK 相应位置。
请将 iOS SDK 内的隐私清单文件 PrivacyInfo.xcprivacy
升级到新版本,详情请参考 SDK 包内的 “ZegoExpressEngine.framework” 文件夹下的“PrivacyInfo.xcprivacy”。
发布日期: 2024-01-18
新增功能
注意:
如需使用该功能,请联系 ZEGO 技术支持。
版权音乐插件包无法单独使用,必须与 Express SDK 搭配使用。
支持版权音乐功能插件化,当开发者的业务场景仅需更新版权音乐相关的代码时,可以单独集成插件包,无需更新 Express SDK,即可平滑迁移。
问题修复
发布日期: 2024-01-08
问题修复
发布日期: 2024-01-04
问题修复
发布日期: 2023-12-13
新增功能
该功能常用于 KTV 等需要混流对齐的场景,当拉流端播放时,通过 SetPlayStreamsAlignmentProperty 接口控制播放的实时音视频流是否需要精准对齐。若需要,则拉取的所有流中包含精准对齐参数的会进行对齐;若不需要,则所有流都不对齐。
相关 API 请参考 SetPlayStreamsAlignmentProperty
新增支持将直播流作为输入流,进行混流处理;直播输入流的 URL 支持 RTMP 和 HTTP-FLV 两种协议。该功能适用于将主播连麦的RTC 画面流与云端体育直播流、游戏直播画面流等进行混合,实现游戏或体育直播解说的场景中。
改进优化
用户在 A 设备上登录成功后,A 设备断网;然后使用同一 userID 在 B 设备上登录成功。此时如果 A 设备网络恢复,重连会失败,并抛出 1002086 错误码,提示该 userID 已在其他设备登录。
发布日期: 2023-11-20
问题修复
发布日期: 2023-08-17
新增功能
注意:如需使用该功能,请联系 ZEGO 技术支持。
开发者设置“智能云代理”模式后,在 RTC 或 L3 拉流时,会优先使用直连网络模式进行尝试。如果直连网络不可用、且当前是蜂窝网络,则继续留在直连模式重试;如果直连网络不可用、且当前是非蜂窝网络,则切到云代理模式,详情请参考 云代理。
媒体播放器支持设置网络资源的 Http Headers,开发者可基于该配置,自定义限定网络资源的访问方式,加强资源的安全防护。
相关 API 请参考 SetHttpHeader
发布日期: 2023-07-18
新增功能
新增 SetAudioDeviceMode 接口进行动态修改设备的音频模式,该配置决定设备的音量模式、前处理模式以及 Mic 占用逻辑,您可以根据具体场景进行选择,详情请参考 如何设置音频设备模式 ZegoAudioDeviceMode?
相关 API 请参考 SetAudioDeviceMode
在万人范围音视频、游戏语音场景中,支持设置 3D 音效距离的衰减范围区间 [min, max]。距离小于 min 时,音量不会随着距离的增加而衰减;距离大于 max 时,将无法听到对方的声音。
相关 API 请参考 SetReceiveRange, SetAudioReceiveRange
改进优化
相关 API 请参考 SubmitLog
发布日期: 2023-04-25
新增功能
开启声卡采集后,可以将系统播放的声音混入推流中,如浏览器播放的声音、第三方播放器软件播放的声音等,并支持通过 SetMixSystemPlayoutVolume 设置采集音量。
相关 API 请参考 EnableMixSystemPlayout、SetMixSystemPlayoutVolume
问题修复
废弃删除
具体说明,请参考 App Store submission requirement starts April 25 及 Xcode 14 Release Notes。
具体说明,请参考 Xcode 14 Release Notes。
发布日期: 2023-03-24
新增功能
StandardVoiceCall
标准语音通话场景场景化音视频配置新增 StandardVoiceCall
标准语音通话场景,适用于 1v1 纯语音通话场景,详情请参考 场景化音视频配置。
相关 API 请参考 SetRoomScenario
发布日期: 2023-02-01
改进优化
注意:自定义信令配置默认大小为 1KB,如需扩展到 4KB,请联系 ZEGO 技术支持进行处理。
问题修复
发布日期: 2022-12-13
新增功能
注意:如需使用该功能,请联系 ZEGO 技术支持。
虚拟场景中,由于每个场景的地图大小、音视频互动玩法及规模不同,需要针对每个场景进行自定义配置。3.1.0 版本后,“万人范围音视频”及“多人实时状态同步”支持通过 SDK 接口,并使用模板 ID 指定场景。模板 ID 对应的配置项只能通过服务器 API 进行配置,详情请参考 服务端 API - 场景模版配置。
相关 API 请参考 templateID
注意:如需使用该功能,请联系 ZEGO 技术支持。
用户在登录场景时,可以带上 Token 参数,以验证合法性。
相关 API 请参考 ZegoSceneParam > token, ZegoRangeScene > RenewToken
注意:如需使用该功能,请联系 ZEGO 技术支持。
通过设置 SDK 的云代理接口,将 SDK 对应的所有流量通过云端的代理服务器进行中转,实现与 RTC 通信,详情请参考 云代理 。
相关 API 请参考 SetCloudProxyConfig
发布日期:2022-11-29
新增功能
Express Unity3D SDK 现已支持 Linux x86_64 架构,开发环境要求,请参考 集成 SDK。
问题修复
发布日期:2022.11.01
本次更新包含不兼容改动,详情请参考 v3.0.0 升级指南。
新增功能
由于 SDK 支持特性裁包,部分特性可能已被裁剪;可以使用此函数快速判断当前 SDK 是否支持指定的功能特性。
相关 API 请参考 IsFeatureSupported
为方便开发者快速接入,降低开发者接入门槛,SDK 提供多种预设场景。开发者可根据所需场景,选择对应的房间模式 ZegoScenario,SDK 将自动应用适合该场景的音视频编解码器、音视频参数、流控策略等配置,从而快速实现该场景下的最佳效果。
当前支持场景包括秀场直播、KTV、标准 1v1 音视频通话、高画质 1v1 音视频通话、标准语聊房、高音质语聊房,详情请参考 场景化音视频配置。
相关 API 请参考 SetRoomScenario
注意:该功能仅在开发阶段使用,请勿在线上版本开启此功能。
新增 EnableDebugAssistant 接口,开发者调用该接口开启调试助手功能,SDK 将会打印日志到控制台,并且在 SDK 其他接口的调用出现异常时,UI 会弹窗提示错误。
相关 API 请参考 EnableDebugAssistant
问题修复
废弃删除
废弃 ZegoScenario 场景枚举中的 [General],[Communication], [Live] 三种场景,详情请参考 场景化音视频配置。
发布日期:2022.09.13
问题修复
发布日期:2022.08.02
发布日期:2022.07.15
新增功能
注意:若希望通过地区、用户等更多维度,从云端控制拉流方式,请联系 ZEGO 技术支持进行相关配置。
拉流接口新增 CDN_PLUS 的拉流资源模式(ZegoStreamResourceMode),开发者可按流维度自行开启使用CDN_PLUS 拉流。CDN Plus 拉流是比 CDN 拉流直播质量更高,但是价格接近 CDN 的一种性价比高的拉流方式,详情请参考 CDN Plus 拉流。
相关 API 请参考 StartPlayingStream
问题修复
发布日期:2022.07.01
新增功能
当开发者需要获取远端用户的音频数据或者需要获取本地麦克风采集到的数据另做他用(例如纯音频录制、纯音频第三方监控、纯音频实时分析)时,可调用 StartAudioDataObserver 接口开启实时音频数据监测。
相关 API 请参考 StartAudioDataObserver,StopAudioDataObserver,OnCapturedAudioData,OnPlayerAudioData,OnPlaybackAudioData,OnMixedAudioData
发布日期:2022.06.20
问题修复
发布日期:2022-06-13
新增功能
注意:如需使用该功能,请联系 ZEGO 技术支持开通后台服务。
在调用 StartPublishingStream 接口开始推流时,开发者可以设置 ZegoStreamCensorshipMode 参数,进行流级别的音视频自动审核,包含如涉黄、涉政等审核类型,以此降低开发者的接入难度和业务维护成本。
相关 API 请参考 StartPublishingStream
改进优化
调用 StartPublishingStream 接口且将 ZegoPublisherConfig 中的 forceSynchronousNetworkTime 值设置为 1,则 SDK 内部会等到 OnNetworkTimeSynchronized 回调通知 NTP 网络时间同步完成后再推流,此时再调用 SetStreamAlignmentProperty 接口开启混流精准对齐功能。
相关 API 请参考 StartPublishingStream, SetStreamAlignmentProperty, OnNetworkTimeSynchronized
问题修复
相关接口如下:LoadResourceFromMediaData,LoadResourceWithPosition,LoadCopyrightedMusicResourceWithPosition
发布日期:2022-05-18
新增功能
[loginRoom] 接口新增 “callback” 参数,支持从 “callback“ 返回登录房间结果。
[logoutRoom] 接口新增 “callback” 参数,支持从 “callback“ 返回退出房间结果。
相关 API 请参考 LoginRoom, LogoutRoom
当房间的连接状态发生变化时会触发 [onRoomStateChanged] 回调,通过 “ZegoRoomStateChangedReason” 参数提供更加详细的连接状态及状态变化原因。
相关 API 请参考 OnRoomStateChanged
开发者在监听声浪回调时,往往只关注人声部分,可调用 StartSoundLevelMonitor 接口,传入 “ZegoSoundLevelConfig”,开启 VAD 人声检测。
SDK 在本地采集声浪回调 OnCapturedSoundLevelInfoUpdate、远端音频声浪回调 OnRemoteSoundLevelInfoUpdate 中也新增是否包含人声检测的参数。
相关 API 请参考 StartSoundLevelMonitor, OnCapturedSoundLevelInfoUpdate, OnRemoteSoundLevelInfoUpdate
新增本地和远端用户的上下行网络质量回调 OnNetworkQuality,默认每两秒回调一次本地和每个拉取的远端用户的网络状况(包括未知、优秀、良好、中等、较差、网络断线)。当开发者希望分析链路上的网络情况,或想要了解本地和远端用户的网络状况时可以使用该功能。
相关 API 请参考 OnNetworkQuality
当通过 EnableTrafficControl 接口开启了指定推流通道的流量控制后,可通过 SetTrafficControlFocusOn 接口控制是否因为远端网络状况差而启动流量控制。
相关 API 请参考 SetTrafficControlFocusOn
直推 CDN 时,在不改变推流方式的情况下,SDK 从客户的 CDN 源站拉流,通过 L3 将音视频内容分发给观众,通过 ZegoResourceType 控制源站资源。该功能常用于直播场景。
相关 API 请参考 StartPlayingStream
问题修复
发布日期:2022-04-19
新增功能
媒体播放器组件提供播放音视频媒体文件的能力,并且支持将播放的媒体文件的音画数据推流出去。
相关 API 请参考 CreateMediaPlayer, DestroyMediaPlayer
SDK 可以指定房间,由 ZEGO 实时音视频服务器自动将房间内的所有音频流进行混流(目前只支持混音频流),常用于纯语聊场景。
可以调用 StartAutoMixerTask 接口开启自动混流,调用 StopAutoMixerTask 接口关闭自动混流。
相关 API 请参考 StartAutoMixerTask, StopAutoMixerTask
调用 GetNetworkTimeInfo 接口可以获取当前网络时间(NTP),包括当前网络时间的时间戳和最大误差。在进行多端行为同步时,需要获取同步网络时间对当前时间进行校准。
相关 API 请参考 GetNetworkTimeInfo
调用 SetStreamAlignmentProperty 接口可以开启或关闭混流精准对齐功能,常用于 KTV 等需要混流对齐的场景。
相关 API 请参考 SetStreamAlignmentProperty
问题修复
发布日期:2022-03-30
问题修复
已将 iOS 平台 SDK 库格式改为 Plugins 兼容的 framework 格式。
发布日期:2022-03-18
改进优化
2.17.0 及以上版本,在创建引擎时将 AppSign 传空或不传,并且在登录房间时必须传入 Token,鉴权通过后即可使用实时音视频功能,具体请参考 使用 Token 鉴权。
2.17.0 之前版本,在创建引擎时传入 AppSign,鉴权通过后即可使用实时音视频功能。
相关 API 请参考 CreateEngine, LoginRoom
问题修复
修复了开启游戏语音后调用 SwitchRoom 接口导致崩溃的问题。
发布日期:2022-02-25
新增功能
用户权限控制指的是用户登录房间,或是在房间内进行推/拉流等操作时,ZEGO 服务端根据用户登录时携带的 Token 参数,判断用户是否有对应的权限,避免因权限控制缺失或操作不当引发的风险问题。 目前仅支持用户登录房间和用户房间内推流两个权限的校验。
相关 API 请参考 LoginRoom, RenewToken, onRoomTokenWillExpire
通过混响高级参数可以根据需要调节更精细的混响效果,并在原有预设混响中新增了录音室、KTV、摇滚、演唱会等效果,在预设变声中新增了磁性男和清新女音效,增加实时语音趣味性,能够适应更多的场景。
相关 API 请参考 SetVoiceChangerParam, SetReverbPreset, SetVoiceChangerPreset, SetVoiceChangerParam
用户可以根据需要设置混响回声参数,最多允许设置 7 次回声 (delay),并支持单独设置每个回声的延迟、衰减,以及整体的输入输出增益值。也可以搭配变声、混响以实现自定义各式各样的声音效果。
相关 API 请参考 SetReverbEchoParam
空间音频能够感知空间内 360° 的声音位置。开发者可以通过空间音频功能在音视频房间内营造更逼真的“座位”效果,用户可以通过空间音频感知声音的来源方向,还原线下场景。适用于语聊房、剧本杀和线上会议等场景。
相关 API 请参考 EnablePlayStreamVirtualStereo
新增支持全方位虚拟立体声,将单声道的声音,通过算法处理,模拟成立体感的声音。该功能常用于 KTV 场景中,可以使唱歌的声音更加有立体感。
当调用 [EnableVirtualStereo] 接口,将 angle 参数设置为 -1 时,表示立体声效果为全方位立体声。
相关 API 请参考 EnableVirtualStereo
当开发者需要对某流优先保证质量时,可使用 [SetPlayStreamFocusOn] 接口。例如:上课场景,学生拉多路流,则可设置老师流高优先级。
相关 API 请参考 SetPlayStreamFocusOn
音频路由是指 App 在播放音频时使用的音频输出设备,常见的音频路由有:扬声器、听筒、耳机、蓝牙设备等。开发者可以调用 [GetAudioRouteType] 接口获取当前音频路由。
相关 API 请参考 GetAudioRouteType
通过改变用户的音调,使输出的声音在感官上与原始声音不同,实现男声变女生等多种效果。
相关 API 请参考 SetVoiceChangerParam
与远端用户连麦成功后,当远端扬声器设备状态发生变更时,例如开/关扬声器,可以通过 [OnRemoteSpeakerStateUpdate] 回调监听。
相关 API 请参考 OnRemoteSpeakerStateUpdate
当有耳机插拔、扬声器和听筒切换等音频路由发生变化时会抛出此回调。
相关 API 请参考 OnAudioRouteChange
通过 [OnLocalDeviceExceptionOccurred] 回调可以设置要检测的设备类型,如摄像头、扬声器、麦克风等,开发者可以根据不同设备类型的错误回调进行相应的处理。
相关 API 请参考 OnLocalDeviceExceptionOccurred
通过 [SetAudioRouteToSpeaker] 可以设置音频路由到扬声器,当选择不使用内置扬声器播放声音时,即设为 “false” 时,SDK 会根据系统调度选择当前优先级最高的音频输出设备播放声音。
相关 API 请参考 SetAudioRouteToSpeaker
该功能用于指定播放缓存自适应调整的区间范围,开发者可根据场景进行设置。
相关 API 请参考 SetPlayStreamBufferIntervalRange
当拉流时需要一次性关闭所有远端用户的音频或视频流时,可通过该功能实现。
相关 API 请参考 MuteAllPlayStreamAudio, MuteAllPlayStreamVideo
第一帧视频数据被渲染完之后会收到 [OnPublisherRenderVideoFirstFrame] 回调。
相关 API 请参考 OnPublisherRenderVideoFirstFrame
本端用户可以通过 [SetAllPlayStreamVolume] 接口控制所有音频流的播放音量。
相关 API 请参考 SetAllPlayStreamVolume
相关 API 请参考 OnApiCalledResult
废弃删除
因为命名规范问题,在 2.16.0 及以上版本废弃 [SetBuiltInSpeakerOn] 接口,请使用 [SetAudioRouteToSpeaker] 来实现原来的功能。
相关 API 请参考 SetAudioRouteToSpeaker
为了让开发者直观的了解出现异常的设备类型以及具体的异常情况,在 2.16.0 及以上版本废弃了 [OnDeviceError] 回调,请使用 [OnLocalDeviceExceptionOccurred] 回调代替。
相关 API 请参考 OnDeviceError,OnLocalDeviceExceptionOccurred
发布日期:2022-02-18
新增功能
[ZegoRangeAudioMode] 枚举新增隐秘小队 SecretTeam,本地用户可以根据需要,在初始化游戏语音 [CreateRangeAudio] 之后,通过 [SetRangeAudioMode] 接口设置隐秘小队模式。该小队模式下,小队成员可以接收到世界模式用户的语音。
相关 API 请参考CreateRangeAudio, SetRangeAudioMode
发布日期:2022-01-05
新增功能
新增 [CallExperimentalAPI] 接口,ZEGO 通过此 API 提供 RTC 业务中的部分技术预览或特别定制功能,需要获取功能的使用或详情其详情可咨询 ZEGO 技术支持。 新增 [onRecvExperimentalAPI] 回调委托,用于接收试验性 API JSON 内容。
相关 API 请参考 CallExperimentalAPI, onRecvExperimentalAPI
发布日期:2021-12-24
新增功能
游戏语音模块新增 [MuteUser] 接口,本地用户可以根据需要,在初始化游戏语音 [CreateRangeAudio] 之后,通过 [MuteUser] 接口设置是否接收指定远端用户的音频数据。不接收时,可降低硬件和网络的开销。
当开发者需要快速关闭或恢复远端音频时可以使用该功能。
相关 API 请参考 MuteUser
问题修复
修复了 [SetEngineConfig] 接口中 “advancedConfig” 配置不生效的问题。
发布日期:2021-12-17
新增功能
新增游戏语音功能模块,可提供范围语音、3D音效、小队语音等功能。适用于吃鸡类游戏、元宇宙类场景。
范围语音:房间内的收听者对音频的接收距离有范围限制,若发声者与自己的距离超过该范围,则无法听到声音。为保证语音清晰,附近超过 20 人发声时,只能听到离自己最近的 20 个发声者的声音。
3D音效:声音有 3D 空间感且按距离衰减。
小队语音:玩家可以选择加入小队,并支持在房间内自由切换“全世界”模式和“仅小队”模式。
相关 API 请参考 CreateRangeAudio, DestroyRangeAudio, SetAudioReceiveRange, UpdateSelfPosition, UpdateAudioSource, EnableSpatializer, EnableMicrophone, EnableSpeaker, SetRangeAudioMode, SetTeamID
改进优化
优化了 [SetAudioConfig] 接口,新增可选参数 “ZegoPublishChannel”,可指定通道号进行音频配置。
相关 API 请参考 SetAudioConfig
[onPlayerQualityUpdate] 回调增加 mos 参数,表示当前音频质量情况。
相关 API 请参考 onPlayerQualityUpdate
问题修复
发布日期:2021-11-29
问题修复
联系我们
文档反馈