You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

Web SDK

最近更新时间：2024.03.15 20:27:48

首次发布时间：2022.06.01 18:19:19

我的收藏

Web SDK 4.60

该版本于 2024 年 1 月 4 日发布。

重要变更

  1. 自 4.60.2 版本（于 2024 年 1 月 17 日发布）起，基础美颜功能增加鉴权步骤，你需要在创建美颜插件实例时传入鉴权文件，参看基础美颜功能。

新增功能

  1. 新增 Token 发布/订阅权限即将过期和过期的回调，用于提示用户及时更新 Token 相关权限，以保证正常的音视频通话。

    API说明
    onTokenPublishPrivilegeWillExpireToken 发布权限过期前 30 秒将触发该回调
    onTokenPublishPrivilegeDidExpiredToken 发布权限过期时触发该回调
    onTokenSubscribePrivilegeWillExpireToken 订阅权限过期前 30 秒将触发该回调
    onTokenSubscribePrivilegeDidExpiredToken 订阅权限过期时触发该回调

  2. 支持语音通话场景下发送 SEI 信息，调用 sendSEIMessage 接口后，SDK 内部会生成黑帧视频用于发送 SEI 信息，并通过 onSEIStreamUpdate 事件回调远端用户黑帧视频流的发布状态。

功能优化

  1. 开启音频选路后，支持本端发布的音频流不参与音频选路，适用于要求指定用户的发言能一直被收听到的场景，例如设置固定的主持人麦位，具体参看 setAudioSelectionConfig。

Web SDK 4.58

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

本次发布提升了某些场景下数据报告的准确性并修复了一些已知问题。

Web SDK 4.56

该版本于 2023 年 9 月 7 日发布。

新增功能

  1. 支持同时开启音视频采集功能。调用该方法时，浏览器会同时请求麦克风和摄像头权限，用户只需授权一次。参看 startAudioAndVideoCapture。

  2. 支持配置本地主流音量回调模式和本地主流音量回调的数据范围（控制回调中是否包含混音），新增功能可能影响 onActiveSpeaker 回调。参看 enableAudioPropertiesReport 接口中新增参数 LocalMainReportMode 和 AudioReportMode。

  3. onError 回调细化房间解散、被踢、封禁等错误码；joinRoom 增加用户/房间封禁导致的进房失败回调。

  4. 支持设置主流的内容类型 VideoEncoderConfig.contentHint，在不同场景下提升视频体验。

  5. 在渲染远端视频流时，支持通过 setRemoteVideoPlayer.videoPlayerOption 设置视频的旋转角度。

Web SDK 4.55

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

新增功能

  1. NetworkQuality 新增网络连接断开枚举值 DOWN = 6，你可以通过 onNetworkQuality 感知网络断连。

  2. startAudioCapture 新增返回值 MediaTrackSettings，返回实际生效的音频采集参数。

Web SDK 4.54

该版本于 2023 年 7 月 13 日发布。

新增功能

  1. 支持跨房间转发媒体流功能。跨房间转发媒体流指将可见用户的媒体流同时转发到多个房间，观众在原来的房间中就能够接收到来自其他房间主播的媒体流。相关接口及示例代码请参看跨房间转发媒体流。

Web SDK 4.53

该版本于 2023 年 6 月 15 日发布。

新增功能

  1. 支持通过 onRemoteStreamStats 获取 rtt 时间。参看 RemoteAudioStats 和 RemoteVideoStats。

  2. 内部视频渲染支持拉伸模式，视频帧非等比缩放，拉伸至填满视窗区域，参看 VideoRenderMode.RENDER_MODE_FILL。

  3. 虚拟背景功能新增 GPU 模式，支持在初始化时选择使用，参看虚拟背景功能。

Web SDK 4.52

该版本于 2023 年 5 月 18 日发布。

新增功能

  1. 支持调节音频的采集音量和播放音量，具体参看以下接口：
API说明
setCaptureVolume调节音频采集音量
setPlaybackVolume调节本地播放的单个远端用户的音量
setPublicStreamVolume调节本地播放的公共流播放音量
  1. 提供虚拟背景插件，你可以通过此插件，将用户人像和背景分离，采用模糊背景或自定义图片作为虚拟背景。该功能需单独付费使用，具体参看虚拟背景功能。

