Flutter视频会议插件openvidu_client的使用

OpenVidu Flutter 客户端。

开始使用

首先，在你的 pubspec.yaml 文件中添加 openvidu_client 包依赖。

dependencies:
  openvidu_client: ^x.x.x

然后在 Dart 文件中导入 OpenViduClient：

import 'package:openvidu_client/openvidu_client.dart';

创建 OpenViduClient 实例

创建一个 OpenViduClient 实例，并传入 OpenVidu 服务器的 URL。

OpenViduClient client = OpenViduClient('https://your-openvidu-server-url.com');

启动本地预览

启动本地摄像头预览，并返回本地参与者对象。

LocalParticipant localParticipant = await client.startLocalPreview(context, StreamMode.frontCamera);

监听事件

配置监听器来接收由 OpenVidu 库发出的事件。记住要在 userJoined 和 userPublished 事件中订阅远程流。

void listenSessionEvents() {
  client.on(OpenViduEvent.userJoined, (params) async {
    await client.subscribeRemoteStream(params["id"]);
  });

  client.on(OpenViduEvent.userPublished, (params) {
    client.subscribeRemoteStream(params["id"], 
        video: params["videoActive"], 
        audio: params["audioActive"]);
  });

  client.on(OpenViduEvent.addStream, (params) {
    client.participants = {...client.participants};
    // 处理远程参与者的变化
  });

  client.on(OpenViduEvent.removeStream, (params) {
    client.participants = {...client.participants};
    // 处理远程参与者的变化
  });

  client.on(OpenViduEvent.publishVideo, (params) {
    client.participants = {...client.participants};
    // 处理远程参与者的变化
  });

  client.on(OpenViduEvent.publishAudio, (params) {
    // 处理远程参与者的变化
  });

  client.on(OpenViduEvent.updatedLocal, (params) {
    client.localParticipant = params['localParticipant'];
    // 更新本地参与者
  });

  client.on(OpenViduEvent.reciveMessage, (params) {
    // 接收消息
  });

  client.on(OpenViduEvent.userUnpublished, (params) {
    client.participants = {...client.participants};
    // 处理远程参与者的变化
  });

  client.on(OpenViduEvent.error, (params) {
    // 捕获错误信息
  });
}

发布本地流

加入房间并发布本地流。

Future<LocalParticipant> publishLocalStream(String token, String userName, Map<String, dynamic> extraData) async {
  return await client.publishLocalStream(token, userName, extraData);
}

LocalParticipant 类

shareScreen

切换流模式从摄像头到屏幕或反之。

Future<void> shareScreen() async {
  await localParticipant.shareScreen();
}

setAudioInput

通过设备 ID 替换音频输入轨道。

Future<void> setAudioInput(String deviceId) async {
  await localParticipant.setAudioInput(deviceId);
}

setVideoInput

通过设备 ID 切换视频输入源。

Future<void> setVideoInput(String deviceId) async {
  await localParticipant.setVideoInput(deviceId);
}

switchCamera

切换摄像头。

Future<void> switchCamera() async {
  await localParticipant.switchCamera();
}

unpublishAllTracks

禁用所有本地流的轨道。

Future<void> unpublishAllTracks() async {
  await localParticipant.unpublishAllTracks();
}

publishVideo

启用或禁用本地流的视频轨道。

Future<void> publishVideo(bool enabled) async {
  await localParticipant.publishVideo(enabled);
}

publishAudio

启用或禁用本地流的音频轨道。

Future<void> publishAudio(bool enabled) async {
  await localParticipant.publishAudio(enabled);
}

示例代码

以下是一个完整的示例代码：

import 'dart:io';

import 'package:flutter/material.dart';

import 'app/pages/connect_page.dart';
import 'app/utils/global_http_overrides.dart';
import 'theme/theme.dart';

void main() {
  HttpOverrides.global = GlobalHttpOverrides();
  WidgetsFlutterBinding.ensureInitialized();

  runApp(const App());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) => MaterialApp(
        title: 'OpenViduClient Flutter Example',
        theme: OpenViduTheme().buildThemeData(context),
        home: const ConnectPage(),
      );
}