Flutter音视频信号控制插件auro_stream_signaling的使用

Flutter音视频信号控制插件auro_stream_signaling的使用

AuroStream Signaling 是一个基于WebSockets构建的实时信号SDK，旨在实现客户端之间无缝的实时通信。该SDK支持房间创建、消息传递、用户管理以及事件驱动的操作。

特性

• 实时通信：通过WebSockets支持基于事件的实时通信。
• 房间管理：轻松创建、加入和删除房间。
• 基于事件的信号传递：可以向用户或房间发送和接收自定义事件或对象。
• 用户状态检测：跟踪用户何时加入或离开房间。
• 错误处理：提供了全面的错误处理和回调机制，用于处理连接问题。
• 可定制的回调：灵活的回调功能，用于不同的事件，如用户加入、房间创建和错误处理。

安装

要开始使用 AuroStream Signaling，在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  auro_stream_signaling: ^0.0.1

然后，在终端运行以下命令：

dart pub get

使用方法

1. 初始化SDK

在使用SDK之前，需要使用你的项目凭证（projectId、apiKey 和 port）进行初始化：

import 'package:auro_stream_signaling/auro_stream_signaling.dart';

void main() {
  AuroStreamSignaling.initialize(
    projectId: 'your_project_id',
    apiKey: 'your_api_key',
    port: 'your_port',
  );
}

2. 连接到服务器

初始化后，你可以连接到服务器：

AuroStreamSignaling.instance.connectServer(
  whenConnect: () {
    print('Connected to the signaling server.');
  },
  whenConnectError: (error) {
    print('Connection error: $error');
  },
  whenReconnect: (data) {
    print('Reconnected successfully.');
  },
  whenReconnectError: (error) {
    print('Reconnection failed: $error');
  },
  whenDisconnect: () {
    print('Disconnected from the server.');
  },
);

3. 创建和管理房间

创建一个房间

AuroStreamSignaling.instance.createRoom(roomId: 'my_room');

加入一个房间

AuroStreamSignaling.instance.joinRoom(
  roomId: 'my_room',
  username: 'user1',
);

离开一个房间

AuroStreamSignaling.instance.leaveRoom(
  roomId: 'my_room',
  username: 'user1',
);

4. 发送和接收事件

向房间发送自定义事件

AuroStreamSignaling.instance.sendObjectTORoom(
  roomId: 'my_room',
  eventName: 'custom_event',
  object: {'message': 'Hello, World!'},
  exceptMe: false,
);

向所有用户发送自定义事件

AuroStreamSignaling.instance.sendObjectTOAll(
  eventName: 'broadcast_event',
  object: {'message': 'Broadcast message'},
  exceptMe: false,
);

向特定用户发送自定义事件

AuroStreamSignaling.instance.sendObjectTOUser(
  userId: 'user123',
  eventName: 'private_message',
  object: {'message': 'Hello, User!'},
);

接收来自房间的事件

AuroStreamSignaling.instance.onReceiveObjectFromRoomListener(
  eventName: 'custom_event',
  whenReceiveObjectFromRoom: (data) {
    print('Event received from room: $data');
  },
);

5. 错误处理

监听操作期间的错误：

AuroStreamSignaling.instance.connectServer(
  whenGetError: (error) {
    print('An error occurred: $error');
  },
);

示例代码

以下是完整的示例代码，展示了如何使用 auro_stream_signaling 插件：

import 'package:auro_stream_signaling/auro_stream_signaling.dart';

import 'signaling_service.dart';
import 'home_signaling_screen.dart';
import 'package:flutter/material.dart';

void main() {
  AuroStreamSignaling.initialize(
    projectId: 'your_project_id',
    apiKey: 'your_api_key',
    port: 'your_port',
  );
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'AuroStream Signaling',
      home: LoginScreen(),
    );
  }
}

class LoginScreen extends StatefulWidget {
  const LoginScreen({super.key});

  [@override](/user/override)
  State<LoginScreen> createState() => _LoginScreenState();
}

class _LoginScreenState extends State<LoginScreen> {
  AuroStreamSignalingServices? auroStreamSignalingServices;
  final userController = TextEditingController();
  final roomIdController = TextEditingController();

  [@override](/user/override)
  void initState() {
    auroStreamSignalingServices = AuroStreamSignalingServices();
    auroStreamSignalingServices!.connectServer();
    super.initState();
  }

  void connect(bool isCreate) {
    /// 应该有一个唯一的字符串作为用户名，例如用户名或ID
    final username = userController.text.trim();
    final roomId = roomIdController.text.trim();
    if (username.isNotEmpty && roomId.isNotEmpty) {
      auroStreamSignalingServices!.initUsername(usernameId: username);
      Navigator.push(
        context,
        MaterialPageRoute(
          builder: (context) => HomeSignalingScreen(
            auroStreamSignalingServices: auroStreamSignalingServices!,
            roomId: roomId,
            isCreate: isCreate,
          ),
        ),
      );
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: SafeArea(
        child: SingleChildScrollView(
          child: Padding(
            padding: const EdgeInsets.all(20.0),
            child: Column(
              crossAxisAlignment: CrossAxisAlignment.start,
              mainAxisAlignment: MainAxisAlignment.center,
              children: [
                const Text(
                  'UserName',
                  style: TextStyle(color: Color(0xff0445A2), fontSize: 16),
                ),

                const SizedBox(height: 8),
                TextFormField(
                  controller: userController,
                  decoration: const InputDecoration(
                    hintText: 'Enter your username..',
                    border: OutlineInputBorder(),
                    prefixIcon: Icon(Icons.person),
                  ),
                ),
                const SizedBox(height: 8),
                TextFormField(
                  controller: roomIdController,
                  decoration: const InputDecoration(
                    hintText: 'Enter Room ID..',
                    border: OutlineInputBorder(),
                    prefixIcon: Icon(Icons.person),
                  ),
                ),
                const SizedBox(height: 50),
                Row(
                  mainAxisAlignment: MainAxisAlignment.spaceEvenly,
                  children: [
                    MaterialButton(
                      color: const Color(0xff0445A2),
                      onPressed: () {
                        connect(true);
                      },
                      child: const Text(
                        'Create',
                        style: TextStyle(
                            color: Colors.white,
                            fontSize: 20,
                            fontWeight: FontWeight.w700),
                      ),
                    ),
                    MaterialButton(
                      color: const Color(0xff0445A2),
                      onPressed: () {
                        connect(false);
                      },
                      child: const Text(
                        'Join',
                        style: TextStyle(
                            color: Colors.white,
                            fontSize: 20,
                            fontWeight: FontWeight.w700),
                      ),
                    ),
                  ],
                ),
              ],
            ),
          ),
        ),
      ),
    );
  }
}