Interface ScreenVideoTrackInitConfig

PropertiesCopy Anchor Link

displaySurfaceCopy Anchor Link

displaySurface: "browser"|"window"|"monitor"

默认选中的共享内容类型，支持设为标签页、应用窗口（如下图）、或屏幕。详见 displaySurface。

electronScreenSourceIdCopy Anchor Link

electronScreenSourceId: string

使用 Electron 屏幕共享时，传入 sourceId。

encoderConfigCopy Anchor Link

encoderConfig: VideoEncoderConfiguration|ScreenEncoderConfigurationPreset

控制屏幕共享视频的编码配置。

你可以通过以下方式设置该属性：

• 通过 ScreenEncoderConfigurationPreset 传入 SDK 内置的编码配置。
• 通过传入一个 VideoEncoderConfiguration 对象来自定义视频编码配置。
• 不传或留空，使用 SDK 的默认值 "1080p_2"（分辨率 1920 × 1080、帧率 30 fps、码率 3000 Kbps）。

extensionIdCopy Anchor Link

extensionId: string

使用 Chrome 浏览器插件进行屏幕共享时，传入插件的 ID。

monitorTypeSurfacesCopy Anchor Link

monitorTypeSurfaces: "exclude"|"include"

是否允许分享整个屏幕，包括浏览器页签和窗口选项。

• "exclude": 不分享整个屏幕。
• "include": （默认）分享整个屏幕。

详见 monitorTypeSurfaces。

• 该参数仅支持 Chrome 119 及以上。
• 如果将 monitorTypeSurface 设为 exclude，则无法将 displaySurface 设为 monitor，否则会报错。

optimizationModeCopy Anchor Link

optimizationMode: OptimizationMode

设置视频传输优化模式。

你可以在视频通话、视频直播或屏幕共享过程中调用此方法动态调整视频的传输优化模式。例如你想要把屏幕共享内容从演示文稿切换为视频时，你可以将传输优化模式从 "detail" 切换为 "motion"，确保视频画面在网络波动时不会出现卡顿。

paramCopy Anchor Link

视频传输优化模式：

• "detail": 清晰优先。

  • 浏览器会自动根据你的采集分辨率和帧率设定一个最小码率。即使遭遇网络波动，发送码率也不会低于这个值，从而确保清晰的视频画面。
  • 大部分情况下，浏览器不会降低发送分辨率，但是可能会降低帧率。

• "motion": 自 4.21.0 开始，浏览器默认开启流畅优先模式。

  • 浏览器不会启用最小码率策略。遭遇网络波动时，发送端会降低码率来确保接收端的视频画面不会出现中断和卡顿。
  • 大部分情况下，浏览器不会降低帧率，但是可能会降低发送分辨率。

• "balanced": 默认的传输优化模式。

  • 对于屏幕共享视频流，SDK 默认的优化策略为清晰优先。
  • 对于其他视频流，SDK 默认的优化策略为坚固清晰合流畅，弱网条件下，帧率和分辨率都会被调整。

preferCurrentTabCopy Anchor Link

preferCurrentTab: boolean

是否默认共享当前页面。

• true: 是。
• false: （默认）否。

screenSourceTypeCopy Anchor Link

screenSourceType: ScreenSourceType

deprecatedCopy Anchor Link

自 v4.17.1 起废弃，请改用 displaySurface。

屏幕共享源的类型。

selfBrowserSurfaceCopy Anchor Link

selfBrowserSurface: "include"|"exclude"

是否允许用户共享当前标签页：

• "include"：（默认）允许用户共享当前标签页。
• "exclude"：禁止用户共享当前标签页。

详见 selfBrowserSurface。

surfaceSwitchingCopy Anchor Link

surfaceSwitching: "include"|"exclude"

是否允许用户动态切换共享的标签页：

• "include"：（默认）允许用户动态切换共享的标签页。
• "exclude"：禁止用户动态切换共享的标签页。

详见 surfaceSwitching。

systemAudioCopy Anchor Link

systemAudio: "include"|"exclude"

是否允许采集系统音频：

• "include"：（默认）允许采集系统音频。
• "exclude"：禁止采集系统音频。

详见 systemAudio。

windowAudioCopy Anchor Link

windowAudio: "exclude"|"system"

共享窗口时是否允许分享窗口音频。

• "exclude"：不分享任何音频。
• "system"：（默认）分享所有系统音频。

详见 withAudio。