@xylink/meetingkit v4.0.2

XYLink MeetingKit

项目介绍

XYLink MeetingKit 是小鱼易连音视频通讯的 Web 端 React MeetingKit，提供完整、方便快捷的多人音视频能力。

此项目使用到的技术栈：react+antd+zustand+tailwind+typescript

集成MeetingKit

如果需要在已有的React项目中集成MeetingKit，可以参考以下步骤：

1. 安装依赖

# 通过 Yarn 安装
$ yarn add @xylink/meetingkit

# 通过 Npm 安装
$ npm install @xylink/meetingkit

2. 创建client

import { uiMeetingKit, XYMeetingEventKey} from '@xylink/meetingkit';

const client = await uiMeetingKit.createClient({
  clientId: ACCOUNT.clientId,
  clientSecret: ACCOUNT.clientSecret,
  extId: ACCOUNT.extId,
  defaultServer: 'precloudapi.xylink.com'
});

// 监听退会事件，做相应处理
 uiMeetingKit.on(XYMeetingEventKey.DISCONNECTED, disconnected);

3. 登录

await client.loginExternalAccount({
  extUserId: '',
  displayName: '',
});

4. 加入会议

import { uiMeetingKit } from '@xylink/meetingkit';

await uiMeetingKit.makeCall({
  confNumber: '188188',
  password: '',
  displayName: '',
  // 入会是否是自动静音
  muteAudio: false,
  // 入会是否是关闭摄像头
  muteVideo: false,
});

5. 引入MeetingKit

提示： 调用makeCall时，显示XYMeetingKitComp组件，可自己通过状态通知显示隐藏，也可以通过传递visible属性控制显示隐藏

import { XYMeetingKitComp } from '@xylink/meetingkit';

const App = () => {
  return <XYMeetingKitComp />;
};

export default App;

示例项目

GitHub 上提供了React框架的示例项目供参考

Changelog

0.1.0 (2024-10-21)

✨ Features | 新功能

• 新增会议功能