开箱体验
这篇文档面向第一次接触 TiRTC 的开发者,目标是用最少的准备,在最短时间内跑通一条完整链路。
先准备这些东西
开始前,先准备好下面这些内容:
| 项目 | 说明 |
|---|---|
Access ID | 由 TiRTC 平台侧分配 |
Secret Key | 与 Access ID 配套的密钥 |
| 一枚 License | 用于媒体提供方启动体验链路,格式类似peer_id,device_secret_key |
| 一台电脑 | 用来运行 CLI 和展示配置(暂时只支持 MacOS) |
| 两台 Android 手机 | 一台运行媒体提供方,一台运行观看方 |
先下载两个 Android Demo
快速体验使用下面两个 Android Demo:
| 角色 | 应用 |
|---|---|
| 媒体提供方 | RTC-Server |
| 观看方 | RTC-Client |
先分别在两台 Android 手机上安装好这两个应用,再继续后面的步骤。
基本流程
CLI
CLI 负责生成这次连接要用的 token。
媒体提供方
媒体提供方使用 License 接入平台服务,负责采集本地音视频,并等待观看方连入。
这里固定使用 Android Demo RTC-Server。
观看方
观看方负责拿着 peer_id 和 token 发起连接,并播放远端音视频。
这里固定使用 Android Demo RTC-Client。
第一步:用 CLI 生成连接 Token
先在电脑上安装 CLI,然后用它直接生成这次体验要用的连接 Token 和二维码。
安装 CLI
bash
npm install -g tirtc-devtools-cli@latest安装完成后,可以先确认 CLI 已可用:
bash
tirtc-devtools-cli token issue --help配置 Access ID 和 Secret Key
先把这两个参数配置到环境变量:
bash
export TIRTC_CONN_ACCESS_ID="<ACCESS_ID>"
export TIRTC_CONN_SECRET_KEY="<SECRET_KEY>"执行命令
然后执行:
bash
tirtc-devtools-cli token issue "<PEER_ID>"你需要替换的参数只有这些:
<ACCESS_ID><SECRET_KEY><PEER_ID>(License前半段就是PEER_ID)
执行成功后,CLI 会直接输出:
peer_idtoken- 控制台里的 ASCII 二维码
- 本地二维码 PNG 路径
第二步:启动媒体提供方
准备包含下面内容的二维码:
json
{
"license": "XXAABBDDKKFF,zjdangjkasdjasd...."
}在一台 Android 手机上启动媒体提供方 RTC-Server,扫码后即可进入等待连接的状态。
第三步:启动观看方并发起连接
在另一台 Android 手机上启动观看方 RTC-Client。
扫描 CLI 刚才生成的连接 Token二维码,即可直接连接并播放来自前面一台手机推流过来的音视频。
连接 Token 具备防重放机制,用一次就会失效,需要重新生成。
下一步
- 想看完整接入结构:看接入流程概览
- 想把 Token 签发接进自己的服务端:看 获取连接 Token
- 想把观看方接进 Android 客户端工程:看 Android SDK 接入指南
- 想实现自己的媒体提供方(比如 IoT 设备):看 Nano SDK 接入指南