yjz-web-sdk 1.0.11-beta.2 → 1.0.11-beta.4

package/README.md

@@ -487,3 +487,93 @@ onUnmounted(() => {
 
 </style>
 ```
+
+## 通用版本使用
+
+不依赖任何前端框架，直接使用 js 引入。
+
+```js
+import { UniSDK } from 'yjz-web-sdk/uni-sdk';
+```
+
+### 属性 
+
+| 属性      | 描述     |   必填     |  
+| ------------- | ------------- | ------------- |
+| mountedElement | 挂载节点，可以是 HTMLElement 或者 节点 ID | 必填 |
+| connectConfig | webRTC 连接配置信息，从提供连接配置接口获取   | 必填 |
+| isGroup | 开启群控   | 默认是 false |
+| enabledDebug | 开启调试代码，默认为 false  | 可选 |
+| disabledVerticalSwipe | 是否阻止竖向滑动，默认为 false | 可选 |
+| enabledIMEKeyboard |  是否开启IME键盘映射，默认为 false| 可选 |
+| cursorType | 鼠标形状支持 default、circle、triangle，默认是 default。对应的枚举值分别为 0，1，2。  |  可选 |
+
+### 方法
+| 方法      | 描述     |
+| ------------- | ------------- | 
+| goHome  | 返回首页，对应就是 Android Home 键  |
+| goTask  | 任务列表，对应就是 Android 任务键  |
+| goBack  | 返回， 对应就是 Android 返回键 |
+| enableAudio  | 开启音频 |
+| disableAudio  | 禁用音频 |
+| sendClipboardData | 发送剪切板数据 |
+| openIMEKeyboard | 开启键盘映射 |
+| closeIMEKeyboard | 关闭键盘映射 |
+| switchToGestureNavigation | 切换手势导航 |
+| switchToThreeButtonNavigation | 切换三按钮导航 |
+| changeLevel | 设置清晰度，通过 UniSDK.CLARITY_LEVEL 访问对应的支持清晰度，目前支持流畅、标清、超清 |
+| destroy | 销毁实例 |
+
+### 事件
+
+| 事件     | 描述     |
+| ------------- | ------------- | 
+| loadedSuccess  | 加载成功   |
+| loadedFailure  | 加载失败  |
+| stopConnect  | 断开连接  |
+| statisticInfo  | 更新实时统计信息，信息包括: framesPerSecond: 帧率, bitrate: 码率, lostRate: 丢包率,currentRoundTripTime: 网络延时, averageDecodeTime: 每秒解码延时|
+| error  | 投屏相关错误  |
+
+### 使用示例
+
+```ts
+  const player = new UniSDK({
+      mountedElement: "#player-mounted",  // 挂载节点，可以是 HTMLElement 或者 节点 ID
+      isGroup: false, // 群控模式，默认 false
+      disabled: true, // 禁用
+      enabledDebug: process.env.NODE_ENV !== 'production', // 开发环境下开启日志，默认 false
+      disabledVerticalSwipe: false, // 是否阻止竖向滑动默认 false
+      enabledKeyMapping: false,     // 是否开启键盘映射，默认 false
+      cursorType: UniSDK.CURSOR_TYPE.CIRCLE_CURSOR, // 光标类型，默认 CIRCLE_CURSOR
+      connectConfig: {
+        "signalServerUrl": "*",
+        "roomId": "*",
+        "turnServerUri": "*",
+        "token": "*",
+        "hostTurn": [*],
+        "spareTurn": [*]
+    }
+  });
+
+  player.addListener(UniSDK.EVENTS.CONNECTED, () => {
+      console.log('建立连接');
+  });
+
+  player.addListener(UniSDK.EVENTS.LOADED_SUCCESS, () => {
+      console.log('投屏成功');
+  });
+
+  player.addListener(UniSDK.EVENTS.LOADED_FAILURE, (error: any) => {
+      console.log('投屏失败', error);
+  });
+
+  player.addListener(UniSDK.EVENTS.STATISTIC_INFO, (info: any) => {
+      console.log('统计信息', info);
+  });
+
+  player.addListener(UniSDK.EVENTS.CLARITY_LEVEL_CHANGE, (level: number) => {
+      console.log('清晰度更新', level);
+  });
+  
+  player.init();
+```