编辑会议
EditConf
接口描述
该接口用于编辑已预约的会议。
注意事项
- 该接口在已登录状态下才能调用。
- 调用该接口时,仅能编辑尚未开始的会议,若会议已召开,接口将返回失败。
- 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。
- 所有字段必填,编辑会议前需要查询会议详情,不需要变更的数据请使用查询会议详情返回的数据赋值。
方法定义
1
|
HWM_SDK_AGENT_API hwmsdk::HwmErrCode EditConf(const HwmEditConfParam *confParam); |
回调函数
1
|
virtual void OnEditConfResult(hwmsdk::HwmErrCode ret, const char* reason) {}; |
参数描述
参数 |
是否必须 |
类型 |
描述 |
---|---|---|---|
confId |
是 |
char[] |
会议ID。 |
subject |
是 |
char[] |
会议主题。 |
startTime |
是 |
long long |
会议开始时间时间戳(utc时间),second。 |
duration |
是 |
int |
会议时长,minute。 |
confType |
是 |
会议类型。默认视频会议。 |
|
isNeedConfPwd |
是 |
bool |
是否需要密码。默认不需要密码。 |
isRecordOn |
是 |
bool |
录制会议开关。(字段即将废弃,不建议使用) |
isLiveOn |
否 |
bool |
保留。编辑会议时透传会议详情此字段。 |
isAutoRecordOn |
是 |
bool |
会议自动录制开关。 |
timeZone |
是 |
int |
时区码,请参考时区表。 |
vmrFlag |
是 |
bool |
是否是vmr会议。不可修改,填入会议详情返回值(废弃) |
vmrId |
否 |
char[] |
云会议室唯一ID。不可修改,填入会议详情返回值 |
joinConfRestrictionType |
是 |
允许入会范围限制。默认所有用户。 |
|
isSmsOn |
是 |
bool |
发送短信通知开关,企业配置里面需要开启,否则不生效。 |
isMailOn |
是 |
bool |
发送邮件通知开关。 |
isEmailCalendarOn |
是 |
bool |
发送邮件日历开关。 |
attendees |
是 |
与会者列表。 |
|
attendeeLen |
是 |
unsigned int |
与会者列表长度。 |
vmrConfIdType |
是 |
云会议室的会议ID类型。不可修改,会议详情中vmrConferenceId非空,填入HWM_VMR_CONF_ID_TYPE_FIXED;会议详情中vmrConferenceId为空,填入HWM_VMR_CONF_ID_TYPE_RANDOM |
|
isOpenWaitingRoom |
否 |
bool |
等候室开启开关
说明:
需要等候室功能开通后才能生效 |
allowGuestStartConf |
否 |
bool |
是否允许来宾提前启动会议。
说明:
|
allowGuestStartConfTime |
否 |
unsigned int |
允许来宾提前入会时间范围(单位:分钟) :0-随时,n-提前n分钟启动会议。 |
concurrentParticipants |
否 |
unsigned int |
会议方数,会议最大与会人数限制。 注:不填则不限制 |
customInfo |
否 |
char[] |
自定义扩展信息 |
defaultSummaryState |
否 |
会议云录制是否包含纪要,初始值。 |
|
autoMuteMode |
否 |
来宾入会,软终端是否自动静音。 |
|
hardTerminalAutoMuteMode |
否 |
来宾入会,硬终端是否自动静音。 |
返回值
类型 |
描述 |
---|---|
HwmErrCode |
成功返回0,其他值表示失败。失败返回值见错误码参考。 |
示例代码
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
/** * 编辑会议接口 */ int demoEditConfDlg::EditConf() { hwmsdkagent::HwmConfDetail confDetail{0}; //从缓存中得到会议详情数据赋予confDetail hwmsdkagent::HwmEditConfParam editConfParam{ 0 }; //根据实际需求拷贝confDetail的数据 strncpy_s(editConfParam.confId, confDetail.confListInfo.confId, HWM_MAX_CONF_ID_LEN); editConfParam.vmrFlag = confDetail.vmrFlag; strncpy_s(editConfParam.vmrId, confInfo.vmrId, HWM_MAX_VMR_CONF_ID_LEN); // 此处省略部分赋值代码 editConfParam.timeZone = 56; // 本地时区,用户依据自身情况自己调整,56东八区 editConfParam.isRecordOn = false; editConfParam.isAutoRecordOn = false; editConfParam.startTime = 1598398920; //utc时间戳 editConfParam.duration = 0 * 60 + 30;//会议时长 editConfParam.joinConfRestrictionType = hwmsdkagent::HwmJoinConfPermissionType::RESTRICTION_CALL_IN_ALL; //取编辑会议上面的允许入会用户类型 // vmrConferenceId非空是固定ID,为空则是随机id editConfParam.vmrConfIdType = (strlen(confInfo.confListInfo.vmrConferenceId) != 0) ? hwmsdkagent::HwmVmrConfIdType::HWM_VMR_CONF_ID_TYPE_FIXED : hwmsdkagent::HwmVmrConfIdType::HWM_VMR_CONF_ID_TYPE_RANDOM; return hwmsdkagent::EditConf(&editConfParam); } |