描述: 获取外部用户信息的回调接口
版本支持: v3.8.0、v3.9.1
接口概述: 获取外部用户信息的回调,仅当enableExtraUserInfo设置为true时生效
接口定义:
virtual XYExtraUserInfo meetingWindowUpdateExtraUserInfo(const QString& extUserId) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
extUserId | QString | 是 | 无 | 外部用户ID |
返回值:
XYExtraUserInfo 对应用户信息
版本支持: v3.8.0、v3.9.1
接口概述: 设置白板保存图片的路径
接口定义:
virtual bool setWhiteBoardSavePath(const QString& path) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
path | QString | 是 | 无 | 路径 |
返回值:
返回true表示调用成功,false表示调用失败
版本支持: v3.8.0、v3.9.1
接口概述: 设置邀请链接是否显示
接口定义:
virtual bool setInviteVisible(bool bVisible) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
bVisible | bool | 是 | 无 | true显示,false不显示 |
返回值:
返回true表示调用成功,false表示调用失败
版本支持: v3.8.0、v3.9.1
接口概述: 设置邀请链接的链接内容(同时配置邀请链接和小i里面的)
接口定义:
virtual bool setInviteLink(const QString& strInviteLink) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
strInviteLink | QString | 是 | 无 | 链接 |
返回值:
返回true表示调用成功,false表示调用失败
版本支持: v3.8.0、v3.9.1
接口概述: 设置邀请链接的链接是否显示(同时配置邀请链接和小i里面的)
接口定义:
virtual bool setLinkVisible(bool bVisible) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
bVisible | bool | 是 | 无 | true显示,false不显示 |
返回值:
返回true表示调用成功,false表示调用失败
版本支持: v3.8.0、v3.9.1
接口概述: 录制入口的显示
接口定义:
virtual bool setRecordVisilbe(bool bVisible) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
bVisible | bool | 是 | 无 | true显示,false隐藏 |
返回值:
返回true表示调用成功,false表示调用失败
版本支持: v3.8.0、v3.9.1
接口概述: 设置遥控按钮的入口
接口定义:
virtual bool setRemoteContralCameraBtnVisible(bool bVisible) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
bVisible | bool | 是 | 无 | true显示,false隐藏 |
返回值:
返回true表示调用成功,false表示调用失败
版本支持: v3.8.0、v3.9.1
接口概述: 设置键盘入口的显示隐藏
接口定义:
virtual bool setKeyBoardBtnVisible(bool bVisible) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
bVisible | bool | 是 | 无 | true显示,false隐藏 |
返回值:
返回true表示调用成功,false表示调用失败
版本支持: v3.8.0、v3.9.1
接口概述: 设置标题栏显示的内容
接口定义:
virtual bool setMeetingTitle(const QString& strTitle) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
strTitle | QString | 是 | 无 | 标题 |
返回值:
返回true表示调用成功,false表示调用失败
版本支持: v3.8.0、v3.9.1
接口概述: 设置自定义虚拟背景上传图片接口
接口定义:
virtual bool setAIVirtualBGSelfUpload(bool bVisible) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
bVisible | bool | 是 | 无 | 显示隐藏 |
返回值:
返回true表示调用成功,false表示调用失败
版本支持: v3.8.0、v3.9.1
接口概述: 设置摄像头是否打开镜像
接口定义:
virtual bool setCameraIsFilp(bool bFilp) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
bFilp | bool | 是 | 无 | 是否翻转 |
返回值:
返回true表示调用成功,false表示调用失败
版本支持: v3.8.0、v3.9.1
接口概述: 设置自定义按钮得文本
接口定义:
virtual void setCustomizeBtnText(const QString& strBtnText) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
strBtnText | QString | 是 | 无 | 显示文本,5个字以内 |
版本支持: v3.8.0、v3.9.1
接口概述: 设置会控地址
接口定义:
virtual void setMeetingControlUrl(const QString& strUrl) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
strUrl | QString | 是 | 无 | 会控地址 |
版本支持: v3.8.0、v3.9.1
接口概述: 设置透传给h5的参数主持按钮是否显示的参数
接口定义:
virtual bool showHostMeetingBtn(bool bVisible) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
bVisible | bool | 是 | 无 | 是否显示主持按钮 |
返回值:
返回true表示调用成功,false表示调用失败
版本支持: v3.8.0、v3.9.1
接口概述: 设置透传给h5跳转的主持页面的url
接口定义:
virtual bool setHostMeetingUrl(const QString& strHostUrl) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
strHostUrl | QString | 是 | 无 | 跳转地址 |
返回值:
返回true表示调用成功,false表示调用失败
版本支持: v3.8.0、v3.9.1
接口概述: 是否开启字幕回调
接口定义:
virtual void enableSubtitles(bool enable) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
enable | bool | 是 | 无 | 是否开启 |
版本支持: v3.8.0、v3.9.1
接口概述: 查询转写功能是否开启
接口定义:
virtual bool isAICaptionEnabled() = 0;
返回值:
返回字幕是否开启
版本支持: v3.8.0、v3.9.1
接口概述: 是否获取外部用户信息(获取外部用户头像、工号...)
接口定义:
virtual bool enableExtraUserInfo(bool enable, XYMeetingWindowUpdateExtraUserInfoCallback* callback = nullptr) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
enable | bool | 是 | 无 | 是否可用 |
callback | 否 | nullptr | 更新外部用户信息的回调 |
返回值:
返回功能开启结果,true表示成功,false表示失败
版本支持: v3.9.1
接口概述: web开启调试模式
接口定义:
virtual void enableWebviewDebug(bool enable) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
enable | bool | 是 | 无 | 是否开启 |
返回值:
返回功能开启结果,true表示成功,false表示失败
版本支持: v3.8.0、v3.9.1
接口概述: 窗口关闭
接口定义:
virtual void closeWindow(XYMeetingWindowCloseForm form) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
form | 是 | 无 | 关闭方式 |
版本支持: v3.8.0、v3.9.1
接口概述: 收到邀请
接口定义:
virtual void onMeetingInvited(const QString& displayName, const XYCallInfo& callInfo, bool videoMute, bool audioMute) = 0;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
displayName | QString | 是 | 无 | 用户名称 |
callInfo | 是 | 无 | 来点信息 | |
videoMute | bool | 是 | 无 | 是否关闭视频 |
audioMute | bool | 是 | 无 | 是否关闭音频 |