前提条件

开发环境要求

如果你的目标平台为 iOS，你的开发环境需要满足以下需求：

• Flutter 1.0.0 或更高版本
• Dart 2.12.0 或更高版本
• macOS 操作系统
• 最新版本的 Xcode

如果你的目标平台为 Android，你的开发环境需要满足以下需求：

• Flutter 1.0.0 或更高版本
• Dart 2.12.0 或更高版本
• macOS 或 Windows 操作系统
• 最新版本的 Android Studio

运行环境要求

• 如果你的目标平台为 iOS，你需要有一台 iOS 的真机。
• 如果你的目标平台为 Android，你需要有一台 Android 真机或模拟器。

其他要求

一个有效的 Agora 开发者账号。

获取 App ID 和 Token

1. 创建 Agora 项目

按照以下步骤，在控制台创建一个 Agora 项目。

1. 登录 Agora 控制台，点击左侧导航栏 项目管理按钮进入项目管理页面。

2. 在项目管理页面，点击创建按钮。

   

3. 在弹出的对话框内输入项目名称，选择鉴权机制为 APP ID + Token。

4. 点击提交，新建的项目就会显示在项目管理页中。

2. 获取 Agora 项目的 App ID

Agora 会给每个项目自动分配一个 App ID 作为项目唯一标识。

在 Agora 控制台的项目管理页面，找到你的项目，点击 App ID 右侧的眼睛图标就可以直接复制项目的 App ID。

3. 生成临时 Token

为提高项目的安全性，Agora 使用 Token（动态密钥）对即将加入频道的用户进行鉴权。

为了方便测试，Agora 控制台提供生成临时 Token 的功能，具体步骤如下：

1. 在控制台的项目管理页面，点击已创建项目的 图标，打开 Token 页面。

   

2. 输入一个频道名，例如 test，然后点击生成临时 Token。临时 Token 的有效期为 24 小时。加入频道时，请确保填入的频道名与生成临时 Token 时填入的频道名一致。

   

创建 Flutter 项目

本文使用 Visual Studio Code 创建 Flutter 项目。你需要在 Visual Studio Code 中安装 Flutter plugin。关于详细设置可以参考 Set up an editor。

1. 打开 Visual Studio Code，在 View > Command 菜单选择 Flutter: New Project 命令，按回车键，然后输入项目名称，按回车键。在弹出的窗口中选择项目的创建位置。
2. 选择完成后，Visual Studio Code 会自动生成一个简单的示例项目。

添加依赖项

在 pubspec.yaml 文件中添加以下依赖项：

1. 添加 agora_rtc_engine 依赖项，集成 Agora Flutter SDK。关于 agora_rtc_engine 的最新版本可以查询 https://pub.dev/packages/agora_rtc_engine。
2. 添加 permission_handler 依赖项，安装权限处理插件。

environment:
  sdk: ">=2.12.0 <3.0.0"

# 依赖项
dependencies:
  flutter:
    sdk: flutter


  # The following adds the Cupertino Icons font to your application.
  # Use with the CupertinoIcons class for iOS style icons.
  cupertino_icons: ^0.1.3
  #  Agora Flutter SDK 依赖项，请使用最新版本的 agora_rtc_engine
  agora_rtc_engine: ^4.0.5
  #  权限处理插件依赖项
  permission_handler: ^6.0.0

由于 JCenter 即将关闭，Agora 已停止将 RTC Android SDK 包发布到 JCenter，改为发布到 JitPack。因此，编译 Android 应用时，请确保在项目的 /android/build.gradle 文件中添加如下行：

allprojects {
    repositories {
        ...
        maven { url 'https://www.jitpack.io' }
    }
}

基本流程

打开 main.dart，删除

void main() => runApp(MyApp());

语句下方的全部代码。并按照步骤增加以下代码：

1. 导入 package

导入以下 package：

import 'dart:async';

import 'package:agora_rtc_engine/rtc_engine.dart';
import 'package:flutter/material.dart';
import 'package:permission_handler/permission_handler.dart';

2. 定义 App ID 和 Token

定义 App ID 和 Token。详见校验用户权限。

/// 定义 App ID 和 Token
const APP_ID = '<Your App ID>';
const Token = '<Your Token>';

3. 定义 Flutter 应用类

定义 MyApp 应用类：

// 应用类
class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

4. 定义应用状态类

定义应用状态类，包含以下设置：

• 获取麦克风权限
• 创建 RTC 客户端实例
• 定义事件处理逻辑
• 加入频道
• 构建 UI

// 应用状态类
class _MyAppState extends State<MyApp> {
  bool _joined = false;
  int _remoteUid = 0;
  bool _switch = false;

  @override
  void initState() {
    super.initState();
    initPlatformState();
  }

  // 初始化应用
  Future<void> initPlatformState() async {
    // 获取麦克风权限
    await [Permission.microphone].request();

    // 创建 RTC 客户端实例
    RtcEngineContext context = RtcEngineContext(APP_ID);
    var engine = await RtcEngine.createWithContext(context);
    // 定义事件处理逻辑
    engine.setEventHandler(RtcEngineEventHandler(
        joinChannelSuccess: (String channel, int uid, int elapsed) {
          print('joinChannelSuccess ${channel} ${uid}');
          setState(() {
            _joined = true;
          });
        }, userJoined: (int uid, int elapsed) {
      print('userJoined ${uid}');
      setState(() {
        _remoteUid = uid;
      });
    }, userOffline: (int uid, UserOfflineReason reason) {
      print('userOffline ${uid}');
      setState(() {
        _remoteUid = 0;
      });
    }));
      // 设置频道场景为直播
    await engine.setChannelProfile(ChannelProfile.LiveBroadcasting);
    // 设置用户角色为主播
    await engine.setClientRole(ClientRole.Broadcaster);
        // 加入频道,频道名为 123
    await engine.joinChannel(Token, '123', null, 0);

  }

  // 构建简单通话 UI
    Widget build(BuildContext context) {
            return MaterialApp(
                title: 'Agora Audio quickstart',
                home: Scaffold(
                    appBar: AppBar(
                        title: Text('Agora Audio quickstart'),
                    ),
                    body: Center(
                        child: Text('Please chat!'),
                    ),
                ),
            );
        }

}

运行项目

1. 在项目根目录运行以下命令安装依赖项。

    flutter packages get

2. 运行项目。

    flutter run

常见问题

如果运行环境为 Android，对于中国大陆用户，运行 flutter run 时可能会卡在 Running Gradle task 'assembleDebug'... 或出现以下错误：

Running Gradle task 'assembleDebug'...
Exception in thread "main" java.net.ConnectException: Connection timed out: connect

解决方案如下：

1. 在相应 Android 项目的 build.gradle 文件中，使用国内镜像源。下面的示例代码使用了阿里镜像源。

buildscript {
    ext.kotlin_version = '1.3.50'
    repositories {
        // google()
        // jcenter()
        maven { url 'https://maven.aliyun.com/repository/google' }
        maven { url 'https://maven.aliyun.com/repository/public' }
    }

...

allprojects {
    repositories {
        // google()
        // jcenter()
        maven { url 'https://maven.aliyun.com/repository/google' }
        maven { url 'https://maven.aliyun.com/repository/public' }
    }
}

2. 在相应 Android 项目的 gradle-wrapper.properties 文件中，将 distributionUrl 设为本地路径。以 gradle 5.6.4 为例，你可以将 gradle-5.6.4-all.zip 文件复制到 gradle/wrapper 目录，然后 distributionUrl 设置为：

distributionUrl=gradle-5.6.4-all.zip