larksr_websdk 3.2.11 → 3.2.15
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.
- package/dist/doc/config.md +13 -0
- package/dist/doc/functions.md +9 -0
- package/dist/doc/index.md +38 -9
- package/dist/doc/member_variables.md +14 -0
- package/dist/larksr-web-sdk.min.js +2 -2
- package/dist/types/larksr.d.ts +23 -3
- package/dist/types/screen_state.d.ts +2 -3
- package/package.json +1 -1
- package/types/lark/lark_event_type.d.ts +1 -0
- package/types/larksr.d.ts +23 -3
- package/types/screen_state.d.ts +2 -3
package/dist/types/larksr.d.ts
CHANGED
|
@@ -370,6 +370,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
370
370
|
*/
|
|
371
371
|
get screenState(): ScreenState;
|
|
372
372
|
private _screenState;
|
|
373
|
+
/**
|
|
374
|
+
* 动态设置scalemode
|
|
375
|
+
*/
|
|
376
|
+
set scaleMode(scaleMode: ScaleMode);
|
|
373
377
|
/**
|
|
374
378
|
* 当前的输入控制
|
|
375
379
|
* @see Operation
|
|
@@ -410,6 +414,14 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
410
414
|
*
|
|
411
415
|
*/
|
|
412
416
|
get viewportElement(): any;
|
|
417
|
+
/**
|
|
418
|
+
* 是否显示移动端触摸点
|
|
419
|
+
*/
|
|
420
|
+
set isEnableTouchPonit(enable: boolean);
|
|
421
|
+
/**
|
|
422
|
+
* 是否显示载入画面时底部文字
|
|
423
|
+
*/
|
|
424
|
+
set isEnableLoadingStateBar(enable: boolean);
|
|
413
425
|
get rootElement(): HTMLElement;
|
|
414
426
|
private _rootElement;
|
|
415
427
|
get serverAddress(): string;
|
|
@@ -428,10 +440,14 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
428
440
|
*/
|
|
429
441
|
isTaskOwner(): boolean;
|
|
430
442
|
_isTaskOwner: boolean;
|
|
443
|
+
/**
|
|
444
|
+
* true:锁定模式 false:非锁定模式
|
|
445
|
+
*/
|
|
446
|
+
set initCursorMode(mode: boolean);
|
|
447
|
+
get initCursorMode(): boolean;
|
|
431
448
|
/**
|
|
432
449
|
* LarkSR 客户端。所有操作和事件通过该类传递
|
|
433
|
-
*
|
|
434
|
-
* @see CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl
|
|
450
|
+
* @see CreateLarkSRClientFromeAPI, @see CreateLarkSRClientFromeUrl @see CreateLarkSRClientFromePXYHost
|
|
435
451
|
* @param config 本地配置,如果有 IAppliParams 相同的配置项,优先级最高
|
|
436
452
|
* @param params [可选参数] 云端应用参数等,通过后台接口或者url参数获取。
|
|
437
453
|
*/
|
|
@@ -469,7 +485,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
469
485
|
signature?: string;
|
|
470
486
|
}): Promise<void>;
|
|
471
487
|
/**
|
|
472
|
-
* 用户手动填昵称,需要在 start 或 connect
|
|
488
|
+
* 用户手动填昵称,需要在 start 或 connect 之前设置才能生效。
|
|
473
489
|
*/
|
|
474
490
|
setNickname(nickname: string): void;
|
|
475
491
|
/**
|
|
@@ -532,6 +548,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
532
548
|
*/
|
|
533
549
|
quit(): void;
|
|
534
550
|
resetAppMouseLockState(): void;
|
|
551
|
+
/**
|
|
552
|
+
* 采集一帧图像
|
|
553
|
+
*/
|
|
554
|
+
captrueFrame(data: any): void;
|
|
535
555
|
/**
|
|
536
556
|
* 操作相关事件
|
|
537
557
|
* 所有事件坐标相对于云端应用,不相对于网页
|
|
@@ -78,11 +78,10 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
|
|
|
78
78
|
get screenOrientation(): ScreenOrientation;
|
|
79
79
|
private _screenOrientation;
|
|
80
80
|
get scaleMode(): ScaleMode;
|
|
81
|
+
set scaleMode(scaleMode: ScaleMode);
|
|
81
82
|
private _scaleMode;
|
|
82
83
|
get isFullScreen(): boolean;
|
|
83
84
|
private _isFullScreen;
|
|
84
|
-
get isLockMouse(): boolean;
|
|
85
|
-
private _isLockMouse;
|
|
86
85
|
get cursorStyle(): SyncCursorStyle;
|
|
87
86
|
set cursorStyle(style: SyncCursorStyle);
|
|
88
87
|
private _cursorStyle;
|
|
@@ -95,6 +94,7 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
|
|
|
95
94
|
scaleY: number;
|
|
96
95
|
};
|
|
97
96
|
get initCursorMode(): boolean;
|
|
97
|
+
set initCursorMode(mode: boolean);
|
|
98
98
|
private _initCursorMode;
|
|
99
99
|
get isMobile(): boolean;
|
|
100
100
|
private _isMobile;
|
|
@@ -102,7 +102,6 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
|
|
|
102
102
|
get isLockMosue(): boolean | null | undefined;
|
|
103
103
|
get rootElement(): HTMLElement;
|
|
104
104
|
private _rootElement;
|
|
105
|
-
private videoViewPort;
|
|
106
105
|
private mobileForceLandScape;
|
|
107
106
|
private bgColor;
|
|
108
107
|
private handelRootElementSize;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "larksr_websdk",
|
|
3
|
-
"version": "3.2.
|
|
3
|
+
"version": "3.2.15",
|
|
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",
|
|
@@ -27,6 +27,7 @@ export declare enum LarkEventType {
|
|
|
27
27
|
LK_RTC_EVENT_PEERCONNECTION_CONNECTED = 600,
|
|
28
28
|
LK_RTC_EVENT_PEERCONNECTION_CLOSED = 601,
|
|
29
29
|
LK_RTC_EVENT_PEERCONNECTION_ERROR = 602,
|
|
30
|
+
LK_RTC_EVENT_PEERCONNECTION_CREATE_FAILED = 603,
|
|
30
31
|
LK_RTC_EVENT_PEERCONNECTION_STATE = 610,
|
|
31
32
|
LK_RTC_EVENT_PEERCONNECTION_RETRY = 611,
|
|
32
33
|
LK_VIDEO_LOADED = 700,
|
package/types/larksr.d.ts
CHANGED
|
@@ -370,6 +370,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
370
370
|
*/
|
|
371
371
|
get screenState(): ScreenState;
|
|
372
372
|
private _screenState;
|
|
373
|
+
/**
|
|
374
|
+
* 动态设置scalemode
|
|
375
|
+
*/
|
|
376
|
+
set scaleMode(scaleMode: ScaleMode);
|
|
373
377
|
/**
|
|
374
378
|
* 当前的输入控制
|
|
375
379
|
* @see Operation
|
|
@@ -410,6 +414,14 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
410
414
|
*
|
|
411
415
|
*/
|
|
412
416
|
get viewportElement(): any;
|
|
417
|
+
/**
|
|
418
|
+
* 是否显示移动端触摸点
|
|
419
|
+
*/
|
|
420
|
+
set isEnableTouchPonit(enable: boolean);
|
|
421
|
+
/**
|
|
422
|
+
* 是否显示载入画面时底部文字
|
|
423
|
+
*/
|
|
424
|
+
set isEnableLoadingStateBar(enable: boolean);
|
|
413
425
|
get rootElement(): HTMLElement;
|
|
414
426
|
private _rootElement;
|
|
415
427
|
get serverAddress(): string;
|
|
@@ -428,10 +440,14 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
428
440
|
*/
|
|
429
441
|
isTaskOwner(): boolean;
|
|
430
442
|
_isTaskOwner: boolean;
|
|
443
|
+
/**
|
|
444
|
+
* true:锁定模式 false:非锁定模式
|
|
445
|
+
*/
|
|
446
|
+
set initCursorMode(mode: boolean);
|
|
447
|
+
get initCursorMode(): boolean;
|
|
431
448
|
/**
|
|
432
449
|
* LarkSR 客户端。所有操作和事件通过该类传递
|
|
433
|
-
*
|
|
434
|
-
* @see CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl
|
|
450
|
+
* @see CreateLarkSRClientFromeAPI, @see CreateLarkSRClientFromeUrl @see CreateLarkSRClientFromePXYHost
|
|
435
451
|
* @param config 本地配置,如果有 IAppliParams 相同的配置项,优先级最高
|
|
436
452
|
* @param params [可选参数] 云端应用参数等,通过后台接口或者url参数获取。
|
|
437
453
|
*/
|
|
@@ -469,7 +485,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
469
485
|
signature?: string;
|
|
470
486
|
}): Promise<void>;
|
|
471
487
|
/**
|
|
472
|
-
* 用户手动填昵称,需要在 start 或 connect
|
|
488
|
+
* 用户手动填昵称,需要在 start 或 connect 之前设置才能生效。
|
|
473
489
|
*/
|
|
474
490
|
setNickname(nickname: string): void;
|
|
475
491
|
/**
|
|
@@ -532,6 +548,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
532
548
|
*/
|
|
533
549
|
quit(): void;
|
|
534
550
|
resetAppMouseLockState(): void;
|
|
551
|
+
/**
|
|
552
|
+
* 采集一帧图像
|
|
553
|
+
*/
|
|
554
|
+
captrueFrame(data: any): void;
|
|
535
555
|
/**
|
|
536
556
|
* 操作相关事件
|
|
537
557
|
* 所有事件坐标相对于云端应用,不相对于网页
|
package/types/screen_state.d.ts
CHANGED
|
@@ -78,11 +78,10 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
|
|
|
78
78
|
get screenOrientation(): ScreenOrientation;
|
|
79
79
|
private _screenOrientation;
|
|
80
80
|
get scaleMode(): ScaleMode;
|
|
81
|
+
set scaleMode(scaleMode: ScaleMode);
|
|
81
82
|
private _scaleMode;
|
|
82
83
|
get isFullScreen(): boolean;
|
|
83
84
|
private _isFullScreen;
|
|
84
|
-
get isLockMouse(): boolean;
|
|
85
|
-
private _isLockMouse;
|
|
86
85
|
get cursorStyle(): SyncCursorStyle;
|
|
87
86
|
set cursorStyle(style: SyncCursorStyle);
|
|
88
87
|
private _cursorStyle;
|
|
@@ -95,6 +94,7 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
|
|
|
95
94
|
scaleY: number;
|
|
96
95
|
};
|
|
97
96
|
get initCursorMode(): boolean;
|
|
97
|
+
set initCursorMode(mode: boolean);
|
|
98
98
|
private _initCursorMode;
|
|
99
99
|
get isMobile(): boolean;
|
|
100
100
|
private _isMobile;
|
|
@@ -102,7 +102,6 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
|
|
|
102
102
|
get isLockMosue(): boolean | null | undefined;
|
|
103
103
|
get rootElement(): HTMLElement;
|
|
104
104
|
private _rootElement;
|
|
105
|
-
private videoViewPort;
|
|
106
105
|
private mobileForceLandScape;
|
|
107
106
|
private bgColor;
|
|
108
107
|
private handelRootElementSize;
|