更新时间:2025-03-28 GMT+08:00
分享

开启共享

接口功能

该接口用于开启会议共享。SDK的UI已经实现了“共享”功能,如果第三方App不需要通过程序控制开启共享,则不用调用该接口。注意事项:1、不在会议或呼叫中调用该接口将返回失败;2、呼叫中调用该接口,呼叫转成会议。

函数原型

startShare(startShareInfo: StartShareInfo, onStartShareResult?: (ret: SDKERR, reason: string) => void): void

请求参数

表1 入参说明
参数名称 是否必选 参数类型 参数说明
startShareInfo Y StartShareInfo 开启共享参数
onStartShareResult Y (ret: SDKERR, reason: string) => void 开启共享回调
表2 StartShareInfo
参数名称 是否必选 参数类型 参数说明
shareType Y ShareType 共享类型
monitorShareInfo N MonitorShareInfo 屏幕共享信息。当共享类型不是屏幕共享时,该变量不需要赋值。
appShareInfo N AppShareInfo 程序共享信息。当共享类型不是程序共享时,该变量不需要赋值。
operatableUiMonitor Y MonitorShareInfo 共享时,工具栏所在的显示器信息。若monitor值为0,则不指定显示器。
表3 ShareType枚举说明
枚举名称 枚举值 枚举说明
HWM_SHARE_TYPE_MONITOR 0 屏幕共享(仅对Windows平台生效)
HWM_SHARE_TYPE_APP 1 程序共享(仅对Windows平台生效)
HWM_SHARE_TYPE_WHITE_BOARD 2 白板共享(仅对Windows平台生效)
HWM_SHARE_TYPE_ALL 3 全类型共享
表4 MonitorShareInfo
参数名称 是否必选 参数类型 参数说明
monitor Y Monitor 屏幕类型,1-主屏幕,2-副屏幕,mode为主副屏模式下生效
monitorMode Y MonitorMode 屏幕模式,0-主副屏模式,1-多屏模式
monitorIndex Y number 屏幕索引,mode为多屏模式下生效
表5 Monitor枚举说明
枚举名称 枚举值 枚举说明
HWM_MONITOR_MAIN 1 主显示器
HWM_MONITOR_SECONDARY 2 副显示器
表6 MonitorMode枚举说明
枚举名称 枚举值 枚举说明
HWM_MONITOR_MODE_PRIMARY_SECONDARY 0 主副屏模式
HWM_MONITOR_MODE_MULTI_MONITOR 1 多屏模式
表7 AppShareInfo
参数名称 是否必选 参数类型 参数说明
appHandle Y number 程序句柄。

返回值

void

回调方法参数说明:

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

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

相关文档