更新时间:2024-07-30 GMT+08:00

功能配置开关

接口功能

该接口用于修改会议相关功能配置开关。注意事项:1、枚举中的功能项均有默认值,若对开关状态不做要求,可以不必调用该接口。

函数原型

enableCapability(capabilityInfo: CapabilityInfo, onEnableCapabilityResult?: (ret: SDKERR, reason: string) => void): void

请求参数

表1 入参说明
参数名称 是否必选 参数类型 参数说明
capabilityInfo Y CapabilityInfo 功能配置信息
onEnableCapabilityResult Y (ret: SDKERR, reason: string) => void 功能开关配置接口回调
表2 CapabilityInfo
参数名称 是否必选 参数类型 参数说明
type Y CapabilityType 功能类型
isEnable Y boolean 开启状态
表3 CapabilityType枚举说明
枚举名称 枚举值 枚举说明
HWM_CAPABILITY_TYPE_SHOW_HANGUP_ATTENDEE 0 显示离会与会者开关(仅对win平台生效)
HWM_CAPABILITY_TYPE_HIDE_EXTERNAL_LABEL 1 隐藏外部标签
HWM_CAPABILITY_TYPE_RESOLUTION_1080P 2 1080P开关(仅对win平台生效)
HWM_CAPABILITY_TYPE_RESOLUTION_720P 3 720p开关(仅对mac平台生效)
HWM_CAPABILITY_TYPE_MULTI_MONITOR 4 多显示器模式开关(仅对win平台生效)
HWM_CAPABILITY_TYPE_HOWLING_DETECTION 5 啸叫检测开关(仅对win平台生效)
HWM_CAPABILITY_AUTO_MIC_VOLUME 6 自动调节麦克风音量开关(仅对win平台生效)
HWM_CAPABILITY_SHARE_AUDIO 7 共享音频开关
HWM_CAPABILITY_HIDE_NO_CAMERA_VIEW 8 隐藏非视频与会者开关(仅对mac平台生效)
HWM_CAPABILITY_BREAKOUT_CONF 9 分组讨论开关
HWM_CAPABILITY_CONFIRM_RECORD 10 录制确认
HWM_CAPABILITY_SUPPORT_DISCONNECT_AUDIO 12 支持断开音频功能(仅对win平台生效)
HWM_CAPABILITY_DISCONNECT_AUDIO_TO_JOIN_CONF 13 是否断开音频入会(仅对win平台生效)
HWM_CAPABILITY_CPU_REDUCTION_DETECT 14 是否启用CPU降频检测(仅对win平台生效)
HWM_CAPABILITY_SUPPORT_GUEST_INVITE 16 是否支持与会者邀请

返回值

void

回调方法参数说明:

(ret: SDKERR, reason: string) => void

表4 入参说明
参数名称 参数类型 参数说明
ret SDKERR 请参考错误码参考 错误码
reason string 错误描述