小鱼易连Web MeetingKit包含详细的TypeScript类型定义，以便开发者能够在您的TypeScript项目中轻松使用；
通过主模块导入TypeScript相关的Class、Interface、Enum、Type等类型定义，举例如下：
import { XYMeetingKitConfig, XYMeetingEventKey , ... } from '@xylink/meetingkit';
枚举类型定义如下：
会议底部操作按钮位置
Key | 值 | 描述 |
LEFT | left | 左侧区域：通常放置音频、视频等核心功能按钮 |
MIDDLE | middle | 中间区域：放置共享、录制、参会者等主要功能按钮 |
RIGHT | right | 右侧区域：放置结束会议等重要操作按钮 |
会议底部操作按钮优先级
提示
MeetingKit 在 PC 端会根据会中容器宽度自动调整按钮的显示与隐藏。
当水平空间不足时，按钮将按照此参数设定的优先级顺序，依次被隐藏到“更多”按钮的二级菜单中。
Key | 值 | 描述 |
MUST_SHOW | 0 | 必须显示：无论窗口大小如何，这些按钮始终显示在主工具栏，永远不会被隐藏到二级菜单 |
HIGH | 1 | 高优先级：空间不足时，这些按钮最后被隐藏到二级菜单，显示优先级仅次于 MUST_SHOW 按钮 |
MEDIUM | 2 | 中等优先级：空间不足时，这些按钮在 HIGH 优先级之后被隐藏到二级菜单 |
LOW | 3 | 低优先级：空间不足时，这些按钮最先被隐藏到二级菜单 |
事件
Key | 值 | 描述 |
DISCONNECTED | disconnected | 离开会议 |
PERMISSION_DENIED | permission-denied | 无权限 |
LOGIN_STATE | login-state | 登录状态 |
国际化语言
值 | 描述 |
en_US | 英文 |
zh_CN | 中文简体 |
zh_TW | 中文繁体 |
会议底部操作按钮配置
提示
Meetingkit默认按钮配置参考文档。
Key | 值 | 描述 |
key | string | 必须，按钮唯一标识 |
label | string | ReactNode | 可选，按钮文案 |
icon | string | ReactNode | 可选，按钮图标 |
position | 可选，按钮位置 | |
className | string | 可选，按钮自定义样式类 |
order | boolean | 可选，按钮显示顺序 |
show | boolean | 可选，按钮是否显示 |
priority | 可选，按钮隐藏优先级 | |
defaultHidden | boolean | 可选，是否默认隐藏到更多菜单中 |
closeParentDialog | boolean | 可选，是否关闭父级弹框 |
popover | 可选，按钮气泡卡片 | |
onClick | (context: any) => void | Promise | 可选，按钮点击回调事件 |
功能可见性配置
Key | 值 | 描述 |
enablePip | boolean | 是否启用画中画功能，默认为 true |
enableVirtualBackground | boolean | 是否启用虚拟背景功能，默认为 false |
enableIM | boolean | 是否启用聊天功能，默认为 true |
enableWhiteboard | boolean | 是否启用白板功能，默认为 true |
enableAnnotation | boolean | 是否启用批注功能，默认为 true |
enableVersionInfo | boolean | 是否显示版本信息功能，默认为 true |
enableShareContent | boolean | 是否启用分享内容功能，默认为 true |
enableInvite | boolean | 是否启用邀请功能，默认为 true |
enableConferenceLink | boolean | 是否启用会议链接功能，默认为 true |
会议断开连接结果
Key | 值 | 描述 |
code | string | 错误码 |
detail | string | 错误详情描述 |
message | string | 断开连接提示信息 |
accountExpired | string | 账号是否失效，会议断开原因导致账号失效，如账号在其他设备登录、被拉黑等 |
reason | string | 断开连接原因 |
meetingKit 配置参数
Key | 值 | 描述 |
isPrivate | boolean | 可选，是否是分区云环境, 默认分区云环境 |
isMobile | boolean | 可选，是否是移动端，默认为false |
version | string | 可选，版本号，默认为空 |
extends IClientConfig | Web SDK 初始化XYClient配置参数 |
设置弹框组件的属性配置
Key | 值 | 描述 |
options | SettingOptions | 可选，设置功能配置项 |
showAllOptions | boolean | 可选，是否显示所有配置项，默认为false |
visible | boolean | 可选，是否显示设置弹框，默认为false |
onVisibleChange | (visible: boolean) => void | 设置弹框显示状态变更的回调函数 |
onCancel | () => void | 关闭设置弹框的回调函数 |
onChange | (data: { [key in SettingConfigKey]?: any }) => void | 设置功能配置项变更的回调函数 |
卡片/提示框
Key | 值 | 描述 |
extends PopoverProps | 可选，Antd PopoverProps | |
type | 'popover' | 'tooltip' | 可选，类型 |
mode | 'dark' | 'light' | 可选，主题 |
size | 'large' | 'middle' | 'small' | 可选，大小 |
attachToParent | boolean | 可选，是否挂载在父节点，默认为true |
children | ReactNode | 可选，内容, 最外层仅支持原生html标签 |
isMobile | boolean | 可选，是否是移动端，默认为false |
设置功能配置项
Key | 值 | 描述 |
common | boolean | SettingCommonOptions | 可选，是否显示通用配置项，默认为true |
device | boolean | 可选，是否显示设备设置项，默认为true |
hotkey | boolean | 可选，是否显示快捷键设置项，默认为true |
feedback | boolean | 可选，是否显示反馈设置项，默认为true |
about | boolean | 可选，是否显示关于设置项，默认为true |
server | boolean | 可选，是否显示服务器设置项，默认true |
通用配置项
Key | 值 | 描述 |
localHide | boolean | 可选，是否显示隐藏本地画面配置项，默认为true |
inFullScreen | boolean | 可选，是否显示全屏加入会议配置项，默认为false |
preview | boolean | 可选，是否在移动端显示快速入会时预览本地画面配置项，默认为false |
joinNow | boolean | 可选，是否在桌面端显示立即加入会议配置项，默认为false |
speakerName | boolean | 可选，是否显示正在讲话人配置项，默认为true |
isLowResolution | boolean | 可选，是否显示节能模式配置项，默认为true |
layoutMode | boolean | 可选，是否显示自动/自定义布局切换配置项，默认false |
loginType | boolean | 可选，是否显示登录模式切换配置项，默认为false |
bandwidth | boolean | 可选，是否显示启用带宽配置项，默认为false |
enableLocalShareConfig | boolean | 可选，是否显示本地共享设置配置项，默认为false |
enableVirtualBackground | boolean | 可选，是否显示启用虚拟背景配置项，默认为false |