本文介绍在正式使用声网 Miniapp SDK for WeChat 进行通话/直播前,需要准备的开发环境,包含前提条件及 SDK 集成方法等内容。
请确保满足以下开发环境要求:
请确保已安装 微信开发者工具。
请确保你的微信小程序基础库支持 live-pusher
及 live-player
组件,且这两个组件在微信开发者工具中打开。
请确保在微信公众平台账号的开发设置中,给予以下域名请求权限:
https://miniapp.agoraio.cn
https://miniapp-1.agoraio.cn
https://miniapp-2.agoraio.cn
https://miniapp-3.agoraio.cn
https://miniapp-4.agoraio.cn
https://uni-webcollector.agora.io
wss://miniapp.agoraio.cn
请确保在使用声网相关功能及服务前,已打开特定端口,详见 防火墙说明。
在集成微信小程序组件之前,声网建议你先阅读 微信小程序开发官方文档。
第一次使用微信小程序支持需要先开通服务,步骤如下:
开通成功后你就可以在用量页面看到小程序的使用情况。
在微信小程序中实现音视频功能,需要使用微信的 live-player 组件 和 live-pusher 组件。
该组件用于实现微信小程序的实时音视频播放功能。开发者在创建该组件后,还需要在 js 文件中调用 API 接口对应的组件来实现该功能。详见 微信小程序 API 说明。
声网小程序中,创建 live-player 的示例代码如下:
<live-player
id="player"
src="{{rtmp 播放地址}}"
mode="RTC"
bindstatechange="playerStateChange"
object-fit="fillCrop" />
该组件用于实现微信小程序的实时音视频录制功能。开发者在创建该组件后,还需要在 js 文件中调用 API 接口对应的组件来实现该功能。详见 微信小程序 API 说明。
声网小程序中,创建 live-pusher
的示例代码如下:
<live-pusher
url="{{rtmp 推流地址}}"
mode="RTC"
bindstatechange="recorderStateChange" />
下载 声网小程序 SDK 并解压。
将 SDK 包中到的 mini-app-sdk-production 文件复制到你的小程序项目文件夹中。
使用 require
将小程序 SDK 集成到项目中:
const AgoraMiniappSDK = require('../../lib/mini-app-sdk-production.js');
其中 ../../lib/mini-app-sdk-production.js
为你的 js 文件本地路径。
完成了客户端集成后,你可以使用声网 SDK,参考左侧《快速开始》菜单栏下的步骤,并结合下图中的 API 调用顺序,进行通话/直播:
如果在使用过程中遇到问题,请参考小程序 SDK 常见问题回答 或 错误码和警告码 排除解决。