集成SDK
更新时间: 2024/03/15 16:57:59
本文为您介绍了小程序端集成 SDK 的操作步骤,帮助您快速集成 SDK 并实现实时音视频通话的基本功能。
注意事项
微信官方在其开发者社区增加了《小程序用户隐私保护指引》等条款。在小程序正式版本发布之前,开发者需要加入该指引中设备的说明。如果没有进行配置,可能会导致正式版本的摄像头和麦克风无法开启。
详细说明和配置方法请参见配置小程序用户隐私保护指引。
环境要求
请确保您的开发环境符合以下环境要求:
-
微信小程序:
- 微信 App iOS 最低版本要求:7.0.9
- 微信 App Android 最低版本要求:7.0.8
- 小程序基础库最低版本要求:2.10.0
- 已安装最新版本的微信开发者工具。
- 由于微信开发者工具不支持原生组件(即 < live-pusher > 和 < live-player > 标签),需要在真机上进行运行体验。
-
QQ 小程序:
- QQ App 推荐版本:8.8.3 和 8.8.5
- 小程序基础库最低版本要求:v1.28.0
- 已安装最新版本的 QQ 小程序开发者工具。
- 已安装 QQ 的移动端设备以供调试和运行体验。
准备小程序开发环境
- 已参考入门操作流程,在网易云信控制台中创建应用、获取App Key,且已为该应用开通了音视频通话2.0 产品。
- 微信小程序:
-
已注册微信小程序账号,并通过企业认证,并在 微信公众平台 的 开发 > 接口设置中,开启实时播放音视频流和实时录制音视频流权限。仅指定类目的应用可以开通小程序推拉流标签。
-
已在微信小程序中创建微信的 live-pusher 组件和 live-player 组件,分别实现音视频播放和音视频录制功能。
-
- QQ 小程序:
- 注册 QQ 小程序开发者平台,并通过资质审核。详细说明请参考 QQ 小程序官方文档。
- 已在 QQ 小程序中创建 live-pusher 组件和 live-player 组件,分别实现音视频播放和音视频录制功能。
- 仅指定类目的应用可以使用
live-pusher
和live-player
组件,请确认应用已通过小程序的类目审核。
配置白名单并打开端口
如果您的网络环境部署了防火墙,请在小程序管理后台,将以下域名及对应端口添加到域名白名单中。
域名:
# http接口
https://nrtc.netease.im
https://webrtcgwcn.netease.im
https://webrtcgwhz.netease.im
https://statistic.live.126.net
# websocket接口
wss://webrtcgwcn.netease.im
wss://webrtcgwhz.netease.im
端口:
目标端口 | 协议 | 操作 |
---|---|---|
80;443 | TCP | 允许 |
30000 ~ 40000 | UDP | 允许 |
以下为微信小程序的配置步骤举例:
在微信公众平台 的 开发 > 开发管理 > 开发设置 > 服务器域名中,设置 request合法域名和 socket合法域名。
集成 SDK
-
请登录网易云信 SDK 下载中心下载 NERTC 微信小程序 SDK。
-
引入 SDK。
import YunXinMiniappSDK from '../../sdk/NERTC_Miniapp_SDK_v4.6.11.js'
此处版本号仅为示例,推荐使用最新版本。
后续步骤
此文档是否对你有帮助?