1.0.2 • Published 13 days ago
xverse-components-voice-meeting v1.0.2
API
| 参数名 | 类型 | 说明 | 默认值 | 是否必填 | 备注 | ||
|---|---|---|---|---|---|---|---|
| groupIdObj | IGroupId | 会议组 ID | - | true | static:ID 与主持人由后端指定； dynamic：主持人后端指定，ID 前端自定义；dynamicNotCheck 前端可自定义；privateChat 配置内容可传入空字符串，固定使用用户 ID | ||
| createGroupType | GroupType | 会议类型 | dynamic | true | static: 静态会议(后端创建)没主持人也可加入会议；主持人结束会议仅踢掉当前与会人员，不销毁会议 | dynamic: 动态会议(后端会校验，需要把主持人账号提供给后端)，需要配置 userIdentityType | 'dynamicNotCheck': 所有用户可开启，第一个开启用户即主持人 |
| userIdentityType | string | 特殊用户身份类型仅 dynamic 需要配置 | - | false | 主持人:1; 嘉宾:2;其他不配 | ||
| receiverId | string | 私聊接收者 的 userID | - | false | - | ||
| maxLimit | number | 单个会议组支持最大加入人数 | - | true | 0：表示不限制（固定最大可开麦人数 8 人） | ||
| needApply | boolean | （非 static 类型的会议）是否需要申请才可开启麦克风权限 | true | true | 选择 true，仅首次需要申请（后端目前处理是首次需要申请） | ||
| needTip | boolean | 是否需要 tips 提示 | true | true | 各种交互完成后的 tip 提示 | ||
| memberSecondPopIsCard | boolean | 成员界面的二级界面是否使用卡包信息，所有用户可展示 | - | false | - | ||
| isExternalIcon | boolean | 是否外置 icon 按钮 | - | true | show 时即响应点击事件。无需配置 icon，不会生效 | ||
| icon | CSSProperties | 大厅上 icon 图标样式 | - | false | - | ||
| iconClassName | string | 自定义 大厅上 icon 的 css | - | false | 与 icon 配置可能存在冲突，如果两个都配置的话，都使用，但是部分 class 中的样式会被 icon 重置 | ||
| zIndex | string | 设置语音主界面层级 | - | false | - | ||
| metaverseName | string | 项目名称 | - | false | 用于主持人授权麦克风提示 | ||
| createConfirmModal | IModalProps | 创建/加入 语音组的确认弹框 | - | false | 如果不填，按钮点击后，直接加入会议；如果主持人有特殊表现，需要配置两个（在 show 中添加不同的条件） | ||
| destroyConfirmModal | IModalProps | 销毁语音组的确认弹框 | - | false | 如果不填，按钮点击后，直接销毁会议【此弹框的按钮比较特殊，OK 表示销毁，cancel 表示离开，''表示仅关闭弹框】 | ||
| otherConfirmModal | IModalProps | 其他确认弹框（由事件触发） | - | false | 如果不填，则不展示 | ||
| userActionBar | IContainerProps | 用户操作栏 | - | false | 操作栏的样式（指主体：UI 中的长方形底部条） | ||
| userActionItemList | IActionItemProps[] | 操作条功能配置 | - | false | - | ||
| talkUserBar | IContainerProps | 讲话的用户展示栏 | - | false | - | ||
| talkUserItemList | ITalkItemProps[] | 说话用户配置 | - | false | - | ||
| meetingShare | ISharePosterConfig | 分享 | - | false | - | ||
| isMeetingShow | boolean | 自定义显隐。针对私聊（通用必须保持 true） | - | false | 有私聊时，存在未加入语音时的弹框 | ||
| onNext | () => void | 关闭组件后执行下一步，其他事件不需做关闭相关的处理 | - | false | - | ||
| onShowVoiceMeetingPanel | () => void | 显示语音界面之后的执行 | - | false | 外部可监听后处理自定义逻辑 | ||
| onEndVoiceMeeting | () => void | 销毁语音界面之后的执行（主持人） | - | false | 外部可监听后处理自定义逻辑 | ||
| onLeaveVoiceMeeting | () => void | 离开语音界面之后的执行 | - | false | 外部可监听后处理自定义逻辑 | ||
| onKickOut | () => void | 被踢出语言会议，主持人踢出 或 会议解散 | - | false | 外部可监听后处理自定义逻辑 | ||
| onShowSharePanel | () => void | 点击分享按钮的事件【分享卡片】 | - | false | 外部可监听后处理自定义逻辑 | ||
| onEndScreenShare | () => void | 结束投屏分享的事件【分享卡片】 | - | false | 外部可监听后处理自定义逻辑 | ||
| onChangeToHoster | () => void | 身份变更【变成主持人】 | - | false | 外部可监听后处理自定义逻辑 | ||
| onChangeToSpecialGuest | () => void | 身份变更【变成嘉宾】 | - | false | 外部可监听后处理自定义逻辑 | ||
| onChangeToListener | () => void | 身份变更【变成听众】 | - | false | 外部可监听后处理自定义逻辑 | ||
| onEnterPrivateChat | (receiverId: string) => void | 退出发起私聊邀请 | - | false | - | ||
| onJoinPrivateChat | () => boolean | - | false | - |