larksr_websdk 3.2.12 → 3.2.16
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/functions.md +9 -0
- package/dist/doc/member_variables.md +14 -0
- package/dist/larksr-web-sdk.min.js +2 -2
- package/dist/types/larksr.d.ts +22 -0
- package/dist/types/screen_state.d.ts +1 -3
- package/package.json +1 -1
- package/types/lark/lark_event_type.d.ts +1 -0
- package/types/larksr.d.ts +22 -0
- package/types/operation/gesture_handler.d.ts +3 -0
- package/types/operation/operation.d.ts +3 -0
- package/types/screen_state.d.ts +1 -3
- package/types/event/bus.d.ts +0 -8
- package/types/event/events.d.ts +0 -126
- package/types/event/message.d.ts +0 -69
- package/types/protobuf/message.d.ts +0 -528
package/dist/types/larksr.d.ts
CHANGED
|
@@ -374,6 +374,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
374
374
|
* 动态设置scalemode
|
|
375
375
|
*/
|
|
376
376
|
set scaleMode(scaleMode: ScaleMode);
|
|
377
|
+
get mouseZoomDirection(): number;
|
|
378
|
+
/**
|
|
379
|
+
* 动态设置滚轮和缩放手势对应关系
|
|
380
|
+
*/
|
|
381
|
+
set mouseZoomDirection(direction: number);
|
|
377
382
|
/**
|
|
378
383
|
* 当前的输入控制
|
|
379
384
|
* @see Operation
|
|
@@ -414,6 +419,14 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
414
419
|
*
|
|
415
420
|
*/
|
|
416
421
|
get viewportElement(): any;
|
|
422
|
+
/**
|
|
423
|
+
* 是否显示移动端触摸点
|
|
424
|
+
*/
|
|
425
|
+
set isEnableTouchPonit(enable: boolean);
|
|
426
|
+
/**
|
|
427
|
+
* 是否显示载入画面时底部文字
|
|
428
|
+
*/
|
|
429
|
+
set isEnableLoadingStateBar(enable: boolean);
|
|
417
430
|
get rootElement(): HTMLElement;
|
|
418
431
|
private _rootElement;
|
|
419
432
|
get serverAddress(): string;
|
|
@@ -432,6 +445,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
432
445
|
*/
|
|
433
446
|
isTaskOwner(): boolean;
|
|
434
447
|
_isTaskOwner: boolean;
|
|
448
|
+
/**
|
|
449
|
+
* true:锁定模式 false:非锁定模式
|
|
450
|
+
*/
|
|
451
|
+
set initCursorMode(mode: boolean);
|
|
452
|
+
get initCursorMode(): boolean;
|
|
435
453
|
/**
|
|
436
454
|
* LarkSR 客户端。所有操作和事件通过该类传递
|
|
437
455
|
* @see CreateLarkSRClientFromeAPI, @see CreateLarkSRClientFromeUrl @see CreateLarkSRClientFromePXYHost
|
|
@@ -535,6 +553,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
535
553
|
*/
|
|
536
554
|
quit(): void;
|
|
537
555
|
resetAppMouseLockState(): void;
|
|
556
|
+
/**
|
|
557
|
+
* 采集一帧图像
|
|
558
|
+
*/
|
|
559
|
+
captrueFrame(data: any): void;
|
|
538
560
|
/**
|
|
539
561
|
* 操作相关事件
|
|
540
562
|
* 所有事件坐标相对于云端应用,不相对于网页
|
|
@@ -82,8 +82,6 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
|
|
|
82
82
|
private _scaleMode;
|
|
83
83
|
get isFullScreen(): boolean;
|
|
84
84
|
private _isFullScreen;
|
|
85
|
-
get isLockMouse(): boolean;
|
|
86
|
-
private _isLockMouse;
|
|
87
85
|
get cursorStyle(): SyncCursorStyle;
|
|
88
86
|
set cursorStyle(style: SyncCursorStyle);
|
|
89
87
|
private _cursorStyle;
|
|
@@ -96,6 +94,7 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
|
|
|
96
94
|
scaleY: number;
|
|
97
95
|
};
|
|
98
96
|
get initCursorMode(): boolean;
|
|
97
|
+
set initCursorMode(mode: boolean);
|
|
99
98
|
private _initCursorMode;
|
|
100
99
|
get isMobile(): boolean;
|
|
101
100
|
private _isMobile;
|
|
@@ -103,7 +102,6 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
|
|
|
103
102
|
get isLockMosue(): boolean | null | undefined;
|
|
104
103
|
get rootElement(): HTMLElement;
|
|
105
104
|
private _rootElement;
|
|
106
|
-
private videoViewPort;
|
|
107
105
|
private mobileForceLandScape;
|
|
108
106
|
private bgColor;
|
|
109
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.16",
|
|
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
|
@@ -374,6 +374,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
374
374
|
* 动态设置scalemode
|
|
375
375
|
*/
|
|
376
376
|
set scaleMode(scaleMode: ScaleMode);
|
|
377
|
+
get mouseZoomDirection(): number;
|
|
378
|
+
/**
|
|
379
|
+
* 动态设置滚轮和缩放手势对应关系
|
|
380
|
+
*/
|
|
381
|
+
set mouseZoomDirection(direction: number);
|
|
377
382
|
/**
|
|
378
383
|
* 当前的输入控制
|
|
379
384
|
* @see Operation
|
|
@@ -414,6 +419,14 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
414
419
|
*
|
|
415
420
|
*/
|
|
416
421
|
get viewportElement(): any;
|
|
422
|
+
/**
|
|
423
|
+
* 是否显示移动端触摸点
|
|
424
|
+
*/
|
|
425
|
+
set isEnableTouchPonit(enable: boolean);
|
|
426
|
+
/**
|
|
427
|
+
* 是否显示载入画面时底部文字
|
|
428
|
+
*/
|
|
429
|
+
set isEnableLoadingStateBar(enable: boolean);
|
|
417
430
|
get rootElement(): HTMLElement;
|
|
418
431
|
private _rootElement;
|
|
419
432
|
get serverAddress(): string;
|
|
@@ -432,6 +445,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
432
445
|
*/
|
|
433
446
|
isTaskOwner(): boolean;
|
|
434
447
|
_isTaskOwner: boolean;
|
|
448
|
+
/**
|
|
449
|
+
* true:锁定模式 false:非锁定模式
|
|
450
|
+
*/
|
|
451
|
+
set initCursorMode(mode: boolean);
|
|
452
|
+
get initCursorMode(): boolean;
|
|
435
453
|
/**
|
|
436
454
|
* LarkSR 客户端。所有操作和事件通过该类传递
|
|
437
455
|
* @see CreateLarkSRClientFromeAPI, @see CreateLarkSRClientFromeUrl @see CreateLarkSRClientFromePXYHost
|
|
@@ -535,6 +553,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
|
|
|
535
553
|
*/
|
|
536
554
|
quit(): void;
|
|
537
555
|
resetAppMouseLockState(): void;
|
|
556
|
+
/**
|
|
557
|
+
* 采集一帧图像
|
|
558
|
+
*/
|
|
559
|
+
captrueFrame(data: any): void;
|
|
538
560
|
/**
|
|
539
561
|
* 操作相关事件
|
|
540
562
|
* 所有事件坐标相对于云端应用,不相对于网页
|
|
@@ -4,6 +4,9 @@ export default class GestureHandler extends HandlerBase {
|
|
|
4
4
|
private gesture;
|
|
5
5
|
private rootElement;
|
|
6
6
|
private pressedMouseButtons;
|
|
7
|
+
set mouseZoomDirection(direction: number);
|
|
8
|
+
get mouseZoomDirection(): number;
|
|
9
|
+
private _mouseZoomDirection;
|
|
7
10
|
constructor(rootElement: HTMLElement, op: Operation);
|
|
8
11
|
startListening(): void;
|
|
9
12
|
stopListening(): void;
|
|
@@ -35,11 +35,14 @@ export default class Operation extends EventBase<OPREATION_EVENT_TYPE, Operation
|
|
|
35
35
|
get screenState(): import("../screen_state").default;
|
|
36
36
|
get fullScreen(): import("../larksr").FullScreen;
|
|
37
37
|
get lockPointer(): import("../larksr").LockPointer;
|
|
38
|
+
get mouseZoomDirection(): number;
|
|
39
|
+
set mouseZoomDirection(direction: number);
|
|
38
40
|
constructor(rootElement: HTMLElement, larksr: LarkSR);
|
|
39
41
|
setMouseEnable(enable: boolean): void;
|
|
40
42
|
setKeyboardEnable(enable: boolean): void;
|
|
41
43
|
setGamepadEnable(enable: boolean): void;
|
|
42
44
|
setTouchEnable(enable: boolean): void;
|
|
45
|
+
setGestureEnable(enable: boolean): void;
|
|
43
46
|
resetLocalRendreMousePosition(): void;
|
|
44
47
|
setAppMouseMode(mode: CloudLark.IAppMouseMode): void;
|
|
45
48
|
resetAppMouseLockState(): void;
|
package/types/screen_state.d.ts
CHANGED
|
@@ -82,8 +82,6 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
|
|
|
82
82
|
private _scaleMode;
|
|
83
83
|
get isFullScreen(): boolean;
|
|
84
84
|
private _isFullScreen;
|
|
85
|
-
get isLockMouse(): boolean;
|
|
86
|
-
private _isLockMouse;
|
|
87
85
|
get cursorStyle(): SyncCursorStyle;
|
|
88
86
|
set cursorStyle(style: SyncCursorStyle);
|
|
89
87
|
private _cursorStyle;
|
|
@@ -96,6 +94,7 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
|
|
|
96
94
|
scaleY: number;
|
|
97
95
|
};
|
|
98
96
|
get initCursorMode(): boolean;
|
|
97
|
+
set initCursorMode(mode: boolean);
|
|
99
98
|
private _initCursorMode;
|
|
100
99
|
get isMobile(): boolean;
|
|
101
100
|
private _isMobile;
|
|
@@ -103,7 +102,6 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
|
|
|
103
102
|
get isLockMosue(): boolean | null | undefined;
|
|
104
103
|
get rootElement(): HTMLElement;
|
|
105
104
|
private _rootElement;
|
|
106
|
-
private videoViewPort;
|
|
107
105
|
private mobileForceLandScape;
|
|
108
106
|
private bgColor;
|
|
109
107
|
private handelRootElementSize;
|
package/types/event/bus.d.ts
DELETED
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { EventBase, LocalEvent } from './event_base';
|
|
2
|
-
import GLOBAL_EVENT_TYPE from './events';
|
|
3
|
-
interface GlobalEvent extends LocalEvent<GLOBAL_EVENT_TYPE> {
|
|
4
|
-
}
|
|
5
|
-
declare class Global extends EventBase<GLOBAL_EVENT_TYPE, GlobalEvent> {
|
|
6
|
-
}
|
|
7
|
-
declare const Bus: Global;
|
|
8
|
-
export default Bus;
|
package/types/event/events.d.ts
DELETED
|
@@ -1,126 +0,0 @@
|
|
|
1
|
-
import { LocalEvent } from './event_base';
|
|
2
|
-
export declare enum GLOBAL_EVENT_TYPE {
|
|
3
|
-
/**
|
|
4
|
-
* video 元素已挂载
|
|
5
|
-
*/
|
|
6
|
-
MOUNTED = 1,
|
|
7
|
-
/**
|
|
8
|
-
* 打开 socket
|
|
9
|
-
*/
|
|
10
|
-
SOCKET_OPEN = 2,
|
|
11
|
-
/**
|
|
12
|
-
* 消息窗口
|
|
13
|
-
*/
|
|
14
|
-
ALERT = 3,
|
|
15
|
-
/**
|
|
16
|
-
* 获取远程视频流
|
|
17
|
-
*/
|
|
18
|
-
GOT_REMOTE_STREAM = 4,
|
|
19
|
-
/**
|
|
20
|
-
* 视频流加载成功
|
|
21
|
-
*/
|
|
22
|
-
LOADEDMETADATA = 5,
|
|
23
|
-
/**
|
|
24
|
-
* 重设config
|
|
25
|
-
*/
|
|
26
|
-
RECONFIG = 6,
|
|
27
|
-
/**
|
|
28
|
-
* 开始点对点连接
|
|
29
|
-
*/
|
|
30
|
-
STARTPC = 7,
|
|
31
|
-
/**
|
|
32
|
-
* 连接失败
|
|
33
|
-
*/
|
|
34
|
-
PC_FAILED = 8,
|
|
35
|
-
/**
|
|
36
|
-
* 结束点对点连接
|
|
37
|
-
*/
|
|
38
|
-
STOPPC = 9,
|
|
39
|
-
/**
|
|
40
|
-
* 结束点对点连接
|
|
41
|
-
*/
|
|
42
|
-
RTSP_SUCCESS = 10,
|
|
43
|
-
/**
|
|
44
|
-
* 刷新连接
|
|
45
|
-
*/
|
|
46
|
-
REFRESH = 11,
|
|
47
|
-
/**
|
|
48
|
-
* 开始计时
|
|
49
|
-
*/
|
|
50
|
-
START_TIMER = 12,
|
|
51
|
-
/**
|
|
52
|
-
* 计时结束 结束应用
|
|
53
|
-
*/
|
|
54
|
-
COURSE_OVER = 13,
|
|
55
|
-
/**
|
|
56
|
-
* 退出
|
|
57
|
-
*/
|
|
58
|
-
QUIT = 14,
|
|
59
|
-
/**
|
|
60
|
-
* 虚拟按键按下事件
|
|
61
|
-
*/
|
|
62
|
-
VIRTUAL_KEY_DOWN = 15,
|
|
63
|
-
/**
|
|
64
|
-
* 虚拟按键抬起
|
|
65
|
-
*/
|
|
66
|
-
VIRTUAL_KEY_UP = 16,
|
|
67
|
-
/**
|
|
68
|
-
* 摇杆事件
|
|
69
|
-
*/
|
|
70
|
-
JOY_STICK_MOUSE_MOVE = 17,
|
|
71
|
-
/**
|
|
72
|
-
* 虚拟鼠标移动
|
|
73
|
-
*/
|
|
74
|
-
VIRTUAL_MOUSE_MOVE = 18,
|
|
75
|
-
/**
|
|
76
|
-
* 虚拟鼠标触摸点移动
|
|
77
|
-
*/
|
|
78
|
-
VIRTUAL_MOUSE_POINTER = 19,
|
|
79
|
-
/**
|
|
80
|
-
*
|
|
81
|
-
*/
|
|
82
|
-
VIRTUAL_MOUSE_DOWN = 20,
|
|
83
|
-
/**
|
|
84
|
-
*
|
|
85
|
-
*/
|
|
86
|
-
VIRTUAL_MOUSE_UP = 21,
|
|
87
|
-
/**
|
|
88
|
-
* 虚拟滚轮滚动
|
|
89
|
-
*/
|
|
90
|
-
VIRTUAL_MOUSE_WHEEL = 22,
|
|
91
|
-
/***
|
|
92
|
-
* pc鼠标事件转发
|
|
93
|
-
*/
|
|
94
|
-
MOUSE_MOVE = 23,
|
|
95
|
-
MOUSE_WHEEL = 24,
|
|
96
|
-
MOUSE_DOWN = 25,
|
|
97
|
-
MOUSE_UP = 26,
|
|
98
|
-
/**
|
|
99
|
-
* 鼠标指针移动
|
|
100
|
-
*/
|
|
101
|
-
CURSOR_MOVE = 27,
|
|
102
|
-
/**
|
|
103
|
-
* 鼠标变化
|
|
104
|
-
*/
|
|
105
|
-
APP_CURSOR_CHANGE = 28,
|
|
106
|
-
FULL_SCREEN_CHANGE = 29,
|
|
107
|
-
REMOTE_SCREEN_READY = 30,
|
|
108
|
-
DISPATCH_CONTROLLER = 31,
|
|
109
|
-
LK_RE_CONNECT_DATA_CHANNEL = 32,
|
|
110
|
-
LK_CLOSE_DATA_CHANNEL = 33,
|
|
111
|
-
LK_DATA_CHANNEL_SEND_TEXT = 34,
|
|
112
|
-
LK_DATA_CHANNEL_SEND_BINARY = 35,
|
|
113
|
-
LK_DATA_CHANNEL_SEND_VIEW_PORT = 36,
|
|
114
|
-
LK_DATA_CHANNEL_SEND_CLIENT_INFO = 37,
|
|
115
|
-
LK_DATA_CHANNEL_RENDERSERVER_SEND_TEXT = 38,
|
|
116
|
-
LK_DATA_CHANNEL_RENDERSERVER_SEND_BINARY = 39,
|
|
117
|
-
INPUT_TEXT = 40,
|
|
118
|
-
SET_VOLUME = 41,
|
|
119
|
-
LK_IFRAME_POSTER_FUNC_RESTART_CLOUD_APP = 42,
|
|
120
|
-
LK_IFRAME_POSTER_FUNC_WX_JS_BRIDGE_READY = 43,
|
|
121
|
-
LK_REQUEST_CAPTURE_FRAME = 44,
|
|
122
|
-
LK_REQUEST_CAPTURE_FRAME_WITH_EXTRA_DATA = 45
|
|
123
|
-
}
|
|
124
|
-
export declare type GlobalEvent = LocalEvent<GLOBAL_EVENT_TYPE>;
|
|
125
|
-
export declare function createGlobalEvent(type: GLOBAL_EVENT_TYPE, target?: any): GlobalEvent;
|
|
126
|
-
export default GLOBAL_EVENT_TYPE;
|
package/types/event/message.d.ts
DELETED
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
export declare class Msglevel {
|
|
2
|
-
static get INFO(): string;
|
|
3
|
-
static get WARING(): string;
|
|
4
|
-
static get ERROR(): string;
|
|
5
|
-
}
|
|
6
|
-
export declare class Msg {
|
|
7
|
-
/**
|
|
8
|
-
* peerconnection messages
|
|
9
|
-
*/
|
|
10
|
-
static get CONNECT_WEBRTC(): string;
|
|
11
|
-
static get ICE_FAILED(): string;
|
|
12
|
-
static get ICE_SUCCESS(): string;
|
|
13
|
-
static get WEBRTC_HANGUP(): string;
|
|
14
|
-
/**
|
|
15
|
-
* app server messages
|
|
16
|
-
*/
|
|
17
|
-
static get CONNECT_WS_ERR(): string;
|
|
18
|
-
static get CONNECT_WS_ERR_1(): string;
|
|
19
|
-
static get CONNECT_WS_CLOSE(): string;
|
|
20
|
-
static get APP_LOGIN_ERR_1(): string;
|
|
21
|
-
static get APP_LOGIN_ERR_2(): string;
|
|
22
|
-
static get CONNECT_APP_ERR(): string;
|
|
23
|
-
static get CONNECT_APP_ERR2(): string;
|
|
24
|
-
static get SIGNALING_APP_TIMEOUT(): string;
|
|
25
|
-
static get REMOTE_APP_FAILED(): string;
|
|
26
|
-
static get REMOTE_APP_CLOSE(): string;
|
|
27
|
-
/**
|
|
28
|
-
* control message
|
|
29
|
-
*/
|
|
30
|
-
static get REFRESH(): string;
|
|
31
|
-
static get COURSE_OVER(): string;
|
|
32
|
-
static get COURSE_QUIT(): string;
|
|
33
|
-
/**
|
|
34
|
-
* 开启横屏
|
|
35
|
-
*/
|
|
36
|
-
static get ORIENTATION(): string;
|
|
37
|
-
/**
|
|
38
|
-
* 请求相对鼠标模式
|
|
39
|
-
*/
|
|
40
|
-
static get REQUEST_LOCK_MOUSE(): string;
|
|
41
|
-
/**
|
|
42
|
-
* 进入独占模式
|
|
43
|
-
*/
|
|
44
|
-
static get LOCK_MOUSE(): string;
|
|
45
|
-
/**
|
|
46
|
-
* 输入参数错误
|
|
47
|
-
*/
|
|
48
|
-
static get PARAM_ERROR(): string;
|
|
49
|
-
/**
|
|
50
|
-
*
|
|
51
|
-
*/
|
|
52
|
-
static get LOAD_CONFIG_FAILED(): string;
|
|
53
|
-
/**
|
|
54
|
-
*
|
|
55
|
-
*/
|
|
56
|
-
static get TOKEN_EXPIRED(): string;
|
|
57
|
-
/**
|
|
58
|
-
* 浏览器需要用户确认播放视频
|
|
59
|
-
*/
|
|
60
|
-
static get REQUEST_PLAY_VIDEO(): string;
|
|
61
|
-
/**
|
|
62
|
-
* 无操作超时
|
|
63
|
-
*/
|
|
64
|
-
static get NO_OPERATION_TIMEOUT(): string;
|
|
65
|
-
/**
|
|
66
|
-
* 超过载入时间
|
|
67
|
-
*/
|
|
68
|
-
static get LK_LOADING_TIMEOUT(): string;
|
|
69
|
-
}
|