检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
是否需要来宾密码。默认不需要来宾密码(仅对随机会议ID生效)。 isAutoRecord N boolean 会议自动录制开关。默认不开启。 开启会议自动录制开关,内部会默认支持录制会议,录制会议开关的打开与关闭并不影响。 说明:仅对云录制生效,客户端本地录制不生效。 allowRecord N boolean
订阅个人角色变化通知 接口功能 收到该通知时,表示个人角色发生变化(仅对mac平台生效)。 函数原型 setOnSelfRoleChangedCB(onSelfRoleChanged: (role: ConfRole) => void): void 请求参数 表1 入参说明 参数名称
该接口用于设置水印自定义内容注入,若未进行设置,将默认使用内部优先级来展示水印内容。注意事项:1、该接口必须在会前调用,会中调用不会即时生效;2、企业级水印开关未打开的场景下,水印自定义内容注入也不会生效。 函数原型 setWaterMark(waterMarkInfo: WaterMarkInfo, onSetWaterMarkResult
是否需要来宾密码。默认不需要来宾密码(仅对随机会议ID生效)。 isAutoRecord N boolean 会议自动录制开关。默认不开启。 开启会议自动录制开关,内部会默认支持录制会议,录制会议开关的打开与关闭并不影响。 说明:仅对云录制生效,客户端本地录制不生效。 allowRecord N boolean
uiConfig 是 string Json对象字符串"{"frame":object}", object对象有格式要求,若不匹配则配置不生效。详细规则见下表2、表3、表4、表5。 表2 frame对象介绍 key value类型 描述 name string 会议窗口名称。如图1中的窗口名称(MyApp)。
isOpenWaitingRoom 否 bool 等候室开启开关 说明: 需要等候室功能开通后才能生效 allowGuestStartConf 否 bool 是否允许来宾提前启动会议。 说明: 仅针对随机会议ID的会议生效。 固定会议ID的会议,请使用修改云会议室信息接口设置。 allowGuestStartConfTime
是否开启自动录制会议。开启自动录制会议开关,内部会默认支持录制会议,录制会议开关的打开与关闭并不影响。 说明:仅对云录制生效,客户端本地录制不生效。 recordAuthType number 录播鉴权方式 0:可通过连接观看/下载(不拼接nonce)1:企业用户可观看/下载 2:与会者可观看/下载。 callInRestriction
会中复制链接前缀定制 接口描述 定制会议信息窗口中分享的会议链接前缀。 注意事项 必须调用setConfInfoHandler设置,定制才会生效。 方法定义 1 linkPrefix?: string; 参数描述 类型 描述 string 会议链接前缀。 父主题: 社交分享定制
String 会议中的显示名称,匿名入会下生效。 open_mic 否 String 是否开启麦克风,true开启,false关闭,不填默认关闭。 open_camera 否 String 是否开启摄像头,true开启,false关闭,不填默认关闭。 若希望以主持人身份入会,en
定制复制会议信息点击事件。 使用场景 图1 复制会议信息点击事件定制 注意事项 必须调用setConfInfoHandler设置,定制才会生效。 方法定义 1 copyGuestConfInfo?: ConfInfoCopyInterface; 参数描述 类型 描述 ConfInfoCopyInterface
获取自己会中角色 接口功能 该接口用于获取自己会中角色(仅对mac平台生效) 函数原型 getSelfRole(onGetSelfRoleResult?: (ret: SDKERR, reason: string, selfRole: ConfRole) => void): void
获取用户保存路径 接口功能 该接口用于获取用户文件(包括本地录制文件)的保存路径。(仅对win平台生效) 函数原型 getUserSavePath(pathType: SavePathType, onGetUserSavePathResult?: (ret: SDKERR, reason:
图1 自定义水印 注意事项 该接口必须在会前调用,会中调用不会即时生效。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 企业级水印开关未打开的场景下,水印自定义内容注入也不会生效。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
audienceJoinUri string 观众加入会议的链接(仅对win平台生效) confStateType ConfState 会议状态(仅对win平台生效) isWebinar boolean 是否是网络研讨会(仅对win平台生效) selfConfRole ConfRole 本人在会议中的角色
订阅用户数据路径变化通知 接口功能 收到该通知时,表示用户数据路径发生变化。(仅对Windows平台生效) 函数原型 setOnUserSavePathChangedCB(onUserSavePathChanged: (userSavePathInfo: UserSavePathInfo)
参数说明 参数 是否必须 类型 描述 config 是 js 对象 {"key": value} value 有类型要求,若不匹配则配置不生效。详细规则见下表2 表2 confConfig对象说明 key value类型 描述 audioMute boolean 设置麦克风是否静音
audienceJoinUri string 观众加入会议的链接(仅对win平台生效) confStateType ConfState 会议状态(仅对win平台生效) isWebinar boolean 是否是网络研讨会(仅对win平台生效) selfConfRole ConfRole 本人在会议中的角色
自定义会议窗口任务栏图标 接口功能 该接口用于设置会议窗口任务栏图标信息(仅对mac平台生效),win平台可以通过替换HwmSdk\sdkResources\nativeimg目录下的video.ico图标文件实现。 函数原型 setMeetingWindowIcon(windowIconInfo:
定制会中会控栏界面,支持会控栏菜单中菜单项的增减和自定义菜单项。 使用场景 图1 会控栏自定义菜单 注意事项 必须调用setConfCtrlHandler设置,定制才会生效。 方法定义 1 confCtrlMenu?: ConfCtrlMenuArray; 参数描述 类型 描述 ConfCtrlMenuArray
recordAuxStream 否 Integer Body 是否录制辅流,在录播类型为:录播、录播+直播时有效。默认只录制视频主流,不录制辅流。 0:不录制 1:录制 confConfigInfo 否 ConfConfigInfo object Body 会议其他配置信息。 recordAuthType