检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
isSupportMultiAppLogin 否 bool 是否支持同终端多应用登录。默认关闭。 表2 枚举HwmAuthType说明 枚举值 描述 HWM_AUTH_TYPE_ACCOUNT_AND_PASSWORD 账号密码鉴权方式。
显示设置窗口 ShowSettingWindow 接口描述 该接口显示设置窗口,会前会中都可以调用。 注意事项 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
显示设置窗口 showSettingWindowWithInfo 接口描述 该接口显示设置窗口。 方法定义 1 - (void)showSettingWindowWithInfo:(HWMUISDKShowSettingWindowInfoModel *)info; 参数描述 表
设置共享权限 setShareScreenPermission 接口描述 该接口用于设置共享权限。 注意事项 该接口返回值只代表接口是否调用成功。 方法定义 1 - (BOOL)setShareScreenPermission:(BOOL)isPermission; 参数描述 表
网络模式设置 setNetworkMode 接口描述 如华为云会议的媒体节点下沉部署到企业,并且管理节点也是通过企业内的代理访问,需要将网络模式设置成“企业内外接入”。 企业内的App无法直接访问公网(即媒体节点下沉和管理节点代理下沉场景)的情况下才需要调用该接口。 注意事项 该接口非必需调用
设置共享权限 setShareScreenPermission 接口描述 该接口用于设置共享权限。 注意事项 该接口返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回 方法定义 1 - (BOOL)setShareScreenPermission:(BOOL)isPermission
离开会议 接口描述 该接口用于离开会议。 注意事项 请在调用加入会议接口后再调用此接口 方法定义 1 leaveConf(params) : Promise<Result> 相关事件 离会结果通知 参数描述 表1 参数说明 参数 是否必须 类型 描述 params 是 object
错误码参考 表1 HwmErrCode枚举说明 retCode retMsg 描述 0 success. 成功 1 fail. 失败 10000 SDK internal error. SDK内部错误 10001 Network error. 网络错误,如SSL证书等问题导致的接口不通
场景5:离开会议 描述 在第三方网页需要离开会议时,需要调用SDK的leaveConf接口,如果强制结束进程或者关闭网页,可能会导致该离会用户在其他用户的与会者列表中,仍存在一小段时间。 业务流程 需要离开会议时,先调用leaveConf接口,然后处理回调事件leave_conf_result
场景1:初始化 描述 在第三方APP启动时,需要先初始化SDK,才能调用SDK的功能接口,该接口只需调用一次。 业务流程 SDK初始化时,先修改HwmSdk文件夹下HwmSdk.exe文件的名称,再调用Init接口,然后处理回调函数OnInitResult。 修改exe文件名称 修改
在已登录状态下可为空,已登录时为空将使用登录的用户名作为会场名。 isCameraOn 是 BOOL 是否打开摄像头,默认关闭。 isMicOn 是 BOOL 是否打开麦克风,默认打开。
典型场景接口调用概览 图1 接口调用流程 1、登录不是必须的步骤,在不登录的情况下也能通过会议ID和密码加入已经创建好的会议。 2、开启共享、结束共享、离开会议、结束会议等接口,当前SDK的UI上已经提供了对应的功能,如果第三方的App不需要程序控制这些功能则无需调用对应接口。
场景6:加入会议 描述 在登录后或者登录前,都可以使用该接口通过会议ID和密码加入会议。 业务流程 使用SDK加入已经存在的会议时,先调用joinConf接口,然后处理回调callback。 接口调用 组装模型 会议id加入会议使用HWMJoinConfParam。
2、在不登录的情况下也能通过会议ID和密码加入已经创建好的会议,其它使用场景需要登录。 3、可选通知根据需求场景决定是否实现。 父主题: 典型场景
社交分享定制 - (NSView *)socialShareView:(HWMSDKMeetingInfoModel* )confInfo; 接口描述 该接口用于分享会议拦截处理。实现代理后会拦截SDK调起分享界面的方法,如下图红框标注。 图1 分享拦截SDK弹窗 注意事项 如果实现该协议方法
在已登录状态下可为空,已登录时为空将使用登录的用户名作为会场名。匿名入会必须传该名字或者提前设置会场名 isCloseSpk 否 bool 是否关闭扬声器,true关闭扬声器;false不关闭扬声器。
设置会场名 RenameSelf 接口描述 该接口用于设置会场名。 注意事项 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode RenameSelf(const
头像拦截显示 接口描述 该接口用于定制登录后的头像显示。 调用场景: 图1 画中画模式 图2 画廊模式 图3 悬浮窗 注意事项 未登录的头像不支持自定义。
设置共享权限 SetShareScreenPermission 接口描述 该接口用于设置共享权限。 注意事项 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回 方法定义 HWM_SDK_AGENT_API hwmsdk::HwmErrCode
场景7:加入会议 描述 在登录成功后,可以使用该接口通过会议ID和密码加入会议。 业务流程 使用SDK加入已经存在的会议时,先调用joinConf接口,然后处理返回结果。 接口调用 组装数据结构HWMOpenJoinConfByIdParamModel。