跑通 API 示例项目
声网在 GitHub 上提供一个开源的小程序实时音视频示例项目。在搭建自己的小程序项目前，你可以下载体验或参考源代码。本文介绍如何配置环境并跑通该示例项目。
前提条件
开始前，请确保你的开发环境满足如下条件：
-
一个经过企业认证的微信小程序账号。在调试小程序 Demo 过程中，需要使用 live-pusher 和 live-player 组件。只有特定行业的认证企业账号才可以使用这两个组件。详见小程序官网文档。
-
下载并安装最新版本的微信开发者工具。
-
参考开通服务在控制台创建项目、获取 和临时 ，并开启小程序服务。
注意临时 Token 的有效期是 24 小时。Token 过期会引起项目编译失败。
-
至少一台安装有微信 App 的移动设备。
操作步骤
1. 获取小程序组件权限
在微信公众平台的小程序开发选项中，切换到接口设置页签，打开实时播放音视频流和实时录制音视频流的开关。
2. 配置服务器域名
在小程序的开发设置里，将如下域名配到服务器域名里，其中 request 合法域名区域填入以 https 开头的域名；socket 合法域名区域点入以 wss 开头的域名。
如果你使用的 SDK 为 v2.5.3 或更高版本，你需要在 request 合法域名及 socket 合法域名中添加以下域名：
wss://miniapp.agoraio.cn
https://uap-ap-web-1.agora.io
https://uap-ap-web-2.agoraio.cn
https://uap-ap-web-3.agora.io
https://uap-ap-web-4.agoraio.cn
https://report-ad.agoralab.co
https://rest-argus-ad.agoralab.co
https://uni-webcollector.agora.io
如果你使用的 SDK 为 v2.4.6 或更低版本，你需要在 request 合法域名及 socket 合法域名中添加以下域名：
https://uni-webcollector.agora.io
wss://miniapp.agoraio.cn
https://miniapp-1.agoraio.cn
https://miniapp-2.agoraio.cn
https://miniapp-3.agoraio.cn
https://miniapp-4.agoraio.cn
3. 获取示例项目并集成小程序 SDK
参考如下步骤获取小程序示例项目，并将小程序 SDK 集成到示例项目中。
- 下载 Agora-Miniapp-Tutorial 仓库。
- 下载最新版微信小程序 SDK 并解压。
- 将解压后的 SDK 包更名为 mini-app-sdk-production.js，然后将其复制到
Agora-Miniapp-Tutorial-master/lib路径下。 - 打开
Agora-Miniapp-Tutorial-master/utils/config.js文件，然后在const APPID行后添加你获取到的声网项目 App ID。 - 打开
Agora-Miniapp-Tutorial-master/pages/meeting/meeting.js文件，将client.join和client.rejoin方法中的undefined参数修改为你获取到的临时 Token，确保需要带 ""。
4. 运行示例项目
参考如下步骤在微信开发者工具中运行小程序示例项目。
-
打开微信开发者工具，点击小程序界面的 +。
-
在弹出的界面中选择导入项目页签，然后在目录一栏中选中小程序示例项目在本地的存储路径，填入你微信小程序的 App ID，然后点击导入。
-
加载成功后，微信开发者工具上会出现小程序示例项目的界面。为保证体验效果，我们建议选择真机调试。点击右上角的真机调试，工具界面会出现一个真机调试的二维码。
-
使用移动端微信 App 扫描二维码，进入手机调试界面。填入房间名，然后点击加入房间。在弹出的对话框中点击确定，表示作为主播加入频道。稍等片刻，就可以在小程序的界面看到本地的视频画面。请确保此处填入的房间名，和生成临时 Token 时填入的频道名是一致的。
常见问题
通常客户端初始化失败，会伴随错误码 901 或 903。我们建议你检查确认如下项：
- 填入
config.js文件中的 App ID，确认已在控制台开启了小程序服务。 - 你的微信小程序账号需要在开发界面需要配置域名，且打开了实时播放音视频流和实时录制音视频流的开关。
- 生成临时 Token 时使用的频道名，需要和运行小程序时填入的频道名一致。