本文档介绍小鱼易连Web MeetingKit 包含的UI组件,帮助用户快速实现音视频会议。
在项目根目录,将 MeetingKit 的 CSS 文件引入项目。提供两种引入方式:
如果项目使用 TailwindCSS,可通过以下方式引入。同时,可在文件中修改 CSS 变量以致实现自定义风格:
import '@xylink/meetingkit/css/xy_var.css';
import '@xylink/meetingkit/css/xy_base.css';
如果项目中未使用 TailwindCSS,可通过以下方式引入完整格式文件:
import '@xylink/meetingkit/css/style.css';
MeetingKit UI 主体组件,用于展示和管理音视频会议界面的核心组件。
<XYMeetingKitComp visible={true} ... />
属性
属性 | 类型 | 描述 | 兼容 |
visible | boolean | 可选,是否显示会议组件,默认为 建议在呼叫前将此参数配置为 | - |
footer | (() => React.ReactNode) | React.ReactNode | 可选,自定义底部插槽 | - |
详情
XYMeetingKitComp
组件是用于展示和管理会议界面的核心组件,主要用于渲染会议过程中涉及的不同界面,如呼叫界面、等候室界面、会议界面等。该组件可以与 uiMeetingKit
实例协同工作,提供实时音视频通话功能。
makeCall
前,再渲染此组件,或者通过visible
属性控制显示/隐藏uiMeetingKit.createClient
设置参数 isMobile
,支持移动端和PC端提示
XYMeetingKitComp组件中,弹框是基于window
窗口位置居中显示
会前用于展示和调整会议相关的设置配置。
<XYMeetingSettingComp visible={true} ... />
属性
属性 | 类型 | 描述 | 兼容 |
visible | boolean | 可选,是否显示设置弹框,默认为false | - |
options | SettingOptions | 可选,设置功能显示配置项 | - |
showAllOptions | boolean | 可选,是否显示所有配置项,默认为false | - |
onVisibleChange | (visible: boolean) => void | 设置弹框显示状态变更的回调函数 | - |
onCancel | () => void | 关闭设置弹框的回调函数 | - |
onChange | (data: { [key in SettingConfigKey]?: any }) => void | 设置功能配置项值改变的回调函数 | - |
详情
XYMeetingSettingComp
组件用于提供会前的设置调整功能,允许用户进行常规设置、设备设置和服务器设置等配置,帮助用户在会议开始前配置相关参数。
uiMeetingKit.createClient
设置参数 isMobile
,支持移动端和PC端,移动端和PC端展示的设置内容有所不同