Web SDK 4.51

该版本于 2023 年 4 月 13 日发布。

新增功能

  1. 支持设置远端音视频流是否同步渲染，参看 setRemoteStreamRenderSync。

  2. 支持对房间内说话人的语音进行识别和翻译。使用该功能前，你需要开通机器翻译服务并前往 RTC 控制台，在功能配置页面开启字幕功能。参看 startSubtitle 和 stopSubtitle。

Web SDK 4.49

该版本于 2023 年 2 月 23 日发布。

新增功能

  1. 支持设置本地缓存的日志级别以及可使用的最大缓存空间，参看 setLogConfig 和 downloadLog。

功能优化

  1. 提升合流转推功能易用性，统一 RTC SDK 与 OpenAPI 的合流转推音视频参数限制范围及默认值，并在 SDK 层面进行参数校验。优化部分合流转推参数不合法时的处理方式，实现自动修正为默认值。参看 LiveTranscodeConfig。

Web SDK 4.47

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

新增功能

  1. 支持在客户端上，对本地/远端的视频流进行截图。参看 takeLocalSnapshot 和 takeRemoteSnapshot。
  2. 支持获取浏览器的原生接口 MediaStreamTrack，并通过该接口控制音视频，获取媒体信息。
  3. 提供基础美颜插件，你可以通过此插件，实现美白、磨皮、锐化等基础美颜功能，参看基础美颜功能。
  4. 提供 AI 降噪插件，你可以通过此插件满足不同场景的降噪需求，参看 AI 降噪功能。

Web SDK 4.46

该版本于 2022 年 9 月 21 日发布。

新增功能

  1. 成功调用 enableAudioPropertiesReport 后，SDK 会持续监测音量最大的远端用户。当房间内用户数量大于或等于 2 且有活跃用户时，SDK 会触发回调 onActiveSpeaker 并周期性报告最活跃用户的信息。

  2. 封禁/解禁指定房间内的指定用户的音/视频流时，房间内所有用户都会收到 onAudioStreamBanned/onVideoStreamBanned的回调。

  3. 支持设置共享屏幕时的内容类型参数 ScreenEncoderConfig.contentHint，在不同场景下提升屏幕共享的视频质量。

问题修复

  1. 删除了头文件和文档中两个实时消息相关错误码 USER_MESSAGE_EXCEED_MAX_LENGTH 和 USER_MESSAGE_EMPTY_USER，相应的错误实际是通过 INVALID_PARAMS 抛出，例如， SDKError('INVALID_PARAMS', 'The message length must be less than 64K')。

Web SDK 4.45

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

新增功能

  1. 支持在调用 createEngine 时根据业务场景，设置自动播放策略。扩展 play 接口能力，当音视频流因自动播放策略设置或自动播放失败不播放时，都可以调用 play 接口开启播放。onAutoPlayFailed 回调增加了对本地媒体流自动播放失败情况的支持，不带 userId 参数时，表示本地媒体流自动播放失败。更多自动播放策略信息，详见 Web 端自动播放策略。

  2. 设置共享屏幕的视频编码参数，同时对视频采集生效。若设置的参数浏览器不支持，RTC SDK 按照浏览器支持的参数范围进行采集，并通过回调 onLocalVideoSizeChanged 通知实际参数。

Web SDK 4.44

该版本于 2022 年 7 月 29 日发布。

新增功能

  1. 支持订阅音视频流回退功能。在弱网情况下，你可以开启订阅的音视频流自动回退策略，保证用户的音视频体验，功能详细介绍和使用信息参看音视频流回退。
  2. 新增按需订阅功能，发布端开启大小流模式后，订阅端可以根据需要设置期望订阅的视频编码参数，发布端将会自动匹配一路参数相近的流进行发布，具体参看 API：setRemoteVideoConfig。此功能需联系技术支持人员通过配置下发开启

功能优化

  1. 细化了转推直播相关事件、错误码和错误码信息。你能根据不同推流事件和错误码及时修改直播间的状态提示。可通过新增接口 onStreamMixingEvent 查看事件类型、错误码和错误码信息。

  2. 重新设计媒体流和音视频设备接口，实现了摄像头/麦克风采集的媒体流与屏幕共享媒体流的分离控制，同时支持灵活控制媒体流的发布/取消发布、订阅/取消订阅，具体接口变更参看升级指南。

