Screen

Screen

new Screen(id, name)

Description:
  • 桌面共享Screen构造函数。

Parameters:
Name Type Description
id String

设备Id

name String

设备名称

Members

attachScreenElementMediaStream

Description:
  • 桌面共享流渲染进视频控件

桌面共享流渲染进视频控件

(async) electronPrimaryDisplayPublish

Description:
  • electron 发布主屏幕桌面共享

electron 发布主屏幕桌面共享

(async) electronPublish

Description:
  • electron 发布桌面共享,主要用于electron v12版本之前或者该示例添加了contextIsolation: false

electron 发布桌面共享,主要用于electron v12版本之前或者该示例添加了contextIsolation: false

getDisplaySurface

Description:
  • 获取当前桌面共享弹窗显示内容选项

获取当前桌面共享弹窗显示内容选项

muteScreenAudio

Description:
  • 屏幕共享静音

屏幕共享静音

preview

Description:
  • 预览桌面共享,只能获取桌面共享流后或发布后操作后才能调用

预览桌面共享,只能获取桌面共享流后或发布后操作后才能调用

(async) publish

Description:
  • 发布桌面共享。

发布桌面共享。

(async) publishHandle

Description:
  • electron桌面共享发布接口,electron 12之前的版本建议使用electronPublish

electron桌面共享发布接口,electron 12之前的版本建议使用electronPublish

setBandwidth

Description:
  • 设置带宽

设置带宽

setDescription

Description:
  • 设置备注

设置备注

setDisplaySurface

Description:
  • 设置桌面共享弹窗显示内容选项,chrome71及以后就支持displaySurface参数,但设置后未生效,96版本才开始真正生效。

设置桌面共享弹窗显示内容选项,chrome71及以后就支持displaySurface参数,但设置后未生效,96版本才开始真正生效。

Example
screen.setDisplaySurface(ScreenDisplaySurface.monitor);

setFrameRate

Description:
  • 设置帧率

设置帧率

setLevel

Description:
  • 设置桌面共享的优先级别

设置桌面共享的优先级别

setResolution

Description:
  • 设置分辨率

设置分辨率

setScreenAudioEnabled

Description:
  • 屏幕共享时是否同时共享屏幕音频

屏幕共享时是否同时共享屏幕音频

(async) subscrible

Description:
  • 订阅桌面共享流

订阅桌面共享流

unmuteScreenAudio

Description:
  • 取消屏幕共享静音

取消屏幕共享静音

(async) unpublish

(async) unsubscrible

Description:
  • 取消订阅桌面共享流

取消订阅桌面共享流

updateScreenData

Description:
  • 桌面共享数据更改

桌面共享数据更改