跑通 API 示例项目

  • Flutter

更新时间

了解如何快速接入实时互动 RTC,完成环境准备、参数配置、示例运行和核心流程验证。

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

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

前提条件

  • Flutter 2.10.5 或更高版本

  • Dart 2.14.0 或更高版本

  • 根据你的目标平台,准备对应的开发和运行环境:

    目标平台环境要求
    iOS
    • macOS 10.15 或更高版本
    • 最新版本的 Xcode
    • 两台 iOS 设备
    Android
    • macOS 10.15 或更高版本
    • Windows 10 或更高版本
    • 最新版本的 Android Studio
    • 两台 Android 设备
    macOS
    • macOS 10.15 或更高版本
    • 最新版本的 Xcode
    • 两台 macOS 设备
    Windows
    • Windows 10 或更高版本
    • 最新版本的 Visual Studio
    • 两台 Windows 设备
    表格内容超出当前宽度,可横向滚动查看更多列。

    信息

    • 更多环境要求细节,详见 Install Flutter。
    • 你可以运行 flutter doctor 命令检查开发和运行环境是否达到要求。
  • 可以访问互联网的计算机。如果你的网络环境部署了防火墙,参考应对防火墙限制以正常使用声网服务。

  • 一个有效的声网账号以及声网项目。请参考开通 RTC 服务从声网控制台获得以下信息:

    • App ID:声网随机生成的字符串,用于识别你的项目。
    • 临时 Token:Token 也称为动态密钥,在客户端加入频道时对用户鉴权。临时 Token 的有效期为 24 小时。
    • 频道名:用于标识频道的字符串。

操作步骤

获取示例项目

  1. 运行以下命令克隆仓库到本地:

    Shell
    git clone git@github.com:AgoraIO-Extensions/Agora-Flutter-SDK.git
  2. 声网实时音视频 Flutter SDK 的 API 使用示例位于 /example 路径下。

    路径描述
    /example/lib/examples/basic基础功能。
    /example/lib/examples/advanced进阶功能。
    表格内容超出当前宽度,可横向滚动查看更多列。

配置示例项目

  1. 集成 SDK 并安装依赖

    在仓库的本地目录下,运行以下命令集成 SDK 并安装依赖项:

    Shell
    flutter pub get
  2. 设置 App ID 和临时 Token

    打开 /example/lib/config/agora.config.dart 文件,将 <TEST_APP_ID>、<TEST_TOKEN> 和 <TEST_CHANNEL_ID> 分别替换为你从控制台获取的 App ID、临时 Token 以及生成 Token 时使用的频道名。

    Dart
    String get appId {
      return '<TEST_APP_ID>';
    }
    
    String get token {
      return '<TEST_TOKEN>';
    }
    
    String get channelId {
      return '<TEST_CHANNEL_ID>';
    }

编译并运行示例项目

  1. 将目标设备连接到电脑。

  2. 打开终端,导航到 /examples 目录。

  3. 运行以下命令在可用设备上运行 Flutter 示例项目。

    Shell
    flutter run
  4. 以 macOS 为例,编译完成后,你的设备上会弹出以下应用。

  5. 你可以任意选择你想体验的场景。以 Basic 中的 JoinChannelVideo 为例,在 Channel ID 中输入生成临时 Token 时指定的频道名,并点击 Join channel 加入频道。

  6. 为更好地体验各种音视频互动场景,你可以邀请一位朋友使用另一台设备运行该示例项目,使用相同的 App ID、Token 和频道名加入频道,你们会看到并听到彼此。