屏幕共享
功能介绍
在视频会话中为了提高沟通效率,可以将自己的屏幕内容分享给其他参与方观看。
使用场景如下:
- 视频会议场景中,屏幕共享可以将讲话者本地的文件、数据、网页、PPT 等画面分享给其他与会人;
- 在线课堂场景中,屏幕共享可以将老师的课件、笔记、讲课内容等画面展示给学生观看。
注意:
同一个房间中,不支持多人同时开启屏幕共享。
共享端
1.获取资源列表
- 调用 getScreenCaptureSources,获取可共享的屏幕和窗口的对象列表,列表中包含窗口ID、屏幕ID、缩略图等重要信息。方便用户通过列表中的缩略图选择共享某个显示器的屏幕或某个窗口。示例代码如下:
//传入缩略图大小、图标大小获取相关信息列表
const thumbSize = { width: 190, height: 108 };
const iconSize = { width: 32, height: 32 };
const infos = rtcsdk.getScreenCaptureSources(thumbSize, iconSize);
2.配置屏幕共享
- 根据应用场景,选择屏幕、窗口、区域其中一种共享方式,调用setScreenShareCfg传入配置参数,更多配置参见ScreenShareCfg。示例代码如下:
//共享屏幕配置
const cfg = {
monitorID: infos[0]._sourceId,
};
rtcsdk.setScreenShareCfg(JSON.stringify(cfg));
//共享窗口配置
const cfg = {
catchWnd: infos[0]._sourceId,
};
rtcsdk.setScreenShareCfg(JSON.stringify(cfg));
3.开始屏幕共享
- 示例代码如下:
//开启屏幕共享
rtcsdk.startScreenShare();
- 回调通知:
// 开启结果
rtcsdk.on("startScreenShareRslt", (sdkErr) => {
if (sdkErr === 0){
// 开启屏幕共享成功, sdk内部将自动完成抓屏共享处理。
} else {
// 开启屏幕共享失败
}
}
相关API请参考:
- getScreenCaptureSources
- setScreenShareCfg
- startScreenShare
- startScreenShareRslt
- notifyScreenShareStarted
4.停止共享
- 接口调用:
//主动停止屏幕共享
rtcsdk.stopScreenShare();
- 回调通知:
//主动停止屏幕共享的结果
rtcsdk.on("stopScreenShareRslt", (sdkErr) => {
if (sdkErr !== 0){
// 停止屏幕共享失败
return;
}
})
相关API请参考:
观看端
1.准备屏幕共享图像播放容器
<div id="screenContainer"></div>
2.收到共享通知,创建UI组件
//通知屏幕共享开始
rtcsdk.on("notifyScreenShareStarted", (userID) => {
const div = document.getElementById('screenContainer');
//为div元素创建视图容器
const videoUI = rtcsdk.createVideoUI(div);
const videoObj = {
type: 1
}
videoUI.setVideo(videoObj); //设置videoUI观看屏幕共享画面
})
相关API请参考:
3.通知停止共享
//收到他人停止了屏幕共享的通知
rtcsdk.on("notifyScreenShareStopped", (operatorID) => {
videoUI.destroy(); //以防内存泄漏,务必销毁组件
//隐藏远端屏幕渲染界面
})
相关API请参考: