larksr_websdk 3.2.327 → 3.2.330

package/dist/doc/config.md

@@ -11,22 +11,24 @@ interface ILarkSRConfig {
      * 必选项 根元素。组件会挂载到跟元素下面
      * 注意*不要*设置为 document.documentElement
      * 默认模式下会通过旋转根元素实现强制横屏模式。
-     * @see handelRootElementSize
+     * @see handleRootElementSize
      * @see scaleMode
      */
     rootElement: HTMLElement;
     /**
-     * 必选项 服务器地址. LarkServer 前台访问的地址
+     * 可选项 服务器地址. LarkServer 前台访问的地址
      * 如： http://192.168.0.55:8181/
+     * 当使用托管服务时服务器地址自动分配,可留空。
+     * 使用托管服务时@see CreateLarkSRClientFromePXYHost @see larksr.connectWithPxyHost
      */
-    serverAddress: string;
+    serverAddress?: string;
     /**
      * 可选项。 sdk 授权码。如果不在此处填，则必须在后续的实例里调用 initSDKAuthCode 初始化。
      */
     authCode?: string;
     /**
      * 可选项，授权是否成功
-     *  @deprecated 目前不会回调该参数。如果SDK验证失败将在 connect 返回失败
+     * @deprecated 目前不会回调该参数。如果SDK验证失败将在 connect 返回失败
      */
     authCodeCallback?: (isSuccess: boolean, e: any) => void;
     /**
@@ -95,13 +97,14 @@ interface ILarkSRConfig {
     /**
      * 可选项，优选选择的视频编码格式
      */
-    perferDecoder?: 'auto' | 'vp8' | 'vp9' | 'h264' | 'av1x';
+    preferDecoder?: 'auto' | 'vp8' | 'vp9' | 'h264' | 'h265' | 'hevc' | 'av1x';
     /**
      * 可选项，视频在容器中的缩放模式
-     * 'contain' | 'fill_clip' | 'fill_stretch'
+     * ScaleMode: 'contain' | 'fill_clip' | 'fill_stretch'
      * contain: 以应用原始尺寸的缩放
      * fill_clip: 裁剪模式，完全填充屏幕但保留宽高比
      * fill_stretch: 拉伸模式，完全填充屏幕但不保留宽高比
+     * 对应后台应用管理->应用编辑->通用高级设置->窗口初始显示方式,该配置优先级高于后台配置
      */
     scaleMode?: ScaleMode;
     /**
@@ -109,17 +112,27 @@ interface ILarkSRConfig {
      *  0 -》 用户手动触发
      *  1 -》 首次点击进入触发
      *  2 -》 每次点击触发
+     * 对应后台应用管理->应用编辑->通用高级设置->全屏模式,该配置优先级高于后台配置
      */
     fullScreenMode?: number;
     /**
      * 可选项，手机端的全屏模式，值同  fullScreenMode
+     * 对应后台应用管理->应用编辑->移动端高级设置->全屏模式,该配置优先级高于后台配置
      */
     mobileFullScreenMode?: number;
     /**
      * 可选项，手机端是否强制横屏
+     * 对应后台应用管理->应用编辑->移动端高级设置->手机端时是否强制横屏,该配置优先级高于后台配置
      */
     mobileForceLandscape?: boolean;
     /**
+     * 可选项
+     * 初始化鼠标模式, true 锁定，false 非锁定
+     * 对应后台应用管理->应用编辑->通用高级设置->初始化鼠标模式,该配置优先级高于后台配置
+     */
+    initCursorMode?: boolean;
+    /**
+     * 可选项
      * 渲染服务器外网端口映射
      * 格式为  key=[渲染服务器IP:PORT] value=[外网IP:PORT]
      * {
@@ -133,26 +146,28 @@ interface ILarkSRConfig {
      */
     publicPortMapping?: PublicPortMapping;
     /**
+     * 可选项
      * 是否提示输入文字 APP_REQUEST_INPUT
      * 当服务端检测到输入法事件后会抛出事件，可在 web 层添加输入框，配合 inputText 发送文字到云端
      * 默认打开，当手动关闭时将不会抛出 APP_REQUEST_INPUT 事件
      */
     textInputEventPrompt?: boolean;
-
     /**
+     * 可选项
      * 当启用音频输入功能，是否自动连入音频设备。
      * 默认关闭。
-     * 需要注意默认打开的时系统中默认的音频设备。
+     * 需要注意默认打开的是系统中默认的音频设备。
      */
     audioInputAutoStart?: boolean;
-
     /**
+     * 可选项
      * 当启用视频输入功能，是否自动连入视频设备。
      * 默认关闭。
      * 需要注意默认打开的是系统中默认的视频设备。
      */
     videoInputAutoStart?: boolean;
     /**
+     * 可选项
      * mouseZoomDirection
      * 用于移动端捏合缩放操作与应用鼠标缩放的对应关系
      * 1:鼠标滚轮向上为放大，
@@ -160,10 +175,38 @@ interface ILarkSRConfig {
      */
     mouseZoomDirection?: number;
     /**
-     * 触摸指令模式，对应后台应用管理->应用编辑->移动端高级设置->触摸指令模式 优先级高于后台配置
+     * 可选项
      * 触摸指令，移动端的触摸指令对应为云端的触屏还是鼠标
      * 'touchScreen' | 'mouse'
+     * 触摸指令模式，对应后台应用管理->应用编辑->移动端高级设置->触摸指令模式 优先级高于后台配置
      */
     touchOperateMode?: 'touchScreen' | 'mouse';
+    /**
+     * 可选项
+     * 优先使用渲染服务器点对点连接外网ip
+     * 如果配置将覆盖后台设置的 preferPublicIp 参数
+     */
+    preferPublicIp?: string;
+    /**
+     * 可选项
+     * 是否自动播放。默认开启。
+     * 如果关闭，连接成功之后会有提示UI，用户手动触发。
+     * 开启自动播放时也不能保证所有浏览器自动播放成功，当播放失败或者浏览器不支持自动播放时，
+     * 也会显示播放按钮，用户点击播放按钮手动播放。
+     */
+    autoPlay?: boolean;
+    /**
+     * 可选项
+     * 在播放失败或者手动播放模式下是否显示播放的按钮。
+     * 默认开启。要注意，如果关闭情况下要添加好提示或UI，引导用户点击播放。
+     * UI中要让用户触发 larksr.videoComponent.playVideo();
+     */
+    showPlayButton?: boolean;
+    /**
+     * 可选项
+     * 语言设置,目前只支持种英文两种,默认中文
+     * zh-CN 中文 en 英文
+     */
+    language?: string;
 }
 ```

package/dist/doc/events.md

@@ -24,12 +24,32 @@ declare const enum LarkSRClientEvent {
     /**
      * TASK 创建成功，返回 Task 相关信息
      */
-    TASK_CREATE_SUCCESS = 'taskcreatesuccess',
-
+    TASK_CREATE_SUCCESS = "taskcreatesuccess",
     /**
      * TASK 创建失败
      */
-    TASK_CREATE_FAILED = 'taskcreatefailed',
+    TASK_CREATE_FAILED = "taskcreatefailed",
+    /**
+     * 渲染资源不足
+      * {
+            // 服务端返回的错误码，服务端请求正确返回时存在。需要注意渲染资源不足类型的错误码。
+            // 可用 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",
     /**
      * 连接渲染服务器成功 .
      */
@@ -53,7 +73,11 @@ declare const enum LarkSRClientEvent {
     /**
      * 获取到远端视频流 .
      */
-    GOT_REMOTE_STREAM = "gotremotesteam",
+    GOT_REMOTE_STREAM = "gotremotestream",
+    /**
+     * 获取到远端音频流 .
+     */
+    GOT_REMOTE_AUDIO_STREAM = "gotremoteaudiostream",
     /**
      * 视频加载成功，等待播放 .
      */
@@ -106,16 +130,6 @@ 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"
     /**
      * 数据通道打开 .
      */
@@ -145,5 +159,36 @@ declare const enum LarkSRClientEvent {
      * 一般信息提示
      */
     INFO = "info",
+    /**
+     * 语音对话的状态
+     */
+    AI_VOICE_STATUS = "aivoicestatus",
+    /**
+     * 语音识别转文字的结果
+     */
+    AI_VOICE_ASR_RESULT = "aivoiceasrresult",
+    /**
+     * 对话返回的结果
+     */
+    AI_VOICE_DM_RESULT = "aivoicedmresult",
+    /**
+     * 对话出错详细信息
+     */
+    AI_VOICE_ERROR = "aivoiceerror",
+    /**
+     * 服务端 3.2.7.0 添加
+     *
+     */
+    TOUCH_CTR_MAPPING = "touchctrmapping",
+    /**
+     * 服务端 3.2.7.0 添加
+     * rtmp 直播推流状态
+     */
+    RTMP_STREAM_STATE = "rtmpstreamstate",
+    /**
+     * 服务端 3.2.7.0 添加
+     * rtmp 直播推流出错
+     */
+    RTMP_STREAM_ERROR = "rtmpstreamerror"
 }
 ```

package/dist/doc/functions.md

@@ -17,11 +17,50 @@ updateServerAddress(serverAddress: string): void;
  * @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;
@@ -35,7 +74,7 @@ connect(params: {
     appKey?: string;
     timestamp?: string;
     signature?: string;
-}): Promise<void>;
+} | any): Promise<void>;
 /**
  * 重新开始云渲染流程
  */

package/dist/doc/index.md

@@ -75,7 +75,7 @@ client.connect({
 ## 文档目录
 
 ### [参数配置](./config.md)
-### [LarkSR 对象方法](./functons.md)
+### [LarkSR 对象方法](./functions.md)
 ### [LarkSR 事件](./events.md)
 ### [LarkSR 对象成员](./member_variables.md)
 ### [SDK ID 加密](./sdkid_encryption.md)

package/dist/doc/update.md

@@ -276,4 +276,122 @@ onlyHandleRootElementTransform?: boolean;
 * @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); 
+});
+```