Flutter事件追踪插件iris_event的使用

Flutter事件追踪插件iris_event的使用

iris_event 是一个用于在 C/C++ 和 Dart 之间处理事件的桥接插件，它被 <a href="https://github.com/AgoraIO-Extensions/Agora-Flutter-SDK" rel="ugc">agora_rtc_engine</a> 所使用。

构建

bash cxx/build-<platform>.sh $(pwd)/cxx <output-path> <build-type>

许可证

该项目遵循 MIT 许可证。

示例代码

以下是一个完整的示例代码，展示了如何在 Flutter 应用程序中使用 iris_event 插件。

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

import 'package:iris_event/iris_event.dart';

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

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = '未知';

  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  // 平台消息是异步的，所以我们初始化在一个异步方法中。
  Future<void> initPlatformState() async {
    String platformVersion = '';
    // 平台消息可能会失败，所以我们使用 try/catch 来捕获 PlatformException。
    // 我们还处理消息可能返回 null 的情况。
    // try {
    //   platformVersion =
    //       await _irisEventPlugin.getPlatformVersion() ?? '未知平台版本';
    // } on PlatformException {
    //   platformVersion = '获取平台版本失败。';
    // }

    // 如果在异步平台消息还在飞行时，小部件从树中被移除，我们应该丢弃回复而不是调用
    // setState 来更新我们不存在的外观。
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: Center(
          child: Text('运行在: $_platformVersion\n'),
        ),
      ),
    );
  }
}

代码解释

  1. 导入必要的包：

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

import 'package:iris_event/iris_event.dart';

  2. 定义主函数：

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

  3. 定义 MyApp 类：

    class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

  4. 定义 _MyAppState 类：

    class _MyAppState extends State<MyApp> {
  String _platformVersion = '未知';

  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  5. 初始化平台状态：

    Future<void> initPlatformState() async {
  String platformVersion = '';
  // 平台消息可能会失败，所以我们使用 try/catch 来捕获 PlatformException。
  // 我们还处理消息可能返回 null 的情况。
  // try {
  //   platformVersion =
  //       await _irisEventPlugin.getPlatformVersion() ?? '未知平台版本';
  // } on PlatformException {
  //   platformVersion = '获取平台版本失败。';
  // }

  // 如果在异步平台消息还在飞行时，小部件从树中被移除，我们应该丢弃回复而不是调用
  // setState 来更新我们不存在的外观。
  if (!mounted) return;

  setState(() {
    _platformVersion = platformVersion;
  });
}

  6. 构建应用程序界面：

    [@override](/user/override)
Widget build(BuildContext context) {
  return MaterialApp(
    home: Scaffold(
      appBar: AppBar(
        title: const Text('插件示例应用'),
      ),
      body: Center(
        child: Text('运行在: $_platformVersion\n'),
      ),
    ),
  );
}

更多关于Flutter事件追踪插件iris_event的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter事件追踪插件iris_event的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


iris_event 是 Agora 提供的一个用于事件追踪的 Flutter 插件，主要用于在 Flutter 应用中集成 Agora 的实时音视频服务时，追踪和分析事件。通过这个插件，开发者可以方便地监听和处理与 Agora SDK 相关的各种事件，例如音视频流的连接状态、用户加入或离开频道等。

以下是 iris_event 插件的基本使用步骤：

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 iris_event 插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  agora_rtc_engine: ^x.x.x  # 添加 Agora RTC Engine 的依赖
  iris_event: ^x.x.x        # 添加 iris_event 插件

2. 初始化插件

在 Flutter 应用的 main.dart 文件中，初始化 iris_event 插件：

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  @override
  void initState() {
    super.initState();
    // 初始化 iris_event
    IrisEvent.eventBus.on<Event>().listen((event) {
      // 处理事件
      print('Received event: ${event.toString()}');
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Iris Event Example'),
      ),
      body: Center(
        child: Text('Hello, Iris Event!'),
      ),
    );
  }
}

3. 监听事件

在 IrisEvent.eventBus.on<Event>() 中，你可以订阅并处理来自 Agora SDK 的各种事件。Event 是一个泛型类，你可以根据具体的事件类型进行处理。

例如，监听用户加入频道的事件：

IrisEvent.eventBus.on<UserJoinedEvent>().listen((event) {
  print('User joined: ${event.uid}');
});

4. 触发事件

你还可以通过 IrisEvent.eventBus.fire(event) 来手动触发事件。例如：

IrisEvent.eventBus.fire(UserJoinedEvent(uid: 12345));

5. 自定义事件

你可以定义自己的事件类型，并触发和监听这些事件。例如：

class CustomEvent {
  final String message;

  CustomEvent(this.message);
}

IrisEvent.eventBus.on<CustomEvent>().listen((event) {
  print('Custom event received: ${event.message}');
});

// 触发自定义事件
IrisEvent.eventBus.fire(CustomEvent('Hello, Custom Event!'));

6. 使用 Agora SDK 事件

在使用 Agora SDK 时，iris_event 插件会自动处理 Agora SDK 的事件并分发到 IrisEvent.eventBus，因此你可以通过监听 IrisEvent.eventBus 来处理这些事件。

例如，处理 Agora SDK 的用户加入频道事件：

IrisEvent.eventBus.on<AgoraRtcEngineEvent.UserJoined>().listen((event) {
  print('User joined: ${event.uid}');
});
回到顶部