Flutter即时通讯插件flutter_agora_messenger的使用

声明

声网呼叫邀请SDK

声网的云信令SDK只有Android和iOS版本的，这里对他们进行了Flutter的封装，可以结合声网视频通话、音频通话还有推送SDK完成音视频通话的功能。

相关文档

• 声网呼叫邀请官方文档
• 声网RTM TOKEN生成方式
• 声网视频通话官方Flutter Demo
• 声网语音通话官方文档

安装方式

方法一：通过GitHub安装

在pubspec.yaml文件中添加以下内容：

dependencies:
  flutter_agora_messenger:
    path: ../flutter_agora_messenger

方法二：通过Pub安装

（此部分未提供具体步骤，通常需要在pubspec.yaml中添加依赖并执行flutter pub get）

呼叫流程 (A 呼叫 B)

1. 发起呼叫
   A调用startOutgoingCall发起呼叫，B收到remoteInvitationReceived事件。

2. 挂断处理

   • A挂断时，A收到localInvitationCanceled，B收到remoteInvitationCanceled事件。
   • B挂断时，B收到remoteInvitationRefused，A收到localInvitationRefused事件。

3. 接听处理
   B接听时，B收到remoteInvitationAccepted，A收到localInvitationAccept事件。

Demo

配置参数

在运行Demo之前，需要修改Configs中的参数：

• appId: 声网的AppId。
• tmpRtmToken: 声网RTM Token，参考RTM TOKEN生成文档。
• tmpLocalNumber: 本机号码。
• tmpPeerNumber: 呼叫号码。

示例代码

以下是完整的示例代码，展示了如何使用flutter_agora_messenger插件实现即时通讯功能。

main.dart

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

import 'package:flutter/services.dart';
import 'package:flutter_agora_messenger/flutter_agora_messenger.dart';
import 'package:flutter_agora_messenger_example/Configs.dart'; // 配置文件
import 'package:flutter_agora_messenger_example/calling_page.dart'; // 呼叫页面
import 'package:flutter_agora_messenger_example/home_page.dart'; // 主页

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

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    super.initState();
    // 初始化插件
    FlutterAgoraMessenger().initial(Configs.appId);
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      builder: (context, widget) {
        return widget!;
      },
      home: HomePage(), // 启动主页
    );
  }
}

HomePage.dart（主页）

import 'package:flutter/material.dart';
import 'package:flutter_agora_messenger/flutter_agora_messenger.dart';
import 'calling_page.dart'; // 呼叫页面

class HomePage extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Flutter Agora Messenger Demo'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            // 跳转到呼叫页面
            Navigator.push(
              context,
              MaterialPageRoute(builder: (context) => CallingPage()),
            );
          },
          child: Text('开始呼叫'),
        ),
      ),
    );
  }
}

CallingPage.dart（呼叫页面）

import 'package:flutter/material.dart';
import 'package:flutter_agora_messenger/flutter_agora_messenger.dart';
import 'package:flutter_agora_messenger_example/Configs.dart'; // 配置文件

class CallingPage extends StatefulWidget {
  [@override](/user/override)
  _CallingPageState createState() => _CallingPageState();
}

class _CallingPageState extends State<CallingPage> {
  String _status = '等待呼叫...';

  [@override](/user/override)
  void initState() {
    super.initState();
    // 初始化呼叫监听
    FlutterAgoraMessenger().onRemoteInvitationReceived.listen((event) {
      setState(() {
        _status = '对方已接听';
      });
    });

    FlutterAgoraMessenger().onLocalInvitationCanceled.listen((event) {
      setState(() {
        _status = '呼叫已取消';
      });
    });

    FlutterAgoraMessenger().onRemoteInvitationRefused.listen((event) {
      setState(() {
        _status = '对方拒绝了呼叫';
      });
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('呼叫页面'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text(_status),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: () {
                // 开始呼叫
                FlutterAgoraMessenger().startOutgoingCall(
                  Configs.tmpLocalNumber,
                  Configs.tmpPeerNumber,
                  Configs.tmpRtmToken,
                );
              },
              child: Text('发起呼叫'),
            ),
          ],
        ),
      ),
    );
  }
}