# 屏幕共享 (/zh-CN/realtime-media/rtc/build/video/screen-share/web) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). 在视频通话或互动直播中进行屏幕共享,可以将说话人或主播的屏幕内容,以视频画面的方式分享给其他说话人或观众观看,以提高沟通效率。 屏幕共享在如下场景中应用广泛: - 视频会议场景中,屏幕共享可以将讲话者本地的文件、数据、网页、PPT 等画面分享给其他与会人。 - 在线课堂场景中,屏幕共享可以将老师的课件、笔记、讲课内容等画面展示给学生观看。 点击[在线体验](https://webdemo.agora.io/example/advanced/shareTheScreen/index.html)试用屏幕共享功能。 :::warning[注意] Web SDK 仅支持在以下**桌面端**浏览器中进行屏幕共享: - Chrome 58 或以上版本。 - Firefox 56 或以上版本。 - Windows 10+ 平台上的 Edge 80 及以上版本。 - Safari 13 或以上版本。 ::: ## 实现原理 [#实现原理] Web 端屏幕共享,实际上是通过创建一个屏幕共享的视频轨道对象来实现的。你可以调用 [`createScreenVideoTrack`](/zh-CN/api-reference/rtc/web/interfaces/iagorartc#createscreenvideotrack) 方法创建一个用于屏幕共享的本地视频轨道对象。采集屏幕的过程中浏览器会询问需要共享哪些屏幕,根据终端用户的选择去获取屏幕信息。 ## 实现方法 [#实现方法] 开始前,请确保你已参考[快速开始](/zh-CN/realtime-media/rtc/get-started/quick-start)在你的项目中实现基本的实时音视频功能。 ### 文档类屏幕共享 [#文档类屏幕共享] 自 v4.24.10 起,共享文档、PPT、表格等以静态内容为主的屏幕时,可以将 `screenScenarioType` 设置为 `"Document"`,提升文字和图表的清晰度,并改善网络波动后的画质恢复体验。 ```javascript const screenTrack = await AgoraRTC.createScreenVideoTrack({ screenScenarioType: "Document", optimizationMode: "detail", }); await client.publish(screenTrack); ``` 调用 `publish` 前需先加入频道。不设置 `screenScenarioType` 时,保留原有屏幕共享行为。 ### Chrome 屏幕共享 [#chrome-屏幕共享] Web SDK 支持在 Chrome 58 及以上版本上进行屏幕共享。你可以按照以下步骤进行屏幕共享。 直接调用 `createScreenVideoTrack` 创建屏幕共享轨道即可。 这种方式要求 Chrome 74 或以上版本。如果你使用的软件版本不满足此要求,请使用屏幕共享插件实现在 Chrome 上共享屏幕。 ```javascript AgoraRTC.createScreenVideoTrack({ // 配置屏幕共享编码参数,详情请查看 API 文档 encoderConfig: "1080p_1", // 设置视频传输优化策略为清晰优先或流畅优先 optimizationMode: "detail" }).then(localScreenTrack => { /** ... **/ }); ``` **分享音频** Web SDK 支持在 Windows 和 macOS 平台的 Chrome 浏览器(74 及以上版本)上同时共享屏幕和本地播放的背景音。 你需要在调用 `createScreenVideoTrack` 方法时将 `withAudio` 参数设为 `enable`。 这样设置后,该方法会返回一个列表,包含屏幕共享的视频轨道对象和本地播放背景音的音频轨道对象。 ```javascript AgoraRTC.createScreenVideoTrack({ encoderConfig: "1080p_1", }, "enable").then(([screenVideoTrack, screenAudioTrack])=> { /** ... **/ }); ``` :::warning[注意] - 使用这个方法后,还需要终端用户在屏幕共享的弹出框上勾选**分享音频**才能真正生效。 - 如果选择共享单个应用窗口,无法分享音频。 ::: ![](https://web-cdn.agora.io/docs-files/1574070243757) ### Edge 屏幕共享 [#edge-屏幕共享] Web SDK 支持在 Windows 10+ 平台上的 Edge 80 及以上版本上进行屏幕共享。 直接调用 `createScreenVideoTrack` 创建屏幕共享轨道即可。 ```javascript AgoraRTC.createScreenVideoTrack({ // 在这里配置屏幕共享编码参数,详细参考 API 文档 encoderConfig: "1080p_1", }).then(localScreenTrack => { /** ... **/ }); ``` ### Firefox 屏幕共享 [#firefox-屏幕共享] Web SDK 支持在 Firefox 56 及以上版本上进行屏幕共享。在 Firefox 屏幕共享需要通过设置 `screenSourceType` 指定分享屏幕的类型,`screenSourceType` 的选择如下: - `screen`: 分享整个显示器屏幕。 - `application`: 分享某个应用的所有窗口(Firefox 在 Windows 平台不支持该模式)。 - `window`: 分享某个应用的某个窗口。 ```javascript AgoraRTC.createScreenVideoTrack({ screenSourceType: 'screen' // 'screen', 'application', 'window' }).then(localScreenTrack => { /** ... **/ }); ``` ### Safari 屏幕共享 [#safari-屏幕共享] Web SDK 支持在 macOS 平台的 Safari 13 及以上版本上进行屏幕共享。 直接调用 `createScreenVideoTrack` 创建屏幕共享轨道即可。 ```javascript AgoraRTC.createScreenVideoTrack({ // 在这里配置屏幕共享编码参数,详细参考 API 文档 encoderConfig: "1080p_1", }).then(localScreenTrack => { /** ... **/ }); ``` :::warning[注意] 在 Safari 上屏幕共享时默认共享整个显示器屏幕,不可选择共享哪些内容。 ::: ### Electron 屏幕共享 [#electron-屏幕共享] Electron 屏幕共享的选择界面需要你自行绘制,为方便快速集成,我们提供一个默认的选择界面。 如果你使用 v17.x 或以上版本的 Electron,请在主进程中添加以下代码,确保能获取到屏幕共享源。 ```javascript const { ipcMain, desktopCapturer } = require("electron"); ipcMain.handle("DESKTOP_CAPTURER_GET_SOURCES", (event, opts) => desktopCapturer.getSources(opts)); ``` **默认界面** 如果你选择使用默认界面,在 Electron 下使用屏幕共享和 Web 下的操作则没有区别。直接调用 `createScreenVideoTrack` 即可。 ```javascript AgoraRTC.createScreenVideoTrack({ encoderConfig: "1080p_1", }).then(localScreenTrack => { /** ... **/ }); ``` 调用后 SDK 会提供自带的默认界面让终端用户选择要共享的屏幕或窗口,如下图所示: ![选择窗口](https://web-cdn.agora.io/docs-files/1571629977600) **自定义界面** 如果你需要自定义选择界面,参考以下步骤: 1. 调用 SDK 提供的 `AgoraRTC.getElectronScreenSources` 方法获取可共享的屏幕信息。`sources` 是一个 `source` 对象的列表,`source` 里包含了分享源的信息和 `sourceId`,`source` 的属性如下: ![source](https://web-cdn.agora.io/docs-files/1547455349613) - `id`: 即 `sourceId`。 - `name`: 屏幕源的名字。 - `thumbnail`: 屏幕源的快照。 ```javascript AgoraRTC.getElectronScreenSources().then(sources => { console.log(sources); }) ``` 2. 根据 `source` 的属性,用 HTML 和 CSS 绘制选择界面,让用户选择要共享的屏幕源。`source` 的属性与屏幕共享的选择界面对应关系如下: ![source 与界面对应关系](https://web-cdn.agora.io/docs-files/1547456888707) 3. 获取用户选择的 `sourceId`。 4. 调用 `createScreenVideoTrack` 方法,将 `sourceId` 填入 `electronScreenSourceId`,就能创建相应的屏幕共享流了。 ```javascript AgoraRTC.createScreenVideoTrack({ // 填入用户选择的 sourceId electronScreenSourceId: sourceId, }).then(localScreenTrack => { /** ... **/ }); ``` :::info[信息] - `getElectronScreenSources` 方法是对 Electron 提供的 `desktopCapturer.getSources` 进行的封装,详情可参考 [desktopCapturer](https://electronjs.org/docs/api/desktop-capturer)。 - 在非 Electron 下传入 `sourceId` 会被忽略。 ::: ### 同时共享屏幕和开启视频 [#同时共享屏幕和开启视频] 因为一个 `AgoraRTCClient` 对象只能发送一路视频轨道,所以如果要在一个发送端同时分享屏幕和开启摄像头视频采集,需要创建两个 `AgoraRTCClient`,一路发送屏幕共享轨道,一路发送摄像头轨道。 ```javascript async function startScreenCall() { const screenClient = AgoraRTC.createClient({ mode: "rtc", codec: "vp8" }); await screenClient.join("", ""); const screenTrack = await AgoraRTC.createScreenVideoTrack(); await screenClient.publish(screenTrack); return screenClient; } async function startVideoCall() { const videoClient = AgoraRTC.createClient({ mode: "rtc", codec: "vp8" }); await videoClient.join("", ""); const videoTrack = await AgoraRTC.createCameraVideoTrack(); await videoClient.publish(videoTrack); return videoClient; } Promise.all([startScreenCall(), startVideoCall()]).then(() => { /** ... **/ }); ``` 自己订阅自己,会产生额外的计费,如图: 为避免重复计费,有以下注意事项: - 不要订阅本地的屏幕共享和音视频轨道。具体来说,当每个 Client 成功加入频道以后,请将返回的 `uid` 存在列表里。每次监听到 `user-published` 事件的时候,先判断该轨道是否为本地轨道,如果是,则不订阅。 - 共享的 Client 不应该订阅任何流。 ## 参考信息 [#参考信息-3] ### 开发注意事项 [#开发注意事项] - 一个 `AgoraRTCClient` 对象只能发送一路视频轨道。 - 负责发布屏幕共享的用户的用户 ID 不要固定在同一个值,否则某些场景下同用户 ID 的共享流可能会引起互踢。 - 在屏幕共享的时候,本地流的 Client **不要订阅本地的屏幕共享轨道**,否则会增加计费。 - 在 Windows 平台上进行屏幕共享时,如果共享的是 QQ 聊天窗口会导致黑屏。 ### 示例项目 [#示例项目-3] 声网提供了设置屏幕共享的开源示例项目供你参考,你可以前往下载或查看 `index.js` 中的源代码。 shareTheScreen} href="https://gitee.com/agoraio-community/API-Examples-Web/tree/main/src/example/advanced/shareTheScreen" /> shareTheScreen} href="https://github.com/Shengwang-Lab/API-Examples-Web/tree/main/src/example/advanced/shareTheScreen" />