hy-rtc-sdk-components 0.0.2

package/README.md

@@ -0,0 +1,152 @@
+## npm包信息
+##### 包名：hy-rtc
+安装方式 yarn add hy-rtc
+
+## 样式引入
+<style src="hy-rtc/lib/hy-rtc.css"></style>
+
+## 更新内容
+【0.7.3】20211104
+<br>
+- 优化 - 放大云台控制按钮，移除斜方向的按钮。
+
+【0.7.2】20211013
+<br>
+- 修复 - 新建会议房间或重新进入会议房间，在设备端未操作的情况下显示该设备已加入房间
+- 修复 - 优化平板网页端直播时球机云台控制问题
+- 优化 - 球机上传的经纬度信息转换成地址信息 并显示在布控球列表中
+
+
+【0.7.1】20210902
+<br>
+- 优化 - 添加布控球时列表排序，在线设备往前排序
+- 优化 - 会议成员列表中，可移除未加入的会议成员
+
+【0.7.0】20210830
+<br>
+- 开发 - 新增拉入、移除会议成员
+- 开发 - 新增拉入、移除布控球设备
+
+【0.6.3】20210816
+<br>
+- 修复 - 设备退出时的逻辑处理
+
+【0.6.1】20210813
+<br>
+- 开发 - 会议中拉入新成员
+
+
+20210811
+<br>
+- 开发 - 视频会议拉摄像头
+- 优化 - 摄像头拉流失败的提示
+- 优化 - 退出视频会议时，关闭摄像头、麦克风采流。
+
+20210804
+<br>
+- 修复云台控制图标显示
+- 修复荣耀平板上部分浏览器不支持H264解码
+
+20210729
+<br>
+- 修复退出会议BUG。
+- 新增videoConferencingPlayerV2组件。
+- 弃用旧版会议组件，移除旧版文档。
+
+20210615
+<br>
+- 视频会议组件新增deviceItemStyle属性，用于控制视频会议设备框的样式。
+- 优化直播与视频会议同时发起时的逻辑。
+- 修改视频会议设备框显示用户名称。
+
+## 组件按需引入
+
+## 【直播播放器组件】
+##### 支持功能
+- 设备视频点播
+- 云台控制
+##### 引入方式
+import { monitorPlayer } from 'hy-rtc'
+
+### props参数
+名称 | 类型 | 用途 | 示例 | 必填
+---|---|---|---|---
+serverInfo|Object|【服务器连接信息】<br>host: MQTT服务器地址<br>clientId：客户ID<br>username：用户名<br>密码：password<br>port：服务端口|按实际情况填写，可参考Demo|是
+controlMenus | Array |【播放器中的按钮】 <br>云台控制："controller"<br>停止播放："stop"<br>全屏："fullScreen"<br>静音："muted"<br>|controlMenus: ['stop','fullScreen', 'muted' ]|否
+screenCount | Number |分屏数量(目前支持1、4、9)|1 (默认值：4)|否
+width|String|播放器宽度|960px (默认值：800px)|否
+height|String|播放器高度|640px (默认值：600px)|否
+
+### 发起直播 （callMonitor）
+#### 调用示例
+```javascript 
+const monitorList = [
+    {
+      deviceId: '44030700001320000001', // 设备名称
+      deviceObj: {
+        name: '人员1', // 设备人员名称
+        companyNameStr: '部门1' // 部门名称
+      }
+    }
+  ]
+this.$refs.monitorPlayer.callMonitor(monitorList)
+```
+
+### 关闭直播（closeMonitor）
+#### 调用示例
+```javascript
+this.$refs.monitorPlayer.closeMonitor()
+```
+
+## 【视频会议播放器组件】
+##### 支持功能
+- 加入房间
+- 退出房间
+- 关闭 | 开启 本地摄像头
+- 关闭 | 开启 本地麦克风
+- 设置主持人
+##### 开发说明
+- 请使用https环境进行开发，本地调试时，可将vue.config.js中devServer -> https设置为true
+- 调试时，请确保当前浏览页 网站设置 -> 权限 -> 摄像头 为开启状态
+- 谷歌浏览器进入设置白名单 chrome://flags/#unsafely-treat-insecure-origin-as-secure
+
+##### 引入方式
+import { videoConferencingPlayerV2 } from 'hy-rtc'
+
+### props参数
+名称 | 类型 | 用途 | 示例 | 必填
+---|---|---|---|---
+serverInfo|Object|【服务器连接信息】<br>host: MQTT服务器地址<br>clientId：客户ID<br>username：用户名<br>密码：password<br>port：服务端口|按实际情况填写，可参考Demo|是
+width|String|播放器宽度|960px (默认值：800px)|否
+height|String|播放器高度|640px (默认值：600px)|否
+
+### 加入会议 （joinChannel）
+<br>
+先使用服务端api获取会议列表
+<br>
+获取后将会议id传入
+<br>
+
+```javascript
+joinChannel () {
+  const channel = {
+    id: 16
+  }
+  this.$refs.videoConferencingPlayerV2.joinChannel(channel)
+}
+```
+
+### 退出会议
+方法名（outChannel）
+```javascript
+outChannel () {
+  this.$refs.videoConferencingPlayerV2.outChannel()
+}
+```
+
+### 退出会议事件
+事件名称：on-outChannel
+点击退出会议时触发
+```html
+<videoConferencingPlayerV2 @on-outChannel="onOutChannel" ······></videoConferencingPlayerV2>
+```

package/lib/demo.html

@@ -0,0 +1,10 @@
+<meta charset="utf-8">
+<title>hy-rtc-sdkComponents demo</title>
+<script src="./hy-rtc-sdkComponents.umd.js"></script>
+
+<link rel="stylesheet" href="./hy-rtc-sdkComponents.css">
+
+
+<script>
+console.log(hy-rtc-sdkComponents)
+</script>