检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
编辑周期会议 modifyCycleConf 接口描述 该接口用于编辑周期会议。 注意事项 该接口在已登录状态下才能调用。 方法定义 1 modifyCycleConf(modifyCycleConfParam: HWMOpenModifyCycleConfParamModel):
会中水印定制 接口描述 该接口用于屏幕共享设置水印。该水印是在接收端叠加到共享内容上的。服务器上配置后才会显示水印。 1、在桌面共享的接收端叠加水印图片,只有服务器上会中水印打开的情况下自定义水印才生效。如果不自定义,默认按照手机号、邮箱、会议ID+昵称优先级顺序显示,字体透明度10%。
自定义会中水印 screenShareCoverView 接口描述 该接口用于屏幕共享/白板共享设置水印。该水印是在接收端叠加到共享内容上的。服务器上配置后才会显示水印。 1、在桌面共享、程序共享、白板共享的接收端叠加水印图片,只有服务器上会中水印打开的情况下自定义水印才生效。如
典型场景接口调用概览 图1 接口调用流程 1、登录不是必须的步骤,在不登录的情况下也能通过会议ID和密码加入已经创建好的会议。 2、开启共享、结束共享、离开会议、结束会议等接口,当前SDK的UI上已经提供了对应的功能,如果第三方的App不需要程序控制这些功能则无需调用对应接口。 父主题:
App ID登录 描述 该接口用于通过App ID登录 在未登录状态下,只能加入已经创建的会议。 业务流程 使用SDK登录时,先调用login接口,然后处理回调callback。 接口调用 从接入方服务器获得登录使用的账号、过期时间、随机数、用户名、加密签名 调用login进行登录,第1步中的数据作为参数。
设置证书校验信息 setCaVerifyParam: 接口描述 该接口用于设置证书校验信息。 注意事项 该接口非必需调用,若不设置,则默认不开启证书校验。 方法定义 1 + (HWMSDKERR)setCaVerifyParam:(HWMCaVerifyParam *)param;
添加智能协作大屏(IdeaHub,Board系列) 华为云会议适配智能协作大屏(IdeaHub,Board系列),企业管理员将智能协作大屏添加到华为云会议管理平台后可获取激活码,进行激活后,可在智能协作大屏上使用会议功能。 注意事项 企业添加智能协作大屏激活码前需要购买IdeaH
该接口用于查询企业内历史会议的QoS告警。仅旗舰版企业的企业管理员有权限查询。可以查询最近45天内的数据。 仪表盘的QoS统计功能需要申请才能开通。请联系华为销售人员,并提供华为云会议企业ID。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址 /
该接口用于查询企业内正在召开会议的QoS告警。仅旗舰版企业的企业管理员有权限查询。 仪表盘的QoS统计功能需要申请才能开通。请联系华为销售人员,并提供华为云会议企业ID。 调试 您可以在API Explorer中调试该接口。 接口原型 表1 接口原型 请求方法 GET 请求地址 /
示例2:WeLink 代理登录鉴权业务流程 应用场景 第三方可通过WeLink账号、密码进行登录,登录成功后获得一个Token。 业务流程 图1 WeLink 代理鉴权登录流程图 前期准备:获取到WeLink的账号密码。 有两种途径:1,免费注册获取试用账号;2,直接购买服务后通过企业管理员创建账号。
获取VMR列表 GetVmrList 接口描述 该接口用于获取VMR列表。 注意事项 该接口在已登录状态下才能调用。 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
会议详情通知 通知描述 收到该通知时,会中时会收到会议详情通知,可用于做会中分享等。 方法定义 1 - (void)onConfDetailNotify:(HWMConfDetail *)confDetail; 注意事项 SDK初始化时设置globalHandler代理对象或者在需要处理的界面设置代理对象。
添加与会者 addAttendee 接口描述 该接口用于在会议中添加与会者。 注意事项 必须在会议中,并且只有主持人才可以添加与会者; 方法定义 1 - (void)addAttendee:(NSArray<HWMAttendeeInfo *> *) attendee callback:(_Nonnull
添加与会者 1 HWMBizSdk.getBizOpenApi().addAttendee(List<AttendeeModel> attendees, HwmCallback<Integer> hwmCallback); 接口描述 该接口用于在会议中添加与会者。 注意事项 必须在会议中,并且只有主持人才可以加人;
获取用户状态 getUserState 接口描述 该接口用于获取用户当前的状态(是否在会议中)。 注意事项 无 方法定义 - (HWMUserState)getUserState; 参数描述 表1 枚举HWMUserState说明 参数 值 描述 HWMUserStateIdle
场景4:会议控制操作 描述 考虑到大部分使用SDK进行二次开发的场景,SDK提供了静音开关,视频开关,扬声器开关,共享,举手等一系列会控操作,通过setConfConfig接口可以个性化设置,通过getConfConfig接口,可以获取实时信息; 业务流程 本流程以设置共享为例,
获取用户状态 getIsInConfOrCall: 接口描述 该接口用于获取用户当前的状态(是否在会议中)。 注意事项 无 方法定义 1 - (HWMSDKConfOrCallStatus)getIsInConfOrCall; 参数描述 表1 参数说明 枚举值 描述 HWMSD
取消周期会议 cancelCycleConfWithParam 接口描述 该接口用于取消至少还有一场子会议未开始的周期会议。 注意事项 该接口在登录状态下才能调用。 最后一场子会议未开始前可以调用接口,开始后调用则无效。 方法定义 1 - (void)cancelCycleCon
预约周期会议 bookCycleConf 接口描述 该接口用于预约周期会议。 注意事项 不在登录状态下,不应调用该接口。 会议开始时间必须晚于当前时间,会议时长应大于15分钟。 个人会议或者云会议室的时候要传入vmrId。 携带与会者入会的时候需要传入attendees。 周期会
取消周期会议 接口描述 该接口用于取消未开始的周期会议。 注意事项 周期会议未全部结束前可以调用接口,结束后调用则无效。 方法定义 1 2 3 4 5 6 7 /** * 取消周期会议 * * @param cycleConfId 周期会议Id