本文档提供了小鱼易连 Web MeetingKit API 概览,该 API 专为快速构建多人会议场景设计。通过简洁易用的接口,开发者可以快速实现音视频会议、互动交流等功能。
uiMeetingKit
模块是小鱼易连Web MeetingKit提供的API全局总入口,依赖UI组件 XYMeetingKitComp,提供如下能力:
XYRTCClient
模块;import { uiMeetingKit, XYMeetingKitComp, XYMeetingSettingComp } from '@xylink/meetingkit';
uiMeetingKit
提供的方法如下:
方法 | 描述 |
初始化XYRTCClient实例,为 MeetingKit 提供实时音视频通话功能 | |
销毁当前的XYRTCClient实例 | |
获取XYRTCClient实例,可调用Web SDK相关方法 | |
离开当前会议 | |
退出当前登录状态,并断开与会议的连接 | |
发起会议呼叫 | |
注册监听事件,详见事件模块 | |
取消监听事件 | |
呼叫页面:播放背景音乐,防止浏览器策略限制无法播放音频 | |
功能可见性配置 | |
设置Web Meetingkit国际化语言 | |
无登录模式调用,需要在调用makeCall前配置已登录用户和网关信息 |
uiMeetingKit
提供的事件消息,开发者根据需求自行订阅监听,所有事件内容如下:
事件Key | 描述 |
挂断会议通知。收到此事件时,可根据需要更新UI,提示用户会议已结束 | |
登录状态。收到此事件时,可根据状态更新UI |
组件名称 | 描述 |
MeetingKit UI组件主体,用于展示和管理音视频会议界面的核心组件 | |
会前用于展示和调整会议相关的设置配置组件 |