larksr_websdk 3.2.324 → 3.2.327

package/dist/doc/config.md

@@ -40,7 +40,18 @@ interface ILarkSRConfig {
      * 注意，当关闭时不会自动填充根元素，如果根元素高度为 0 将显示不出来。
      * 注意，当关闭时 mobileForceLandscape 将失去作用。
      */
+    handleRootElementSize?: boolean;
+    /**
+     * 同 handleRootElementSize
+     */
     handelRootElementSize?: boolean;
+    /**
+     * 是否只设置根的组件的旋转。只当 handleRootElementSize 为 true 时有效。设置根组件的旋转用于 mobileForceLandscape 模式。
+     * 默认为false，此时 SDK 会设置根组件的宽高,margin 0,padding 0
+     * 为true并且handleRootElementSize也为true时，只设置根组件的旋转属性，用于强制横屏模式以及强制横屏竖屏的切换。
+     * 要注意onlyHandleRootElementTransform开启成功时，要保证根节点的元素大小并且当根节点变化时应调用 resize 方法通知更新根节点的大小。
+     */
+    onlyHandleRootElementTransform?: boolean;
     /**
      * 是否在sdk内部监听鼠标键盘等输入事件
      * 如果关闭需要手动发送输入事件
@@ -52,7 +63,7 @@ interface ILarkSRConfig {
      * 当视频播自动放失败时是否尝试静音播放,静音播放时将抛出事件
      * 静音播放当用户操作屏幕时将尝试播放声音
      */
-    mutePlayWhenFiled?: boolean;
+    mutePlayWhenFailed?: boolean;
     /**
      * 可选项，是否是 vr 监控类型。
      */

package/dist/doc/functions.md

@@ -5,6 +5,12 @@ LarkSR 对象成员方法主要分为以下三类
 ## 控制流程方法，包括启动，关闭，重启，注册授权码等。
 
 ```typescript
+/**
+* 单独设置服务器地址，作用同 config 中的 serverAddress 字段
+* 在进入应用之前都可以更新。
+* @param serverAddress 服务器地址，如 http://192.168.0.55:8181/
+*/
+updateServerAddress(serverAddress: string): void;
 /**
  *
  * @param id sdk id 初始化sdkid
@@ -298,7 +304,7 @@ larksr.on('aivoicedmresult', (e) => {
 客户端打开后云端应用可直接通过读取声卡上的麦克风接收到音频。
 
 > 该功能匹配的服务端版本最低为 V3.2.51
-> 使用该功能要注意在后台开启智能语音功能
+> 使用该功能要注意在后台开启语音输入功能
 > 注意要在连接成功之后打开媒体设备。即 `mediaPlayed` 之后调用才有效
 
 ```typescript
@@ -446,9 +452,11 @@ RTMP_STREAM_ERROR = "rtmpstreamerror"
 /**
  * 采集一帧图像
  * @params data: any 抛出采集事件时抛出的附加data，比如采集的时间戳
+ * @params option:  { width: number, height: number } 截图的宽高，如果未设置则使用云端应用窗口的宽高
  * @return { data: any, base64: base64string } 返回传入的 data 和采集的 base64 字符串
  */
-captrueFrame(data: any)
+captrueFrame(data: any, option?: { width: number; height: number;})
+
 /**
  * 设置是否强制横屏显示内容.
  * handelRootElementSize 必须设置为 true 才有作用。

package/dist/doc/update.md

@@ -248,4 +248,32 @@ larksr.op.gestureHandler.tapLimitTimeout = 100;
 5. 添加  `RTMP_STREAM_STATE  = "rtmpstreamstate"` 事件，返回云端直播推流事件
 6. 添加 `RTMP_STREAM_ERROR = "rtmpstreamerror"` 事件，返回云端直播推流错误
 7. 添加 `larksr.StartCloudLiveStreaming(params)` 接口，启动云端直播推流功能
-8. 添加 `larksr.StopLiveStreaming()` 接口，关闭云端直播推流功能.
+8. 添加 `larksr.StopLiveStreaming()` 接口，关闭云端直播推流功能.
+
+## V3.2.326
+
+1. 截图接口 `captrueFrame(data: any, option?: { width: number; height: number;})` 添加 option 参数，可以设置截图的宽高
+2. 添加 onlyHandleRootElementTransform 参数 `new LarkSR({ ... 此处省略其他配置 ... onlyHandleRootElementTransform: 0})`
+
+```javascript
+/**
+* 是否只设置根的组件的旋转。只当 handleRootElementSize 为 true 时有效。设置根组件的旋转用于 mobileForceLandscape 模式。
+* 默认为false，此时 SDK 会设置根组件的宽高,margin 0,padding 0
+* 为true并且handleRootElementSize也为true时，只设置根组件的旋转属性，用于强制横屏模式以及强制横屏竖屏的切换。
+* 要注意onlyHandleRootElementTransform开启成功时，要保证根节点的元素大小并且当根节点变化时应调用 resize 方法通知更新根节点的大小。
+*/
+onlyHandleRootElementTransform?: boolean;
+```
+
+## V3.2.327
+
+1. 添加方法 `larksr.updateServerAddress(serverAddress: string)`,可在 `new LarkSR()` 之后再更新服务器地址。用于需要异步设服务器地址的情况。
+
+```javascript
+/**
+* 单独设置服务器地址，作用同 config 中的 serverAddress 字段
+* 在进入应用之前都可以更新。
+* @param serverAddress 服务器地址，如 http://192.168.0.55:8181/
+*/
+updateServerAddress(serverAddress: string): void;
+```