larksr_websdk 3.2.329 → 3.2.331

package/dist/types/api.d.ts

@@ -49,6 +49,7 @@ export interface StartAppInfo {
     wsProxy: string;
     preferPublicIp: string;
     renderServerPort: number;
+    renderSSLServerPort: number;
     initCursorMode: number;
     rttLimit: string;
     touchOperateMode: string;

package/dist/types/appli_params.d.ts

@@ -10,6 +10,10 @@ export interface IAppliParams {
      * appserver 的端口号
      */
     appPort: string;
+    /**
+     * 渲染服务器 ssl 端口号
+     */
+    renderSSLServerPort: string;
     /**
      * appli type
      */
@@ -211,6 +215,7 @@ export declare enum AppliType {
 export declare class AppliParams implements IAppliParams {
     appServer: string;
     appPort: string;
+    renderSSLServerPort: string;
     appliType: AppliType;
     wsProxy: boolean;
     preferPubOutIp: string;

package/dist/types/lark/application.d.ts

@@ -13,7 +13,7 @@ export declare enum APP_STATE {
     LOGIN_SUCCESS = 3,
     RTC_CONNECTED = 4,
     MEDIA_LOADED = 5,
-    MEDIA_PLAED = 6,
+    MEDIA_PLAYED = 6,
     RTC_RETRY = 7,
     APP_RETRY = 8,
     BEFORE_DESTORY = 9,
@@ -56,6 +56,7 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private websocketProxy;
     private testPixelStreaming;
     private peerConnection;
+    get peerConnectionCreated(): boolean;
     get state(): APP_STATE;
     set state(state: APP_STATE);
     private _state;

package/dist/types/lark/websocket_channel.d.ts

@@ -14,6 +14,7 @@ export interface WebscocketConfig {
     serverAddress: string;
     ip: string;
     port: string;
+    renderSSLServerPort?: string;
     path?: string;
 }
 export default class WebsocketChannel extends EventBase<CHANNEL_EVENT_TYPE, ChannelEvent> {

package/dist/types/larksr.d.ts

@@ -106,9 +106,10 @@ declare enum LarkSRClientEvent {
      */
     GOT_REMOTE_AUDIO_STREAM = "gotremoteaudiostream",
     /**
-     * 视频加载成功，等待播放 .
+     * 视频加载成功
      */
     MEDIA_LOADED = "meidaloaded",
+    MEDIA_LOADED2 = "medialoaded",
     /**
      * 视频自动播放成功 .
      */
@@ -180,6 +181,30 @@ declare 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",
     /**
@@ -328,6 +353,10 @@ interface ILarkSRConfig {
     preferDecoder?: 'auto' | 'vp8' | 'vp9' | 'h264' | 'h265' | 'hevc' | 'av1x';
     /**
      * 可选项，视频在容器中的缩放模式
+     * ScaleMode: 'contain' | 'fill_clip' | 'fill_stretch'
+     * contain: 以应用原始尺寸的缩放
+     * fill_clip: 裁剪模式，完全填充屏幕但保留宽高比
+     * fill_stretch: 拉伸模式，完全填充屏幕但不保留宽高比
      * 对应后台应用管理->应用编辑->通用高级设置->窗口初始显示方式,该配置优先级高于后台配置
      */
     scaleMode?: ScaleMode;
@@ -432,6 +461,11 @@ interface ILarkSRConfig {
      * zh-CN 中文 en 英文
      */
     language?: string;
+    /**
+     * 点对点连接成功，但未接收到视频流或未播放成功超时时间。自动播放模式下超时会弹出提示按钮。
+     * 默认 20S
+     */
+    playTimeout?: number;
 }
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**

package/dist/types/localization/ui.d.ts

@@ -56,4 +56,5 @@ export default class UI extends LocalizationBase {
     get APP_RETRY(): string;
     get APP_RETRY_CONFIRM(): string;
     get START(): string;
+    get PLAY_FAILED(): string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.329",
+  "version": "3.2.331",
   "description": "Larksr websdk. Easy to build a cloud render client for larksr system or ue4 pixelstreaming.docs: https://pingxingyun.github.io/webclient_sdk/",
   "keywords": [
     "pingxingyun",

package/types/api.d.ts

@@ -49,6 +49,7 @@ export interface StartAppInfo {
     wsProxy: string;
     preferPublicIp: string;
     renderServerPort: number;
+    renderSSLServerPort: number;
     initCursorMode: number;
     rttLimit: string;
     touchOperateMode: string;

package/types/appli_params.d.ts

@@ -10,6 +10,10 @@ export interface IAppliParams {
      * appserver 的端口号
      */
     appPort: string;
+    /**
+     * 渲染服务器 ssl 端口号
+     */
+    renderSSLServerPort: string;
     /**
      * appli type
      */
@@ -211,6 +215,7 @@ export declare enum AppliType {
 export declare class AppliParams implements IAppliParams {
     appServer: string;
     appPort: string;
+    renderSSLServerPort: string;
     appliType: AppliType;
     wsProxy: boolean;
     preferPubOutIp: string;

package/types/lark/application.d.ts

@@ -13,7 +13,7 @@ export declare enum APP_STATE {
     LOGIN_SUCCESS = 3,
     RTC_CONNECTED = 4,
     MEDIA_LOADED = 5,
-    MEDIA_PLAED = 6,
+    MEDIA_PLAYED = 6,
     RTC_RETRY = 7,
     APP_RETRY = 8,
     BEFORE_DESTORY = 9,
@@ -56,6 +56,7 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private websocketProxy;
     private testPixelStreaming;
     private peerConnection;
+    get peerConnectionCreated(): boolean;
     get state(): APP_STATE;
     set state(state: APP_STATE);
     private _state;

package/types/lark/websocket_channel.d.ts

@@ -14,6 +14,7 @@ export interface WebscocketConfig {
     serverAddress: string;
     ip: string;
     port: string;
+    renderSSLServerPort?: string;
     path?: string;
 }
 export default class WebsocketChannel extends EventBase<CHANNEL_EVENT_TYPE, ChannelEvent> {

package/types/larksr.d.ts

@@ -106,9 +106,10 @@ declare enum LarkSRClientEvent {
      */
     GOT_REMOTE_AUDIO_STREAM = "gotremoteaudiostream",
     /**
-     * 视频加载成功，等待播放 .
+     * 视频加载成功
      */
     MEDIA_LOADED = "meidaloaded",
+    MEDIA_LOADED2 = "medialoaded",
     /**
      * 视频自动播放成功 .
      */
@@ -180,6 +181,30 @@ declare 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",
     /**
@@ -328,6 +353,10 @@ interface ILarkSRConfig {
     preferDecoder?: 'auto' | 'vp8' | 'vp9' | 'h264' | 'h265' | 'hevc' | 'av1x';
     /**
      * 可选项，视频在容器中的缩放模式
+     * ScaleMode: 'contain' | 'fill_clip' | 'fill_stretch'
+     * contain: 以应用原始尺寸的缩放
+     * fill_clip: 裁剪模式，完全填充屏幕但保留宽高比
+     * fill_stretch: 拉伸模式，完全填充屏幕但不保留宽高比
      * 对应后台应用管理->应用编辑->通用高级设置->窗口初始显示方式,该配置优先级高于后台配置
      */
     scaleMode?: ScaleMode;
@@ -432,6 +461,11 @@ interface ILarkSRConfig {
      * zh-CN 中文 en 英文
      */
     language?: string;
+    /**
+     * 点对点连接成功，但未接收到视频流或未播放成功超时时间。自动播放模式下超时会弹出提示按钮。
+     * 默认 20S
+     */
+    playTimeout?: number;
 }
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**

package/types/localization/ui.d.ts

@@ -56,4 +56,5 @@ export default class UI extends LocalizationBase {
     get APP_RETRY(): string;
     get APP_RETRY_CONFIRM(): string;
     get START(): string;
+    get PLAY_FAILED(): string;
 }