larksr_websdk 3.2.330 → 3.2.331

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -13,7 +13,7 @@ export declare enum APP_STATE {
13
13
  LOGIN_SUCCESS = 3,
14
14
  RTC_CONNECTED = 4,
15
15
  MEDIA_LOADED = 5,
16
- MEDIA_PLAED = 6,
16
+ MEDIA_PLAYED = 6,
17
17
  RTC_RETRY = 7,
18
18
  APP_RETRY = 8,
19
19
  BEFORE_DESTORY = 9,
@@ -56,6 +56,7 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
56
56
  private websocketProxy;
57
57
  private testPixelStreaming;
58
58
  private peerConnection;
59
+ get peerConnectionCreated(): boolean;
59
60
  get state(): APP_STATE;
60
61
  set state(state: APP_STATE);
61
62
  private _state;
@@ -106,9 +106,10 @@ declare enum LarkSRClientEvent {
106
106
  */
107
107
  GOT_REMOTE_AUDIO_STREAM = "gotremoteaudiostream",
108
108
  /**
109
- * 视频加载成功,等待播放 .
109
+ * 视频加载成功
110
110
  */
111
111
  MEDIA_LOADED = "meidaloaded",
112
+ MEDIA_LOADED2 = "medialoaded",
112
113
  /**
113
114
  * 视频自动播放成功 .
114
115
  */
@@ -180,6 +181,30 @@ declare enum LarkSRClientEvent {
180
181
  LarkEvent = "larkevent",
181
182
  /**
182
183
  * 发生错误时抛出
184
+ * type: error
185
+ * message: 错误消息
186
+ * code: 可能的错误码如下, 错误码的具体定义 @see [./event_codes]
187
+ * // 连接服务器的websocket代理关闭
188
+ * LK_RENDER_SERVER_CLOSE : 102
189
+ * // 连接代理服务器的websocket关闭
190
+ * LK_PROXY_SERVER_CLOSE : 202
191
+ * // 检测版本失败,服务器和客户端的版本匹配。目前只有3.1和3.2大版本不匹配情况
192
+ * LK_VERSION_CHECK_FAILED : 301
193
+ * // 服务器返回创建Task失败
194
+ * TASK_NOTFOUND-TASK_NO_GPU_RESOURCE : 401-404
195
+ * // 服务端启动流媒体失败
196
+ * LK_START_STREAM_PROCESS_START-FAILED-LK_START_STREAM_ENCODER_ERROR : 501-504
197
+ * // RTC 连接关闭
198
+ * LK_RTC_EVENT_PEERCONNECTION_CLOSED : 601
199
+ * // RTC 连接出错
200
+ * LK_RTC_EVENT_PEERCONNECTION_ERROR : 602
201
+ * // RTC 创建出错,一般为 浏览器不支持 webrtc
202
+ * LK_RTC_EVENT_PEERCONNECTION_CREATE_FAILED : 603
203
+ * // 服务器主动要求客户端退出
204
+ * LK_NOTIFY_CLIENT_LOGOUT_PLAYER_LOGOUT : 800
205
+ * // 一人操作多人看房主退出
206
+ * LK_NOTIFY_CLIENT_LOGOUT_TASKOWNER_LOGOUT : 801
207
+ *
183
208
  */
184
209
  ERROR = "error",
185
210
  /**
@@ -436,6 +461,11 @@ interface ILarkSRConfig {
436
461
  * zh-CN 中文 en 英文
437
462
  */
438
463
  language?: string;
464
+ /**
465
+ * 点对点连接成功,但未接收到视频流或未播放成功超时时间。自动播放模式下超时会弹出提示按钮。
466
+ * 默认 20S
467
+ */
468
+ playTimeout?: number;
439
469
  }
440
470
  declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
441
471
  /**
@@ -56,4 +56,5 @@ export default class UI extends LocalizationBase {
56
56
  get APP_RETRY(): string;
57
57
  get APP_RETRY_CONFIRM(): string;
58
58
  get START(): string;
59
+ get PLAY_FAILED(): string;
59
60
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "larksr_websdk",
3
- "version": "3.2.330",
3
+ "version": "3.2.331",
4
4
  "description": "Larksr websdk. Easy to build a cloud render client for larksr system or ue4 pixelstreaming.docs: https://pingxingyun.github.io/webclient_sdk/",
5
5
  "keywords": [
6
6
  "pingxingyun",
@@ -13,7 +13,7 @@ export declare enum APP_STATE {
13
13
  LOGIN_SUCCESS = 3,
14
14
  RTC_CONNECTED = 4,
15
15
  MEDIA_LOADED = 5,
16
- MEDIA_PLAED = 6,
16
+ MEDIA_PLAYED = 6,
17
17
  RTC_RETRY = 7,
18
18
  APP_RETRY = 8,
19
19
  BEFORE_DESTORY = 9,
@@ -56,6 +56,7 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
56
56
  private websocketProxy;
57
57
  private testPixelStreaming;
58
58
  private peerConnection;
59
+ get peerConnectionCreated(): boolean;
59
60
  get state(): APP_STATE;
60
61
  set state(state: APP_STATE);
61
62
  private _state;
package/types/larksr.d.ts CHANGED
@@ -106,9 +106,10 @@ declare enum LarkSRClientEvent {
106
106
  */
107
107
  GOT_REMOTE_AUDIO_STREAM = "gotremoteaudiostream",
108
108
  /**
109
- * 视频加载成功,等待播放 .
109
+ * 视频加载成功
110
110
  */
111
111
  MEDIA_LOADED = "meidaloaded",
112
+ MEDIA_LOADED2 = "medialoaded",
112
113
  /**
113
114
  * 视频自动播放成功 .
114
115
  */
@@ -180,6 +181,30 @@ declare enum LarkSRClientEvent {
180
181
  LarkEvent = "larkevent",
181
182
  /**
182
183
  * 发生错误时抛出
184
+ * type: error
185
+ * message: 错误消息
186
+ * code: 可能的错误码如下, 错误码的具体定义 @see [./event_codes]
187
+ * // 连接服务器的websocket代理关闭
188
+ * LK_RENDER_SERVER_CLOSE : 102
189
+ * // 连接代理服务器的websocket关闭
190
+ * LK_PROXY_SERVER_CLOSE : 202
191
+ * // 检测版本失败,服务器和客户端的版本匹配。目前只有3.1和3.2大版本不匹配情况
192
+ * LK_VERSION_CHECK_FAILED : 301
193
+ * // 服务器返回创建Task失败
194
+ * TASK_NOTFOUND-TASK_NO_GPU_RESOURCE : 401-404
195
+ * // 服务端启动流媒体失败
196
+ * LK_START_STREAM_PROCESS_START-FAILED-LK_START_STREAM_ENCODER_ERROR : 501-504
197
+ * // RTC 连接关闭
198
+ * LK_RTC_EVENT_PEERCONNECTION_CLOSED : 601
199
+ * // RTC 连接出错
200
+ * LK_RTC_EVENT_PEERCONNECTION_ERROR : 602
201
+ * // RTC 创建出错,一般为 浏览器不支持 webrtc
202
+ * LK_RTC_EVENT_PEERCONNECTION_CREATE_FAILED : 603
203
+ * // 服务器主动要求客户端退出
204
+ * LK_NOTIFY_CLIENT_LOGOUT_PLAYER_LOGOUT : 800
205
+ * // 一人操作多人看房主退出
206
+ * LK_NOTIFY_CLIENT_LOGOUT_TASKOWNER_LOGOUT : 801
207
+ *
183
208
  */
184
209
  ERROR = "error",
185
210
  /**
@@ -436,6 +461,11 @@ interface ILarkSRConfig {
436
461
  * zh-CN 中文 en 英文
437
462
  */
438
463
  language?: string;
464
+ /**
465
+ * 点对点连接成功,但未接收到视频流或未播放成功超时时间。自动播放模式下超时会弹出提示按钮。
466
+ * 默认 20S
467
+ */
468
+ playTimeout?: number;
439
469
  }
440
470
  declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
441
471
  /**
@@ -56,4 +56,5 @@ export default class UI extends LocalizationBase {
56
56
  get APP_RETRY(): string;
57
57
  get APP_RETRY_CONFIRM(): string;
58
58
  get START(): string;
59
+ get PLAY_FAILED(): string;
59
60
  }