larksr_websdk 3.2.321 → 3.2.324

package/dist/doc/events.md

@@ -106,6 +106,16 @@ declare const enum LarkSRClientEvent {
      * 截图成功.
      */
     CAPTURE_FRAME = "captureframe",
+    /**
+     * 服务端 3.2.7.0 添加
+     * rtmp 直播推流状态
+     */
+    RTMP_STREAM_STATE = "rtmpstreamstate",
+    /**
+     * 服务端 3.2.7.0 添加
+     * rtmp 直播推流出错
+     */
+    RTMP_STREAM_ERROR = "rtmpstreamerror"
     /**
      * 数据通道打开 .
      */
@@ -134,6 +144,6 @@ declare const enum LarkSRClientEvent {
     /**
      * 一般信息提示
      */
-    INFO = "info"
+    INFO = "info",
 }
 ```

package/dist/doc/functions.md

@@ -389,6 +389,57 @@ larksr 配置项自动打开视频输入配置,在`new LarkSR({ ... 此处省略
 videoInputAutoStart?: boolean;
 ```
 
+## 云端直播推流功能
+
+> 服务端 3.2.7.0 添加， 要注意使用云端直播推流功能要在后台应用管理中开启该功能
+
+```javascript
+/**
+* 启动云端推流功能
+* @param params {
+*  // rtmp push url 必须填
+*  path: "",
+*  //rtmp push key
+*  key: "",
+*  // 推流的宽
+*  width: 1280,
+*  // 推流的高
+*  height: 720,
+*  framerate: 30,
+*  // kbps
+*  bitrate: 1024 * 2,
+*  // 是否支持断线重连
+*  reconnect: true,
+*  //最大重连次数
+*  reconnectRetries: 3,
+*  //是否串流麦克风(语音输入支持的情况)
+*  voice: audioInput,
+* }
+* @returns Promise
+*/
+StartCloudLiveStreaming(params: CloudLark.IRtmp_Start): Promise<void> | undefined;
+/**
+* 关闭云端推流功能
+* @returns
+*/
+StopLiveStreaming(): void | undefined;
+```
+
+云端直播的相关状态参考 `RTMP_STREAM_STATE` 和 `RTMP_STREAM_ERROR` 两个事件
+
+```javascript
+/**
+* 服务端 3.2.7.0 添加
+* rtmp 直播推流状态
+*/
+RTMP_STREAM_STATE = "rtmpstreamstate",
+/**
+* 服务端 3.2.7.0 添加
+* rtmp 直播推流出错
+*/
+RTMP_STREAM_ERROR = "rtmpstreamerror"
+```
+
 ## 其他
 
 ```typescript

package/dist/doc/member_variables.md

@@ -37,7 +37,7 @@ larksr.videoElement;
 
 ```javascript
 // 是否显示移动端触摸点
-larksr.isEnableTouchPonit = false;
+larksr.isEnableTouchPoint = false;
 // 是否显示载入画面时底部文字
 larksr.isEnableLoadingStateBar = false;
 ```
@@ -47,6 +47,69 @@ larksr.isEnableLoadingStateBar = false;
 larksr.scaleMode = ScaleMode.CONTAIN_APP;
 ```
 
+4. 虚拟鼠标和触摸点
+
+```javascript
+/**
+ * 虚拟鼠标的当前位置,相对于整体容器
+ */
+larksr.virtualCursorPosition
+/**
+ * 虚拟鼠标的当前位置,内部缩放容器，与实际显示虚拟鼠标 CSS 样式相同
+ */
+larksr.virtualCursorPositionRaw
+```
+
+例：
+
+下面示例代码使用 react 演示点击一个按钮，同步一个外层的元素和虚拟鼠标的位置
+
+```javascript
+// ....
+// 省略 react 创建代码
+export default class App extends React.Component {
+    private state: any = {
+        pointPosition: {
+            x: 0,
+            y: 0,
+        }
+    };
+    // ....
+    // 此处省略 larksr 创建过程等其他代码
+    render() {
+        return (
+            <div>
+                // ...
+                // 省略其他元素
+                <div style={{
+                        zIndex: 1000,
+                        position: 'absolute', 
+                        left: this.state.pointPosition.x, 
+                        top: this.state.pointPosition.y,
+                        backgroundColor: "red",
+                        width: 50,
+                        height: 50,
+                        borderRadius: "50%"
+                    }}>
+                </div>
+                <button style={{pointerEvents: "all"}} 
+                    onClick={()=>{
+                        // 获取虚拟鼠标的位置
+                        console.log("touch point", this.larksr.virtualCursorPosition);
+                        // 同步虚拟鼠标的位置
+                        this.setState({
+                            pointPosition: this.larksr.virtualCursorPosition,
+                        })
+                    }}
+                    >
+                    touchPoint
+                </button>
+            </div>
+        )
+    }
+}
+```
+
 ## 配置参数
 
 ```javascript
@@ -183,7 +246,7 @@ larksr.op.gestureHandler.tapLimitTimeout = 100;
 
 可以通过拦截触摸事件回调的方式，设置具体的触摸事件和鼠标事件的对应关系。
 
-> 通过 larksr.op.gestureHandler 设置回调函数
+> 通过 larksr.op.gestureHandler.gestureCallback 设置回调函数
 > 下面例子中的 GESTURE_TYPE 为 SDK 导出的手势事件类型，如果用 amd 方式引入的 SDK，所有导出类型均在 larksr_websdk 全局对象下。
 > 如果是使用其他方式引入 SDK，如 improt 方式导入 `import { GESTURE_TYPE } from 'larksr_websdk'`
 > 以下示例代码忽略 larksr 创建等过程
@@ -200,7 +263,7 @@ larksr.op.gestureHandler.tapLimitTimeout = 100;
 //      rawEvent: any;      未转换为云端坐标的触摸事件
 //    }
 // 
-larksr.op.gestureHandler = (event) => {
+larksr.op.gestureHandler.gestureCallback = (event) => {
     console.log(event);
     const p = event;
     switch (event.type) {

package/dist/doc/update.md

@@ -233,3 +233,19 @@ larksr.op.gestureHandler.tapLimitTimeout = 100;
 ```
 
 可用通过 gestureHandler 拦截触摸事件回调, 通过 `larksr.op.gestureHandler` 设置回调函数
+
+## V3.2.322
+
+1. 修复某些情况下后台设置的 LOGO 会闪一下默认 LOGO 的问题
+2. 添加 `larksr.virtualCursorPosition` 和 `larksr.virtualCursorPositionRaw` (省略 larksr 对象创建代码) 获取当前虚拟鼠标或者触摸点的位置。
+
+## V3.2.324
+
+1. 修复 iOS 屏幕高度判断问题
+2. 添加获取应用列表接口 `API.GetAppliList(server: string, params: any);`
+3. 添加获取区域列表接口 `API.RegionList(server: string, params: any);`
+4. 添加获取后台配置UI接口 `larksr.getTouchCtrMapping()`
+5. 添加  `RTMP_STREAM_STATE  = "rtmpstreamstate"` 事件，返回云端直播推流事件
+6. 添加 `RTMP_STREAM_ERROR = "rtmpstreamerror"` 事件，返回云端直播推流错误
+7. 添加 `larksr.StartCloudLiveStreaming(params)` 接口，启动云端直播推流功能
+8. 添加 `larksr.StopLiveStreaming()` 接口，关闭云端直播推流功能.