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

会控操作

setConfConfig

接口描述

进行会控操作

注意事项

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

方法定义

1
setConfConfig(config):Promise<Result>

相关事件

会控状态变更通知

参数描述

表1 参数说明

参数

是否必须

类型

描述

config

js 对象 {"key": value}

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

表2 confConfig对象说明

key

value类型

描述

audioMute

boolean

设置麦克风是否静音 (注意:不支持并行调用麦克风和摄像头)。 true: 静音; false: 取消静音

videoMute

boolean

设置摄像头是否打开(注意:不支持并行调用麦克风和摄像头)。 true: 关闭; false: 打开

speakerMute

boolean

设置扬声器是否静音。 true: 静音; false: 取消静音

volume

number

设置扬声器音量,手机微信浏览器不支持该配置。 取值范围: 0-100

handUp

boolean

举手/手放下操作。 true: 举手; false: 手放下

shareScreen

boolean

共享/取消共享屏幕操作,手机微信浏览器不支持该配置。true: 共享屏幕; false: 取消共享屏幕

userName

string

设置自身与会者名称。最大长度 64 个字符

调用此接口时,只传入需要修改的key值即可。如需举手时,只需传入:{"handUp": true}

返回值

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

示例代码

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
// 共享屏幕
let params = {shareScreen: true};
HWMeeting.setConfConfig(params).then(() => {
      // 调用成功
      ...      
    }).catch((e) => {
      // 调用失败
      ...
    });
}
分享:

    相关文档

    相关产品