实现会中共享应用画面

最近更新时间:2024-11-26 16:04:13

我的收藏

功能介绍

使用场景

在线教育、调研访谈、投研路演等场景,常常需要对参会成员进行应用画面的屏幕共享,发起共享后,应用将以独立窗口的形式进行视频共享,帮助参会者更直观的看到所需要关注的应用内容。

交互表现

以桌面端为例:

发起应用画面共享

单击应用 WebView 顶部工具栏 的分享图标,发起应用画面共享。




选择需要共享的应用画面

可以在屏幕共享预览页,直接选择应用页面,如下图:



如屏幕共享预览页里的页面过多,可以单击“应用标签”后,选择需要共享画面的会中应用,如下图:




实现方案

JSAPI 参考

调起共享应用窗口的确认框(桌面端)

接口描述
接口名:app.shareWebAppWindow
描述:唤起共享应用画面的原生弹窗,可选择是否需要共享电脑声音。
客户端支持:Windows、Mac。
支持的版本:3.10.0以上版本。
是否需要鉴权:否。
交互示意



参数说明
参数名称
参数类型
是否必填
参数描述
mode
Int
1:SCREEN_ONLY(仅共享应用画面)
2:SCREEN_WHIT_AUDIO(同时共享电脑声音)
代码示例
const { ScreenShareMode } = wemeet;
wemeet.app.shareWebAppWindow({
mode: ScreenShareMode.SCREEN_WHIT_AUDIO,
success: () => {
console.log('shareWebAppWindow success');
},
fail: (err) => {
console.log('shareWebAppWindow canceled', err);
}
})
.catch(err => {
console.error('shareWebAppWindow error');
})

配置 WebView 顶部工具栏和屏幕共享预览页内共享入口的显隐(桌面端)

接口描述
接口名:app.configShareWebAppWindow
描述:配置顶部工具栏和屏幕共享预览页内共享入口的显隐效果。
客户端支持:Windows、Mac。
支持的版本:3.10.0及以上版本。
是否需要鉴权:否。
参数说明
参数名称
参数类型
是否必填
参数描述
shareButton
Int
1:显示
2:隐藏

调起结束共享应用画面的确认框(桌面端)

接口描述
接口名:app.stopShareWebAppWindow
描述:唤起结束应用画面共享的确认框。
客户端支持:Windows、Mac。
支持的版本:3.10.5及以上版本。
是否需要鉴权:否。
代码示例
wemeet.app.stopShareWebAppWindow({
success: () => {
console.log('stopShareWebAppWindow success');
},
fail: (err) => {
console.log('stopShareWebAppWindow canceled', err);
}
})
.catch(err => {
console.error('stopShareWebAppWindow error');
})

调用屏幕共享(移动端)

接口描述
接口名:ui.shareUserScreen
描述:发起移动端的屏幕共享,用于实现发起移动端的应用画面共享。
支持的客户端:iOS、Android。
支持的版本:3.10.0及以上版本。
是否需要鉴权:否。

结束调用屏幕共享(移动端)

接口描述
接口名:ui.stopShareUserScreen
描述:结束移动端的屏幕共享,用于实现结束移动端的应用画面共享。
支持的客户端:iOS、Android。
支持的版本:3.10.5及以上版本。
是否需要鉴权:否。
代码示例
wemeet.ui.stopShareUserScreen({
success: () => {
console.log('stopShareUserScreen success');
},
fail: (err) => {
console.log('stopShareUserScreen canceled', err);
}
})
.catch(err => {
console.error('stopShareUserScreen error');
})

事件参考

应用共享状态事件

事件描述
事件名:webapp-window-share-state
描述:配置该事件监听应用共享状态。
支持的客户端:Windows、Mac。
支持的版本:3.10.0及以上版本。
是否需要鉴权:否。
状态值
参数
参数描述
0
共享失败
1
共享开始
2
共享停止
3
共享暂停
4
共享继续

用户屏幕共享状态事件

事件描述
事件名:user-screen-status
描述:配置该事件监听用户屏幕共享状态(可在移动端配合使用)。
支持的客户端:iOS、Android、Windows、Mac。
支持的版本:3.9.0及以上版本。
是否需要鉴权:否。
状态值
参数
参数描述
true
共享中
false
共享结束

错误码列表

错误码
说明
0
未知错误
1
参数错误
2
平台不支持
3
取消共享
4
没有权限