跑通 API 示例项目

声网提供了开源示例项目，演示声网 RTC SDK 的 API 使用示例，以帮助开发者更好地理解和运用声网 SDK 的功能。

本文介绍如何快速跑通 Web 示例项目，体验实时音视频功能。

前提条件

开始之前，请按照以下要求准备开发环境：

• Windows 或 macOS 计算机，需满足以下要求：

  • 下载声网 Web SDK 支持的浏览器。声网强烈推荐使用最新稳定版 Google Chrome 浏览器。

  • 具备物理音视频采集设备。

  • 可连接到互联网。如果你的网络环境部署了防火墙，请参考应对防火墙限制以正常使用声网服务。

  • 搭载 2.2 GHz Intel 第二代 i3/i5/i7 处理器或同等性能的其他处理器。

• 安装 Node.js 及 npm。

• 有效的声网账户和声网项目，请参考开通服务，从声网控制台获取以下信息：

  • App ID：声网随机生成的字符串，用于识别你的 App。

  • App 证书：声网控制台为开发项目生成的随机字符串，用于开启 Token 鉴权，并作为生成 Token 的参数之一。

  • 频道名称：用于标识频道的字符串。

操作步骤

获取示例项目

你可以从 SDK 包或 Gitee/Github 仓库中获取示例项目。

SDK 包

前往下载页面，下载最新版的视频 SDK。

Gitee/Github 仓库

声网提供了开源的示例项目供你参考，你可以前往下载或查看。

示例项目

示例项目

你可以根据需要在对应的路径下查看项目源码：

路径	描述
/src/example/basic	基础示例
/src/example/advanced	进阶示例
/src/example/plugin	插件示例
/src/example/others	其他示例
/src/example/framework/vue	Vue 框架示例
/src/example/framework/react	React 框架示例

配置示例项目

1. 安装依赖项

   在项目根目录下，运行以下命令安装依赖项：

   Shell

   npm install

2. 启动项目

   继续在项目根目录下，运行以下命令启动示例项目：

   Shell

   npm run dev

   执行完成后，终端会显示 please visit: http://localhost:3001/index.html。

3. 设置 App ID 和 App 证书

   在浏览器打开 http://localhost:3001/index.html 页面，在指定位置填入你从声网控制台获取的 App ID 和 App 证书（主次证书均可），然后点击设置。

   信息

   如果项目开启了允许仅 App ID 加入，则 App 证书字段留空。

运行示例项目

1. 你可以任意选择你想体验的功能或场景，设置 Channel 后加入频道。

2. 以进阶示例中的屏幕共享为例，你可以点击 Join as host 以主播身份加入频道。同时，你可以邀请一位朋友使用另一台设备运行该示例项目，使用相同的 App ID、App 证书和频道名，然后点击 Join as audience 加入频道便可以看到你的屏幕共享。