Agora VideoUIKit for Flutter 使用教程

1. 项目的目录结构及介绍

Agora VideoUIKit for Flutter 项目的目录结构如下：

VideoUIKit-Flutter/
├── example/
│   ├── lib/
│   │   ├── main.dart
│   ├── pubspec.yaml
├── lib/
│   ├── agora_uikit.dart
│   ├── src/
│   │   ├── agora_client.dart
│   │   ├── agora_video_viewer.dart
│   │   ├── agora_video_buttons.dart
│   ├── pubspec.yaml
├── pubspec.yaml
├── README.md

目录结构介绍

• example/: 包含一个示例项目，展示了如何使用 Agora VideoUIKit。
  • lib/: 示例项目的主要代码文件。
    • main.dart: 示例项目的入口文件。
  • pubspec.yaml: 示例项目的依赖配置文件。
• lib/: Agora VideoUIKit 的核心库文件。
  • agora_uikit.dart: 库的入口文件。
  • src/: 库的源代码文件。
    • agora_client.dart: Agora 客户端的实现。
    • agora_video_viewer.dart: 视频显示组件。
    • agora_video_buttons.dart: 视频控制按钮组件。
  • pubspec.yaml: 库的依赖配置文件。
• pubspec.yaml: 项目的根依赖配置文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

示例项目的启动文件

在 example/lib/main.dart 文件中，包含了示例项目的启动代码。以下是该文件的主要内容：

import 'package:flutter/material.dart';
import 'package:agora_uikit/agora_uikit.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  AgoraClient client = AgoraClient(
    appId: "Your App Id Here",
    channelName: "test",
  );

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

  void initAgora() async {
    await client.initialize();
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: SafeArea(
          child: Stack(
            children: [
              AgoraVideoViewer(client: client),
              AgoraVideoButtons(client: client),
            ],
          ),
        ),
      ),
    );
  }
}

启动文件介绍

• main(): 应用程序的入口函数，调用 runApp 方法启动应用。
• MyApp: 应用的主类，继承自 StatefulWidget。
• _MyAppState: 应用的状态类，包含 Agora 客户端的初始化和视频通话界面的构建。
  • AgoraClient: 初始化 Agora 客户端，需要传入 appId 和 channelName。
  • initAgora(): 初始化 Agora 客户端的方法。
  • build(): 构建应用界面的方法，包含视频显示和控制按钮。

3. 项目的配置文件介绍

根配置文件

在项目的根目录下，pubspec.yaml 文件包含了项目的依赖和配置信息。以下是该文件的主要内容：

name: agora_uikit
description: A Flutter plugin to simply integrate Agora Video Calling or Live Video Streaming to your app with just a few lines of code.
version: 1.3.10
publish_to: none

environment:
  sdk: ">=2.12.0 <3.0.0"

dependencies:
  flutter:
    sdk: flutter
  agora_rtc_engine: ^4.0.7
  permission_handler: ^8.1.4+2

dev_dependencies: