Flutter实时音视频通信插件volc_engine_rtc的使用

火山引擎实时音视频 SDK 的 Flutter 插件包

此 Flutter 插件是对 火山引擎实时音视频 SDK 的包装。

如何使用

设备权限

火山引擎实时音视频 SDK 需要获取 相机 和 麦克风 权限来开始视频通话。

iOS

打开 Info.plist 文件并且添加：

• Privacy - Microphone Usage Description，并且在 Value 列中添加描述。
• Privacy - Camera Usage Description，并且在 Value 列中添加描述。

如果启用了后台模式，则应用程序在切换到后台时仍可以运行语音呼叫。在 Xcode 中选择应用目标，单击 Capabilities 选项卡，启用 Background Modes，然后选中 Audio, AirPlay, and Picture in Picture。

更改 Podfile 来设置 火山引擎实时音视频 SDK 的仓库源：

source 'https://github.com/volcengine/volcengine-specs.git'

Android

VolcEngineRTC 已经声明了必要的权限，会合并到 AndroidManifest.xml 中。

代码许可

本项目遵守 MIT license。

示例代码

以下是一个简单的示例，展示了如何使用 volc_engine_rtc 插件创建一个基本的实时音视频通信应用。

项目结构

lib/
├── main.dart
└── login_page.dart

main.dart

// Copyright (c) 2022 Beijing Volcano Engine Technology Ltd.
// SPDX-License-Identifier: MIT

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

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

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

  @override
  Widget build(BuildContext context) => MaterialApp(
        theme: ThemeData(
          primarySwatch: Colors.blue,
        ),
        home: const LoginPage(),
      );
}

login_page.dart

// Copyright (c) 2022 Beijing Volcano Engine Technology Ltd.
// SPDX-License-Identifier: MIT

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

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

  @override
  _LoginPageState createState() => _LoginPageState();
}

class _LoginPageState extends State<LoginPage> {
  final TextEditingController _roomController = TextEditingController();
  final TextEditingController _tokenController = TextEditingController();

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('登录'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            TextField(
              controller: _roomController,
              decoration: const InputDecoration(labelText: '房间号'),
            ),
            TextField(
              controller: _tokenController,
              decoration: const InputDecoration(labelText: 'Token'),
            ),
            ElevatedButton(
              onPressed: () async {
                String room = _roomController.text;
                String token = _tokenController.text;

                if (room.isNotEmpty && token.isNotEmpty) {
                  await VolcEngineRTC().joinRoom(room, token);
                  Navigator.pushReplacement(
                    context,
                    MaterialPageRoute(builder: (context) => const RoomPage(room: room)),
                  );
                } else {
                  ScaffoldMessenger.of(context).showSnackBar(
                    const SnackBar(content: Text('请输入房间号和Token')),
                  );
                }
              },
              child: const Text('加入房间'),
            ),
          ],
        ),
      ),
    );
  }
}

room_page.dart

// Copyright (c) 2022 Beijing Volcano Engine Technology Ltd.
// SPDX-License-Identifier: MIT

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

class RoomPage extends StatefulWidget {
  final String room;

  const RoomPage({Key? key, required this.room}) : super(key: key);

  @override
  _RoomPageState createState() => _RoomPageState();
}

class _RoomPageState extends State<RoomPage> {
  late VolcEngineRTC _volcEngineRTC;

  @override
  void initState() {
    super.initState();
    _volcEngineRTC = VolcEngineRTC();
    _volcEngineRTC.setEventHandler(VolcEngineRTCEventHandler(
      onUserJoined: (userId) {
        setState(() {
          // 更新UI
        });
      },
      onUserLeft: (userId) {
        setState(() {
          // 更新UI
        });
      },
    ));
  }

  @override
  void dispose() {
    _volcEngineRTC.leaveRoom();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('房间 ${widget.room}'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            _volcEngineRTC.leaveRoom();
            Navigator.pop(context);
          },
          child: const Text('离开房间'),
        ),
      ),
    );
  }
}

说明

1. main.dart: 这是应用的入口点，创建了一个 MyApp 小部件，设置了主题并显示了登录页面。
2. login_page.dart: 登录页面包含两个输入框，分别用于输入房间号和 Token。点击“加入房间”按钮后，会调用 VolcEngineRTC().joinRoom 方法加入房间，并导航到房间页面。
3. room_page.dart: 房间页面显示当前房间的信息，并提供一个按钮用于离开房间。在 initState 方法中，设置了 VolcEngineRTC 的事件处理器，以便在用户加入或离开房间时更新 UI。

通过以上步骤，您可以快速搭建一个基于 volc_engine_rtc 插件的实时音视频通信应用。希望这对您有所帮助！