larksr_websdk 3.2.331 → 3.2.332

package/dist/doc/config.md

@@ -208,5 +208,10 @@ interface ILarkSRConfig {
      * zh-CN 中文 en 英文
      */
     language?: string;
+    /**
+     * 点对点连接成功，但未接收到视频流或未播放成功超时时间。自动播放模式下超时会弹出提示按钮。
+     * 默认 20S
+     */
+    playTimeout?: number;
 }
 ```

package/dist/doc/events.md

@@ -164,6 +164,30 @@ declare const enum LarkSRClientEvent {
     LarkEvent = "larkevent",
     /**
      * 发生错误时抛出
+     * type:     error
+     * message: 错误消息
+     * code:    可能的错误码如下, 错误码的具体定义 @see [./event_codes]
+     *          // 连接服务器的websocket代理关闭
+     *          LK_RENDER_SERVER_CLOSE                    : 102
+     *          // 连接代理服务器的websocket关闭
+     *          LK_PROXY_SERVER_CLOSE                     : 202
+     *          // 检测版本失败，服务器和客户端的版本匹配。目前只有3.1和3.2大版本不匹配情况
+     *          LK_VERSION_CHECK_FAILED                   : 301
+     *          // 服务器返回创建Task失败
+     *          TASK_NOTFOUND-TASK_NO_GPU_RESOURCE        : 401-404
+     *          // 服务端启动流媒体失败
+     *          LK_START_STREAM_PROCESS_START-FAILED-LK_START_STREAM_ENCODER_ERROR : 501-504
+     *          // RTC 连接关闭
+     *          LK_RTC_EVENT_PEERCONNECTION_CLOSED        : 601
+     *          // RTC 连接出错
+     *          LK_RTC_EVENT_PEERCONNECTION_ERROR         : 602
+     *          // RTC 创建出错，一般为 浏览器不支持 webrtc
+     *          LK_RTC_EVENT_PEERCONNECTION_CREATE_FAILED : 603
+     *          // 服务器主动要求客户端退出
+     *          LK_NOTIFY_CLIENT_LOGOUT_PLAYER_LOGOUT     : 800
+     *          // 一人操作多人看房主退出
+     *          LK_NOTIFY_CLIENT_LOGOUT_TASKOWNER_LOGOUT  : 801
+     *
      */
     ERROR = "error",
     /**

package/dist/doc/member_variables.md

@@ -208,6 +208,14 @@ larksr.screenState.isLocalRenderMouse;
 larksr.screenState.isLockMosue;
 ```
 
+监听 screenState 的状态改变，事件码为 `0`。当 SDK 内部或者外部触发了 `screenState.resize()` 之后调用。
+
+```javascript
+larksr.screenState.on(0, () => {
+    console.log("screen state resize", larksr.screenState.screenOrientation);
+});
+```
+
 ## 操作类实例
 
 ```javascript

package/dist/doc/update.md

@@ -395,3 +395,39 @@ larksr.on('resourcenotenough', function(e) {
     console.log("LarkSRClientEvent RESOURCE_NOT_ENOUGH", e); 
 });
 ```
+
+## V3.2.331
+
+1. 优化自动播放模式下播放按钮出现时机,添加载入超时设置 `new LarkSR({ ... 此处省略其他配置 ... playTimeout: 20 })`
+2. 修复不支持 WebRTC 情况下未抛出错误事件的问题。对应错误码为 603, `error` 事件可能的错误码如下:
+
+```javascript
+/**
+ * 发生错误时抛出
+ * type:     error
+ * message: 错误消息
+ * code:    可能的错误码如下, 错误码的具体定义 @see [./event_codes]
+ *          // 连接服务器的websocket代理关闭
+ *          LK_RENDER_SERVER_CLOSE                    : 102
+ *          // 连接代理服务器的websocket关闭
+ *          LK_PROXY_SERVER_CLOSE                     : 202
+ *          // 检测版本失败，服务器和客户端的版本匹配。目前只有3.1和3.2大版本不匹配情况
+ *          LK_VERSION_CHECK_FAILED                   : 301
+ *          // 服务器返回创建Task失败
+ *          TASK_NOTFOUND-TASK_NO_GPU_RESOURCE        : 401-404
+ *          // 服务端启动流媒体失败
+ *          LK_START_STREAM_PROCESS_START-FAILED-LK_START_STREAM_ENCODER_ERROR : 501-504
+ *          // RTC 连接关闭
+ *          LK_RTC_EVENT_PEERCONNECTION_CLOSED        : 601
+ *          // RTC 连接出错
+ *          LK_RTC_EVENT_PEERCONNECTION_ERROR         : 602
+ *          // RTC 创建出错，一般为 浏览器不支持 webrtc
+ *          LK_RTC_EVENT_PEERCONNECTION_CREATE_FAILED : 603
+ *          // 服务器主动要求客户端退出
+ *          LK_NOTIFY_CLIENT_LOGOUT_PLAYER_LOGOUT     : 800
+ *          // 一人操作多人看房主退出
+ *          LK_NOTIFY_CLIENT_LOGOUT_TASKOWNER_LOGOUT  : 801
+ *          
+ */
+ERROR              = 'error',
+```