Web SDK 4.43

该版本于 2022 年 7 月 18 日发布。

新增功能

  1. 新增音频场景 RoomProfileType（已于 v4.51 废弃）和音质选项设置接口 setAudioProfile，满足更多不同场景的音视频算法和参数以及网络参数配置需要。 RoomProfileType 既可以在客户端设置，也可以通过配置下发。在选定的音频场景 RoomProfileType 基础上，调用 setAudioProfile 切换音质档位。

问题修复

  1. 修复了 Web 端与 Native 端进行 SEI 消息互通时，消息可能解析错误的问题。

Web SDK 4.42

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

新增功能

  1. 支持音频采集和播放设备测试功能
接口说明
startAudioPlaybackDeviceTest开始播放测试
stopAudioPlaybackDeviceTest停止播放测试
startAudioDeviceRecordTest开启录播测试
stopAudioDeviceRecordAndPlayTest停止录制，并开始播放测试语音
stopAudioDevicePlayTest停止录播测试

  1. 支持在本地视频采集暂停时，使用指定的图片填充上行视频流。使用这一功能时，你可以在录制音视频通话时，避免某一用户画面黑帧的情况。参看 setDummyCaptureImagePath。

  2. 支持发布视频大小流，并为一路或多路流设置视频编码参数。参看 enableSimulcastMode 和 setVideoEncoderConfig 。

功能优化

  1. 使用 SDK 内部机制进行视频采集时，可以通过返回值获取实际视频采集参数。参看 startVideoCapture。

Web SDK 4.41

该版本于 2022 年 6 月 16 日发布。

新增功能

  1. 支持发布和订阅公共流。新增接口如下：
接口说明
startPushPublicStream发布一路公共流
updatePublicStreamParam更新公共流参数
stopPushPublicStream停止发布公共流
startPlayPublicStream订阅指定公共流
stopPlayPublicStream取消订阅指定公共流
setPublicStreamVideoPlayer为指定公共流设置使用的视图和渲染模式
onPublicStreamStats用户订阅的公共流统计信息以及网络状况
onPushPublicStreamResult公共流发布结果回调
onPublicStreamSEIMessageReceived回调公共流中包含的 SEI 信息
onFirstPublicStreamVideoFrameDecoded公共流的视频首帧解码成功
onFirstPublicStreamAudioFrameDecoded公共流的音频首帧解码成功
onFirstPublicStreamAudioFrameDecoded公共流的首帧视频渲染成功

  1. 支持 vp8 编码模式，你可以调用 getSupportedCodecs 查看当前浏览器是否支持 vp8 编码类型。

  2. 支持云代理功能。能够在有防火墙限制的情况下，通过云代理实现正常的音视频通话。参看 startCloudProxy。

Web SDK 4.40

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

新增功能

  1. 支持收发房间外实时消息。新增接口如下：
接口说明
login发送房间外消息和服务器消息前需要先登录
logout登出
updateLoginToken更新登录 Token

getPeerOnlineStatus

查询对端用户或本端用户的登录状态
已登录的用户才能接收信息，发送消息前先获取状态确保发送成功

sendUserMessageOutsideRoom向指定用户发送房间外消息
sendUserBinaryMessageOutsideRoom向指定用户发送房间外二进制消息
setServerParams设置目标服务器地址和签名
sendServerMessage向服务器发送实时消息
sendServerBinaryMessage向服务器发送实时二进制消息
  1. 转推直播的音频和视频参数增加默认值。调用 startLiveTranscoding 时如果没有传相应参数，RTC 将使用默认参数发起转推直播任务。调用 defaultTranscoding 可获取转推直播的音频和视频参数增加默认值。

Web SDK 4.38

该版本于 2022 年 5 月 6 日发布。

性能优化

  1. 优化 isSupported 接口，返回当前浏览器是否支持 Web SDK，详见 Web SDK 的浏览器兼容性。
  2. 增加了房间内发送即时消息的错误码。

Web SDK 4.36

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

4.0 版本是基于 3.0 版本的全量重构版本，不向下兼容。