组件
VideoUI组件
在Electron SDK中,我们提供了createVideoUI接口用于创建VideoUI的组件,它可以用于观看摄像头、屏幕共享、影音共享画面,其中包括观看自己或他人的视图画面。本文将重点介绍VideoUI组件的创建、销毁以及使用方法。
创建视图容器
示例代码:
//构建一个div元素,您也可以使用页面上已有的元素
const div = document.createElement('div');
const callbackObj = {
// 收到了视频帧通知
notifyFrameReceived(frame){
console.log('收到了视频帧通知')
},
// 首帧画面渲染通知
notifyFirstFrameRender(){
console.log('首帧渲染通知')
}
}
//为div元素创建视图容器
const videoUI = rtcsdk.createVideoUI(div, callbackObj);
相关API请参考:
实例方法:
实例方法
setVideo
功能: 设置视频组件观看对象
示例代码:
const videoObj = {
type: 0,
userId: 'myUserID',
videoId: -1,
}
videoUI.setVideo(videoObj);
| 参数 | 类型 | 说明 |
|---|---|---|
| videoObj | object | 视频观看配置,参见下方 |
videoObj:
| 参数 | 类型 | 说明 |
|---|---|---|
| type | number | 观看类型:0:摄像头(默认值) 1: 屏幕共享 2:影音共享 |
| userId | string | type=0时有效,观看该用户的摄像头画面 |
| videoId | number | type=0时有效,观看的摄像头ID,等于-1时将观看默认摄像头,-1是默认值 |
| maxFps | number | 可选,本地观看视频的最大帧率,同时观看多路视频时设置此值有利于优化性能。不传则不限制 |
setConfig
功能: 设置视频组件观看配置
示例代码:
const videoCfg = {
scaleType: 0,
}
videoUI.setConfig(videoCfg);
| 参数 | 类型 | 说明 |
|---|---|---|
| videoCfg | object | 视频观看配置,参见下方 |
videoCfg:
| 参数 | 类型 | 说明 |
|---|---|---|
| scaleType | number | 缩放类型: 0:等比例缩放留空居中显示(默认值) 1:等比例缩放裁剪铺满显示 2:不等比例缩放铺满显示(拉伸) |
ctrlMode
功能: 屏幕共享开启控制模式
示例代码:
videoUI.ctrlMode(bool);
当UI组件Type=2,我拥有屏幕控制权限,调用该接口进入控制模式。 组件在获取焦点后,本地的鼠标、键盘操作将发送到被控端。
| 参数 | 类型 | 说明 |
|---|---|---|
| bool | boolean | 是否开启控制模式 |
setMarkOption
功能: 屏幕共享标注属性设置
当UI组件Type=2,可以设置画笔标注的颜色、宽度属性和是否禁用状态。
示例代码:
videoUI.setMarkOption({
allowMark: true,
color: '#FF0000',
width: 3
});
| 参数 | 类型 | 说明 |
|---|---|---|
| allowMark | boolean | 允许标注,默认值false |
| color | boolean | 画笔颜色,例如: '#000000' |
| width | number | 画笔宽度,默认值2 |
destroy
功能: 销毁组件
当不再需要观看视频时务必调用该方法,以防内存泄漏
示例代码:
videoUI.destroy();