larksr_websdk 3.2.325 → 3.2.329

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,17 +5,62 @@ LarkSR 对象成员方法主要分为以下三类
 ## 控制流程方法，包括启动，关闭，重启，注册授权码等。
 
 ```typescript
+/**
+* 单独设置服务器地址，作用同 config 中的 serverAddress 字段
+* 在进入应用之前都可以更新。
+* @param serverAddress 服务器地址，如 http://192.168.0.55:8181/
+*/
+updateServerAddress(serverAddress: string): void;
 /**
  *
  * @param id sdk id 初始化sdkid
  * @returns
  */
 initSDKAuthCode(id: string): Promise<void>;
+/**
+ * 使用平行云托管平台时，使用 connectWithPxyHost 连接云端应用
+ * 托管平台 https://www.pingxingyun.com/console/#/
+ * @param params 同 connect 方法
+ * @return 同 connect 方法
+ */
+connectWithPxyHost(params: {
+    appliId: string;
+    playerMode?: number;
+    userType?: number;
+    roomCode?: string;
+    taskId?: string;
+    regionId?: string;
+    groupId?: string;
+}): Promise<void>;
 /**
  * 连接云端渲染资源
  * @params appID 云端资源的 ID
  * @returns Promise 调用接口并校验授权通过返回成功并自动开始连接
- */
+ * Promise 返回的错误对象：
+ * {
+        // type 0 渲染资源不足导致的错误，1 其他错误, 可用 type == 0 判断是否是渲染资源不足类型的错误
+        type: 0,
+
+        // 渲染资源不足时的事件类型，其他情况可能不返回，比如网络错误
+        eventType?：LarkSRClientEvent.RESOURCE_NOT_ENOUGH,
+
+        // 服务端返回的错误码，服务端请求正确返回时存在。需要注意渲染资源不足类型的错误码。
+        // 可用 type == 0 判断是否是渲染资源不足类型的错误,再用 code 进行细节处理，或者只用 type == 0 进行处理。
+        // 813=当前应用的运行数量已达到最大值：{0},请稍后再试
+        // 814=同一appKey下的应用运行数量达到最大值：{0}，请稍后再试
+        // 815=应用运行数量已达到最大授权并发数量，请稍后再试
+        // 816=VR应用运行数量已达到最大授权并发数量，请稍后再试
+        // 817=渲染资源不足，请稍后再试
+        // 820=暂无活跃的GPU节点
+        // 821=节点资源使用率已达到设置的阈值
+        // 823=单节点运行应用数量已达到单节点最大授权并发数量，请稍后再试
+        code?: 817,
+
+        // 错误信息
+        message:? "",
+    }
+    *
+    */
 connect(params: {
     appliId: string;
     playerMode?: number;
@@ -29,7 +74,7 @@ connect(params: {
     appKey?: string;
     timestamp?: string;
     signature?: string;
-}): Promise<void>;
+} | any): Promise<void>;
 /**
  * 重新开始云渲染流程
  */
@@ -446,9 +491,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,150 @@ 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;
+```
+
+## V3.2.329
+
+1. 添加自动播放参数参数 `new LarkSR({ ... 此处省略其他配置 ... autoPlay: true, showPlayButton: true})`
+
+SDK 内部添加播放按钮 UI，当自动播放失败或者手动播放模式时会显示出来，用户点击之后才会播放。
+
+自动播放模式下会尽可能直接播放不用手动点，包括可能静音播放。
+
+```javascript
+/**
+* 是否自动播放。默认开启。
+* 如果关闭，连接成功之后会有提示UI，用户手动触发。
+* 开启自动播放时也不能保证所有浏览器自动播放成功，当播放失败或者浏览器不支持自动播放时，
+* 也会显示播放按钮，用户点击播放按钮手动播放。
+*/
+autoPlay?: boolean;
+/**
+* 在播放失败或者手动播放模式下是否显示播放的按钮。
+* 默认开启。要注意，如果关闭情况下要添加好提示或UI，引导用户点击播放。
+* UI中要让用户触发 larksr.videoComponent.playVideo();
+*/
+showPlayButton?: boolean;
+```
+
+2. 添加语言配置参数 `new LarkSR({ ... 此处省略其他配置 ... language: true})`
+
+```javascript
+/**
+* 语言设置,目前只支持种英文两种
+* zh-CN 中文 en 英文
+*/
+language?: string;
+```
+
+3. 添加渲染资源不足事件，在 `larksr.connect` 方法和 `resourcenotenough` 事件时抛出。可以根据服务端返回的 code 码判断具体情况，提示用户或进行后续处理。
+
+`connect` 方法返回的 Promise:
+
+```javascript
+/**
+ * 连接云端渲染资源
+ * @params appID 云端资源的 ID
+ * @returns Promise 调用接口并校验授权通过返回成功并自动开始连接
+ * Promise 返回的错误对象：
+ * {
+        // type 0 渲染资源不足导致的错误，1 其他错误, 可用 type == 0 判断是否是渲染资源不足类型的错误
+        type: 0,
+
+        // 渲染资源不足时的事件类型，其他情况可能不返回，比如网络错误
+        eventType?：LarkSRClientEvent.RESOURCE_NOT_ENOUGH,
+
+        // 服务端返回的错误码，服务端请求正确返回时存在。需要注意渲染资源不足类型的错误码。
+        // 可用 type == 0 判断是否是渲染资源不足类型的错误,再用 code 进行细节处理，或者只用 type == 0 进行处理。
+        // 813=当前应用的运行数量已达到最大值：{0},请稍后再试
+        // 814=同一appKey下的应用运行数量达到最大值：{0}，请稍后再试
+        // 815=应用运行数量已达到最大授权并发数量，请稍后再试
+        // 816=VR应用运行数量已达到最大授权并发数量，请稍后再试
+        // 817=渲染资源不足，请稍后再试
+        // 820=暂无活跃的GPU节点
+        // 821=节点资源使用率已达到设置的阈值
+        // 823=单节点运行应用数量已达到单节点最大授权并发数量，请稍后再试
+        code?: 817,
+
+        // 错误信息
+        message:? "",
+    }
+*
+*/
+connect(params: {
+    appliId: string;
+    playerMode?: number;
+    userType?: number;
+    roomCode?: string;
+    taskId?: string;
+    clientMac?: string;
+    groupId?: string;
+    regionId?: string;
+    targetServerIp?: string;
+    appKey?: string;
+    timestamp?: string;
+    signature?: string;
+}): Promise<void>;
+```
+ 
+或者单独监听 `resourcenotenough`:
+
+```javascript
+/**
+ * 渲染资源不足
+    * {
+    // 服务端返回的错误码，服务端请求正确返回时存在。需要注意渲染资源不足类型的错误码。
+    // 可用 type == 0 判断是否是渲染资源不足类型的错误,再用 code 进行细节处理，或者只用 type == 0 进行处理。
+    // 813=当前应用的运行数量已达到最大值：{0},请稍后再试
+    // 814=同一appKey下的应用运行数量达到最大值：{0}，请稍后再试
+    // 815=应用运行数量已达到最大授权并发数量，请稍后再试
+    // 816=VR应用运行数量已达到最大授权并发数量，请稍后再试
+    // 817=渲染资源不足，请稍后再试
+    // 820=暂无活跃的GPU节点
+    // 821=节点资源使用率已达到设置的阈值
+    // 823=单节点运行应用数量已达到单节点最大授权并发数量，请稍后再试
+    code?: 817,
+
+    // 错误信息
+    message:? "",
+}
+* 
+*/
+RESOURCE_NOT_ENOUGH = 'resourcenotenough',
+```
+
+```javascript
+// 此处省略 larksr 创建过程
+// 监听连接成功事件
+larksr.on('resourcenotenough', function(e) { 
+    console.log("LarkSRClientEvent RESOURCE_NOT_ENOUGH", e); 
+});
+```