更新时间:2024-01-24 GMT+08:00
分享

设置视图显示

注意事项

请在调用加入会议接口后再调用此接口。

接口描述

Web SDK中已经提供了会议中的界面,界面上的部分元素是否显示通过该接口配置。

图1 会议窗口的显示控制

如图上图所示,当前SDK支持的窗口显示控制包含:

1. 窗口标题栏

2. 聊天框

3. 与会者列表

4. 会控条

5. 弹幕组件

  • 会议分享链接

会议分享链接的域名前缀默认是https://bmeeting.huaweicloud.com/(如https://bmeeting.huaweicloud.com/#/j/982989574),如果入会Portal是第三方自己开发的,这个前缀需要自定义。

图2 会议信息

如上图所示, 点击标题栏可出现会议基本信息。可以自定义嘉宾入会信息和观众入会信息的两个二维码对应的URL。

注意事项

1)只有需要更改会议界面默认显示样式时,才需要调用该接口,若默认样式已满足要求,可以不调用该接口。

2)该接口需再收到入会结果通知事件后才能成功调用。

方法定义

1
setViewConfig (config):Promise<Result>

相关事件

会议视图显示变化通知

参数描述

表1 参数说明

参数

是否必须

类型

描述

config

js 对象 {"key": value}

value 有类型要求,若不匹配则配置不生效。详细规则见下表2

表2 config对象说明

key

value类型

描述

titleVisible

boolean

显示或隐藏窗口标题栏。 true: 显示; false: 隐藏

attendeeListVisible

boolean

显示或隐藏与会者列表。 true: 显示; false: 隐藏

chatVisible

boolean

显示或隐藏聊天框。 true: 显示; false: 隐藏

bulletScreenVisible

boolean

显示或隐藏弹幕组件。 true: 显示; false: 隐藏

controlBarVisible

boolean

显示或隐藏会控条。 true: 显示; false: 隐藏

viewMode

string

设置视图模式,手机微信浏览器不支持该配置。"speaking": 演讲者视图;"gallery": 画廊视图;"single": 单画面视图

说明:

单画面视图: 视图仅展示一个视频画面,有会议操作时会进行切换:

广播时会展示为被广播的画面;

有共享时展示为共享的画面;

选看某人时展示为选看的画面。

guestSharingUrl

string

设置嘉宾分享链接。最大长度为256个字符

audienceSharingUrl

string

设置观众分享链接。最大长度为256个字符

leaveUrl

string

设置离会跳转链接(该链接需要支持X-Frame-Options)。

stopRecordTip

JsonString

设置停止录制提示语 。

格式为:

[

{

"content": "录制结束后,会议预订人可在",

"type": "text"

},

{

"href": "https://XXX",

"target": "_black",

"content": "个人会议管理平台-我的录制",

"type": "href"

},

{

"content": "中查看录制文件",

"type": "text"

}

]

type: text 文本类型

href 超链接

target: 取值为a标签中target的取值

content: 内容

调用此接口时,只传入需要修改的key值即可。如需隐藏标题栏时,只需传入:{"titleVisible": false}

返回值

Result的结构参考9.7.1返回结构参考-表1 Result 对象参数说明,Error结构参考9.7.1返回结构参考-表3 Error对象参数说明

示例代码
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
/**
* 设置视图显示
*/
let params = {titleVisible:true}
HWMeeting.setViewConfig(params).then(() => 
    //  TODO:设置相关显示
    }).catch((e) => {
     // 显示结果
   console.log(e.retCode+":"+e.retMsg);
    }
);
分享:

    相关文档

    相关产品