@plasosdk/plaso-electron-sdk 1.3.2 → 1.3.3

package/README.md

@@ -2,6 +2,7 @@
 
 -   MacOS 支持 x64、arm64架构
 -   Windows 支持 x86、x64架构
+
 **<font color=red>Electron 版本要求： 14.0.0~22.3.27</font>**
 
 # 1、接入步骤
@@ -58,11 +59,7 @@ MacOS打包完毕后，建议安装打好的包后自行验证上述的操作时
 
 ## 1.2、使用
 
-### 1.2.1、npm 包位置
-
-将下载的 npm 包放到 应用本地的`node_modules`目录下，一般是 electron 应用的`resources/app`目录下
-
-### 1.2.2、主进程
+### 1.2.1、在主进程中使用
 
 需要在主进程加载 `@plasosdk/plaso-electron-sdk` 依赖包
 
@@ -84,35 +81,15 @@ const { initRemoteMain } = require('@plasosdk/plaso-electron-sdk');
 initRemoteMain(remoteMain);
 ```
 
-### 1.2.3、渲染进程
-
-#### 1.2.3.1、打开 实时课堂
-
-（1）调用方法：**createLiveClassWindow**
-
-（2）入参参考： [2、实时课堂参数说明](#2、实时课堂入参说明)
-
-#### 1.2.3.2、打开备课课堂
+### 1.2.2、在渲染进程中使用
 
-（1）调用方法：**createPrepareClassWindow**
-
-（2）入参参考：[3、备课课堂参数说明](#3、备课课堂入参说明)
-
-#### 1.2.3.3、[确定日志的写入位置](#5.1、initLogConfig)
-
-```ts
-// 代码示例
-const PlasoElectronSdk = window.require('@plasosdk/plaso-electron-sdk');
-const logFilePath = 'C:/Users/userName/Desktop/electronDemo/electron12.0.18_x32/resources/app';
-PlasoElectronSdk.initLogConfig(logFilePath);
-```
-
-#### 1.2.3.4、[创建 课堂/备课 窗口](#5.3、createLiveClassWindow)
+<a id="open-sdk-window-params"></a>
 
+**打开实时课堂/备课课堂方法入参类型定义**
 ```ts
 interface CreateClassPamras {
     classOptions: Object;
-    electronWinOptions?: Object;
+    electronWinOptions?: Electron.BrowserWindowConstructorOptions;
     onClassWindowReadyFn?: (winId: number) => void
     onClassWindowLeaveFn?: (winId: number) => void
     onClassFinishedFn?: (meetingId: string) => void;
@@ -126,17 +103,32 @@ interface CreateClassPamras {
     onOpenResourceCenterFn?: () => void;
     onGetExtFileNameFn?: (...args: any[]) => Promise<string>;
 }
+```
 
+#### 1.2.3.1、打开实时课堂
+
+```ts
 // 代码示例
 const PlasoElectronSdk = window.require('@plasosdk/plaso-electron-sdk');
-const createClassParams: CreateClassPamras = { classOptions: { query } };
+const createLiveClassParams: CreateClassPamras = { classOptions: { query } };
+PlasoElectronSdk.createLiveClassWindow(createLiveClassParams);
+```
 
-//创建实时课堂
-PlasoElectronSdk.createLiveClassWindow(createClassParams);
-// or 创建备课课堂
+入参详见[实时课堂参数说明](#live-class-params)
+
+#### 1.2.3.2、打开备课课堂
+
+```ts
+// 代码示例
+const PlasoElectronSdk = window.require('@plasosdk/plaso-electron-sdk');
+const createPrepareClassParams: CreateClassPamras = { classOptions: { loginName: 'hello', userName: 'world' } };
 PlasoElectronSdk.createPrepareClassWindow(createClassParams);
 ```
 
+入参详见[备课课堂入参说明](#prepare-class-params)
+
+
+<a id="live-class-params"></a>
 # 2、实时课堂入参说明
 
 ## 2.1、参数 classOptions
@@ -149,7 +141,7 @@ PlasoElectronSdk.createPrepareClassWindow(createClassParams);
 
 | 参数 | 是否必传 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- | --- |
-| query | 是 | string | 无 | 进课堂必传字段，具体拼接逻辑见下文[query 属性说明](#211query-属性) |
+| query | 是 | string | 无 | 进课堂必传字段，具体拼接逻辑见下文[query 属性说明](#query) |
 | displayAvatarUrl | 否 | string | 无 | 用户头像地址 |
 | classMembers | 否 | object[] | 无 | 1、课对应的班级用户信息<br />2、初始化课堂参与人<br /><br />3、最多支持 2000 人，需要支持更多学生需要联系伯索平台进行额外申请<br />{<br /><br />/** 唯一标识该用户的 id \*/<br />loginName: string,<br /><br />/** 用户显示的姓名 _/<br />name: string,<br />/\*\* 用户角色，"speaker","assistant","listener","superlistener" 之一 _/<br />upimeRole: string,<br />/** 用户的 id，和云学堂业务强相关，sdk 用户非必要 \*/<br />unique_id: number \| string<br />/** 用户头像图片的 url，非必要 \*/<br />displayAvatarUrl: string,<br />} |
 | enableENC | 否 | boolean | true | 是否启用降噪 |
@@ -163,6 +155,7 @@ PlasoElectronSdk.createPrepareClassWindow(createClassParams);
 | residentCamera | 否 | boolean | false | 常驻摄像头：只对学生或游客生效 |
 |  |  |  |  |  |
 
+<a id="query"></a>
 ### 2.1.1、query 属性
 
 **query 属性格式示例**：
@@ -213,7 +206,7 @@ interface IQueryParams {
 | 参数 | 类型 | 说明 |
 | --- | --- | --- |
 | appId | string | 在申请接入时，伯索平台给予的 appId |
-| signature | string | 签名字符串，根据queryParams中除去signature参数的其他参数生成，生成示例参考[根据queryParams对象生成签名字符串](#2112根据-queryParams-对象生成签名字符串) |
+| signature | string | 签名字符串，根据queryParams中除去signature参数的其他参数生成，生成示例参考[根据queryParams对象生成签名字符串](#generate-signature) |
 | validBegin | number | 请求课堂**开始生效起始时间**的 Unix Epoch 时间戳，单位秒：（时间戳/1000 再取整） |
 | validTime | number | 请求的**签名在课堂的有效时间段**（断网重连后会重新校验签名），单位秒，建议: 24 _ 60 _ 60 s |
 | endTime | number | 请求课堂**结束时间**的 Unix Epoch 时间戳，单位秒：（时间戳/1000 再取整） |
@@ -248,11 +241,12 @@ interface IQueryParams {
 | d_sharpness | number | 10 | 无 | 头像推流清晰度、桌面共享清晰度<br />**仅 onlineMode 为 1 时生效**：<br />10：标清 20：高清 21: 高清流畅 30：超清 31: 超清流畅 |
 | isNewMT | number | 0 | 1 | 是否支持 移动授课模式；<br />建议传 1 |
 | d_enableDualCamera | number | 0 | 无 | 是否开启双摄，1：开启，0： 关闭 |
-| recordType | number | 无 | 无 | 配置 recordAvartor 设置录制对象，参数说明参考[附录 9-1](#91recordtype) |
+| recordType | number | 无 | 无 | 配置 recordAvartor 设置录制对象，参数说明参考[附录 9.1](#record-type) |
 | recordAvator | string | '' | 无 | 传入老师/助教的`loginName`表示录制对应人的头像 |
 | recordScreen | string | '' | 无 | 传入'screen'表示录制屏幕（当前仅支持录制老师屏幕）|
 |  |  |  |  |  |
 
+<a id="generate-signature"></a>
 #### 2.1.1.2、根据 queryParams 对象生成签名字符串
 
 （1）**用户把 queryParams 作为参数传给自己的接口，接口返回值必须返回签名字符串：signature**
@@ -314,7 +308,7 @@ function genQuery(queryParams) {
 genQuery(queryParams);
 ```
 
-
+<a id="prepare-class-params"></a>
 # 3、备课课堂入参说明
 
 ## 3.1、参数 classOptions
@@ -344,14 +338,16 @@ genQuery(queryParams);
 
 1、备课课堂直接通过任务栏关闭不会清空本地记录的板书内容，下次进入后会 板书交互会和上次进入的板书 配置一致（即使 d_enableObjectEraser 参数 值变动了）
 
-# 4、实时课堂&备课课堂 通用参数说明
+# 4、打开实时课堂/备课课堂通用参数说明
 
-## 4.1、参数 electronWinOptions
+## 4.1、参数 electronWinOptions 
 
-electron 的窗口参数，详情参考 [electron 官方文档](https://www.electronjs.org/zh/docs/latest/api/browser-window#winwebcontents-%E5%8F%AA%E8%AF%BB)
+> **即将弃用**: 不推荐传入，SDK内部默认设置了一些窗口参数，为了保证最佳体验，不要传入此参数。
+
+Electron的窗口参数，详情参考 [Electron官方文档](https://www.electronjs.org/zh/docs/latest/api/browser-window#new-browserwindowoptions)。
 
 ```ts
-type electronWinOptions = object;
+type electronWinOptions = Electron.BrowserWindowConstructiorOptions;
 ```
 
 ## 4.2、参数回调 onClassWindowReadyFn
@@ -423,20 +419,19 @@ type onOpenResourceCenterFn = () => void;
 type onGetExtFileNameFn = (...args: any[]) => Promise<string>;
 ```
 
-# 5、对外的交互方法
+# 5、API参考
 
-## 5.1、initLogConfig
+## 5.1、PlasoElectronSdk.initLogConfig
 
 **初始化课堂窗口日志位置**，窗口崩溃时会在同级目录下生成 reports 文件夹存储 dump，**在 调用 createLiveClassWindow 前设置**
 
 **日志默认位置**：
 
-```
-windows：C:\Users\${userName}\AppData\Roaming\\${appName}\P403FileTemp
-```
+```js
+require('path').join(require('electron').app.getPath('userData'), 'P403FileTemp');
 
-```ts
-path.join(remote.app.getPath('userData'), '/P403FileTemp/');
+// Windows：C:\Users\${userName}\AppData\Roaming\${appName}\P403FileTemp
+// Mac：/Users/${userName}/Application\ Support/${appName}/P403FileTemp
 ```
 
 参数示例：
@@ -448,7 +443,7 @@ const logFilePath = 'C:/Users/userName/Desktop/electronDemo/electron12.0.18_x32/
 PlasoElectronSdk.initLogConfig(logFilePath);
 ```
 
-## 5.2、getVersion
+## 5.2、PlasoElectronSdk.getVersion
 
 返回包的版本，格式：x.x.x
 
@@ -456,87 +451,26 @@ PlasoElectronSdk.initLogConfig(logFilePath);
 type getVersion = () => string;
 ```
 
-## 5.3、createLiveClassWindow
+## 5.3、PlasoElectronSdk.createLiveClassWindow
 
-**创建实时课堂窗口**，入参参考 见 “[**2、实时课堂入参说明**](#2、实时课堂入参说明)”
+**创建实时课堂窗口**
 
 ```ts
-/**
- * @typedef {Object} classOptionsType
- * @property {boolean} [debug] - 是否开启课堂窗口debug模式
- * @property {string} query - 进课堂的必备query
- * @property {string} [version] - 格式参考：1.53.901
- */
-
-/**
- * @typedef {Object} FileParams
- * @property {string[]} filePath - 备课文件本地地址
- * @property {'png' | 'pb' | string} fileType
- */
-
-/**
- * @typedef {Object} classWindowType
- * @property {classOptionsType} classOptions 进课堂参数对象
- * @property {Object} [electronWinOptions] 自定义electron的窗口参数
- * @property {(winId: number)=>void} [onClassWindowReadyFn] 课堂窗口打开渲染成功后的回调
- * @property {(winId: number)=>void} [onClassWindowLeaveFn] 课堂窗口关闭后的回调
- * @property {(meetingId: string)=>void} [onClassFinishedFn] 课堂结束后的回调
- * @property {(
- *   params: {
- *     fileInfo: FileParams[],
- *     fileName?: string
- *   },
- *   callback: (result: boolean) => void
- * ) => void} [onSaveBoardFn] 保存板书，具体的保存逻辑由外部实现，取消保存板书时，callback传false, 不然传true
- * @property {()=>void} [onOpenResourceCenterFn] 通知外部用户打开自己的资料中心，资料中心的具体ui和逻辑由外部用户自己实现
- *
- */
-
-/**
- * @param {classWindowType} classWindowProps
- * @returns
- */
-function createClassWindow(classWindowProps) {/**
- * @typedef {Object} classOptionsType
- * @property {boolean} [debug] - 是否开启课堂窗口debug模式
- * @property {string} query - 进课堂的必备query，其中部分参数需要签名
- */
-
-/**
- * @typedef {Object} liveClassWindowType
- * @property {classOptionsType} classOptions 进课堂参数对象
- * @property {Object} [electronWinOptions] 自定义electron的窗口参数
- * @property {(winId: number)=>void} [onClassWindowReadyCb] 课堂窗口打开渲染成功后的回调
- * @property {()=>void} [onClassWindowLeaveCb] 课堂窗口关闭后的回调
- * @property {()=>void} [onClassFinishedCb] 课堂结束后的回调
- */
-
-/**
- * @param {liveClassWindowType} liveClassWindowProps
- * @returns
- */
-function createLiveClassWindow({
-    classOptions,
-    electronWinOptions,
-    onClassWindowReadyCb,
-    onClassWindowLeaveCb,
-    onClassFinishedCb,
-}){
-    ......
-}
+function createLiveClassWindow(params: CreateClassPamras): void;
 ```
+参数详见[打开实时课堂/备课课堂方法入参类型定义](#open-sdk-window-params)
 
-## 5.4、createPrepareClassWindow
+## 5.4、PlasoElectronSdk.createPrepareClassWindow
 
-**创建备课课堂窗口**，入参参考 见 “[**3、备课课堂入参说明**](#3、备课课堂入参说明)”
-
-```
-参数详情 参考 createLiveClassWindow方法的说明
+**创建备课课堂窗口**
+```ts
+function createLiveClassWindow(params: CreateClassPamras): void;
 ```
+参数详见[打开实时课堂/备课课堂方法入参类型定义](#open-sdk-window-params)
 
-## 5.5、insertObject
+## 5.5、PlasoElectronSdk.insertObject
 
-用户从自己的云盘 **往 实时课堂/备课课堂 插入文件**
+用户从自己的资料中心往**实时课堂/备课课堂**插入文件
 
 ```ts
 // 插入的文件类型暴露在PlasoElectronSdk上，PlasoElectronSdk.FILE_TYPE
@@ -703,6 +637,7 @@ try {
 
 # 9、附录参数说明
 
+<a id="record-type"></a>
 ## 9.1、RecordType
 
 | 值  | 说明                            |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasosdk/plaso-electron-sdk",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "伯索课堂Electron SDK",
   "main": "index.js",
   "scripts": {