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

编辑周期子会议

接口功能

该接口用于编辑周期子会议。注意事项:1、该接口在已登录状态下才能调用。2、该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。

函数原型

modifySubCycleConf(modifySubCycleConfParam: ModifySubCycleConfParam, onModifySubCycleConfResult?: (ret: SDKERR, reason: string) => void): void

请求参数

表1 入参说明
参数名称 是否必选 参数类型 参数说明
modifySubCycleConfParam Y ModifySubCycleConfParam 编辑周期会议的参数体
onModifySubCycleConfResult Y (ret: SDKERR, reason: string) => void 编辑周期子会议的结果回调
表2 ModifySubCycleConfParam
参数名称 是否必选 参数类型 参数说明
confId Y string 会议id
subConfID Y string 子会议唯一标识UUID
mediaType Y MediaType 会议类型。
startTime N number 会议开始时间(UTC时间),单位为秒。
duration Y number 会议持续时长,单位分钟
isAutoRecord N boolean 是否开启自动录制会议。开启自动录制会议开关,内部会默认支持录制会议,录制会议开关的打开与关闭并不影响。 说明:仅对云录制生效,客户端本地录制不生效。
recordAuthType N RecordAuthType 录播鉴权方式
confAllowJoinUser N ConfAllowJoinUserType 允许入会范围限制。默认所有用户。
allowGuestStartConf N boolean 允许来宾启动会议
allowGuestStartConfTime N number 允许来宾提前入会时间范围(单位:分钟) 0-随时,n-提前n分钟启动会议
表3 MediaType枚举说明
枚举名称 枚举值 枚举说明
HWM_MEDIA_TYPE_AUDIO 0 音频类型
HWM_MEDIA_TYPE_VIDEO 1 视频类型
表4 RecordAuthType枚举说明
枚举名称 枚举值 枚举说明
REOCRD_AUTH_TYPE_ANYONE 0 可通过连接观看/下载(不拼接nonce)
REOCRD_AUTH_TYPE_IN_COMPANY_USER 1 企业用户可观看/下载
REOCRD_AUTH_TYPE_ATTENDEE 2 与会者可观看/下载
表5 ConfAllowJoinUserType枚举说明
枚举名称 枚举值 枚举说明
CONF_ALLOW_JOIN_ANYONE 0 所有用户。
CONF_ALLOW_JOIN_LOGINED_USER 1 已登录用户。
CONF_ALLOW_JOIN_IN_COMPANY_USER 2 企业内用户。
CONF_ALLOW_JOIN_INVITED_USER 3 被邀请用户。

返回值

void

回调方法参数说明:

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

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