new Screen(id, name)
- Description:
桌面共享Screen构造函数。
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String | 设备Id |
name |
String | 设备名称 |
Methods
attachScreenElementMediaStream(element, stream)
- Description:
桌面共享流渲染进视频控件
Parameters:
| Name | Type | Description |
|---|---|---|
element |
Object | － 视频控件对象 |
stream |
Object | － 桌面共享流 |
electronPrimaryDisplayPublish(isShareScreenAudio)
- Description:
electron 发布主屏幕桌面共享
Parameters:
| Name | Type | Description |
|---|---|---|
isShareScreenAudio |
Boolean | 是否同时共享屏幕音频 |
electronPublish(ipc, types, thumbnailSize, isShareScreenAudio)
- Description:
electron 发布桌面共享，主要用于electron v12版本之前或者该示例添加了contextIsolation: false
Parameters:
| Name | Type | Description |
|---|---|---|
ipc |
Object | renderer进程 |
types |
Array | 共享类型，数组，例如：["window",'screen'] |
thumbnailSize |
Array | 共享源的缩略图大小，例如: {width: 100, height: 100} |
isShareScreenAudio |
Boolean | 是否同时共享屏幕音频 |
muteScreenAudio()
- Description:
屏幕共享静音
preview(element)
- Description:
预览桌面共享，只能获取桌面共享流后或发布后操作后才能调用
Parameters:
| Name | Type | Description |
|---|---|---|
element |
Object | 视频控件 |
publish(displayMediaStream)
- Description:
发布桌面共享。
Parameters:
| Name | Type | Description |
|---|---|---|
displayMediaStream |
Object | 待发布的桌面共享流，可以为空。当空时，会弹出桌面共享选择应用框选择共享的内容。 |
publishHandle(sourceId, audioEnable)
- Description:
electron桌面共享发布接口，electron 12之前的版本建议使用electronPublish
Parameters:
| Name | Type | Description |
|---|---|---|
sourceId |
String | 桌面共享sourceId |
audioEnable |
Boolean | 是否同时共享屏幕音频 |
setBandwidth(maxBandwidth-)
- Description:
设置带宽
Parameters:
| Name | Type | Description |
|---|---|---|
maxBandwidth- |
int | 最大带宽 |
setDescription(description)
- Description:
设置备注
Parameters:
| Name | Type | Description |
|---|---|---|
description |
String | 备注 |
setFrameRate(frameRate)
- Description:
设置帧率
Parameters:
| Name | Type | Description |
|---|---|---|
frameRate |
int | 帧率 |
setLevel(level)
- Description:
设置桌面共享的优先级别
Parameters:
| Name | Type | Description |
|---|---|---|
level |
int | 优先级别 |
setResolution(width-, height-)
- Description:
设置分辨率
Parameters:
| Name | Type | Description |
|---|---|---|
width- |
int | 分辨率宽 |
height- |
int | 分辨率高 |
setScreenAudioEnabled(enabled)
- Description:
屏幕共享时是否同时共享屏幕音频
Parameters:
| Name | Type | Description |
|---|---|---|
enabled |
Boolean |
subscrible()
- Description:
订阅桌面共享流
unmuteScreenAudio()
- Description:
取消屏幕共享静音
unpublish()
unsubscrible()
- Description:
取消订阅桌面共享流
updateScreenData(level, description)
- Description:
桌面共享数据更改
Parameters:
| Name | Type | Description |
|---|---|---|
level |
int | |
description |
String |