new Screen(id, name)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
id |
String
|
设备Id |
name |
String
|
设备名称 |
Methods
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
element |
Object
|
－ 视频控件对象 |
stream |
Object
|
－ 桌面共享流 |
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
element |
Object
|
－ 视频控件对象 |
stream |
Object
|
－ 桌面共享流 |
(async) electronPrimaryDisplayPublish(isShareScreenAudio)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
isShareScreenAudio |
Boolean
|
是否同时共享屏幕音频 |
(async) electronPrimaryDisplayPublish(isShareScreenAudio)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
isShareScreenAudio |
Boolean
|
是否同时共享屏幕音频 |
(async) electronPublish(ipc, types, thumbnailSize, isShareScreenAudio)
- Description:
- electron 发布桌面共享，主要用于electron v12版本之前或者该示例添加了contextIsolation: false
- Source:
Parameters:
| Name |
Type |
Description |
ipc |
Object
|
renderer进程 |
types |
Array
|
共享类型，数组，例如：["window",'screen'] |
thumbnailSize |
Array
|
共享源的缩略图大小，例如: {width: 100, height: 100} |
isShareScreenAudio |
Boolean
|
是否同时共享屏幕音频 |
(async) electronPublish(ipc, types, thumbnailSize, isShareScreenAudio)
- Description:
- electron 发布桌面共享，主要用于electron v12版本之前或者该示例添加了contextIsolation: false
- Source:
Parameters:
| Name |
Type |
Description |
ipc |
Object
|
renderer进程 |
types |
Array
|
共享类型，数组，例如：["window",'screen'] |
thumbnailSize |
Array
|
共享源的缩略图大小，例如: {width: 100, height: 100} |
isShareScreenAudio |
Boolean
|
是否同时共享屏幕音频 |
getDisplaySurface()
- Description:
- Source:
getDisplaySurface()
- Description:
- Source:
muteScreenAudio()
- Description:
- Source:
muteScreenAudio()
- Description:
- Source:
preview(element)
- Description:
- 预览桌面共享，只能获取桌面共享流后或发布后操作后才能调用
- Source:
Parameters:
| Name |
Type |
Description |
element |
Object
|
视频控件 |
preview(element)
- Description:
- 预览桌面共享，只能获取桌面共享流后或发布后操作后才能调用
- Source:
Parameters:
| Name |
Type |
Description |
element |
Object
|
视频控件 |
(async) publish(displayMediaStream)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
displayMediaStream |
Object
|
待发布的桌面共享流，可以为空。当空时，会弹出桌面共享选择应用框选择共享的内容。 |
(async) publish(displayMediaStream)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
displayMediaStream |
Object
|
待发布的桌面共享流，可以为空。当空时，会弹出桌面共享选择应用框选择共享的内容。 |
(async) publishHandle(sourceId, audioEnable)
- Description:
- electron桌面共享发布接口，electron 12之前的版本建议使用electronPublish
- Source:
Parameters:
| Name |
Type |
Description |
sourceId |
String
|
桌面共享sourceId |
audioEnable |
Boolean
|
是否同时共享屏幕音频 |
(async) publishHandle(sourceId, audioEnable)
- Description:
- electron桌面共享发布接口，electron 12之前的版本建议使用electronPublish
- Source:
Parameters:
| Name |
Type |
Description |
sourceId |
String
|
桌面共享sourceId |
audioEnable |
Boolean
|
是否同时共享屏幕音频 |
setBandwidth(maxBandwidth-)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
maxBandwidth- |
int
|
最大带宽 |
setBandwidth(maxBandwidth-)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
maxBandwidth- |
int
|
最大带宽 |
setDescription(description)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
description |
String
|
备注 |
setDescription(description)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
description |
String
|
备注 |
setDisplaySurface(screenDisplaySurface)
- Description:
- 设置桌面共享弹窗显示内容选项，chrome71及以后就支持displaySurface参数，但设置后未生效，96版本才开始真正生效。
- Source:
Example
screen.setDisplaySurface(ScreenDisplaySurface.monitor);
Parameters:
| Name |
Type |
Description |
screenDisplaySurface |
ScreenDisplaySurface
|
桌面共享弹窗显示内容选项(枚举型),默认值为ScreenDisplaySurface.monitor |
setDisplaySurface(screenDisplaySurface)
- Description:
- 设置桌面共享弹窗显示内容选项，chrome71及以后就支持displaySurface参数，但设置后未生效，96版本才开始真正生效。
- Source:
Example
screen.setDisplaySurface(ScreenDisplaySurface.monitor);
Parameters:
| Name |
Type |
Description |
screenDisplaySurface |
ScreenDisplaySurface
|
桌面共享弹窗显示内容选项(枚举型),默认值为ScreenDisplaySurface.monitor |
setFrameRate(frameRate)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
frameRate |
int
|
帧率 |
setFrameRate(frameRate)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
frameRate |
int
|
帧率 |
setLevel(level)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
level |
int
|
优先级别 |
setLevel(level)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
level |
int
|
优先级别 |
setResolution(width-, height-)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
width- |
int
|
分辨率宽 |
height- |
int
|
分辨率高 |
setResolution(width-, height-)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
width- |
int
|
分辨率宽 |
height- |
int
|
分辨率高 |
setScreenAudioEnabled(enabled)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
enabled |
Boolean
|
|
setScreenAudioEnabled(enabled)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
enabled |
Boolean
|
|
(async) subscrible()
- Description:
- Source:
(async) subscrible()
- Description:
- Source:
unmuteScreenAudio()
- Description:
- Source:
unmuteScreenAudio()
- Description:
- Source:
(async) unpublish()
- Source:
(async) unpublish()
- Source:
(async) unsubscrible()
- Description:
- Source:
(async) unsubscrible()
- Description:
- Source:
updateScreenData(level, description)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
level |
int
|
|
description |
String
|
|
updateScreenData(level, description)
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
level |
int
|
|
description |
String
|
|