larksr_websdk 3.3.112 → 3.3.114
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/en/config.md +228 -228
- package/dist/doc/en/dev.md +83 -83
- package/dist/doc/en/event_codes.md +286 -286
- package/dist/doc/en/events.md +229 -229
- package/dist/doc/en/functions.md +603 -603
- package/dist/doc/en/index.md +115 -115
- package/dist/doc/en/member_variables.md +403 -403
- package/dist/doc/en/multi_media_3_2_401.md +83 -83
- package/dist/doc/en/sdkid_encryption.md +40 -40
- package/dist/doc/en/update.md +462 -462
- package/dist/doc/zh_CN/update.md +579 -579
- package/dist/larksr-web-sdk.min.js +1 -1
- package/dist/types/api.d.ts +1 -1
- package/dist/types/event/event_base.d.ts +1 -1
- package/dist/types/lark/application.d.ts +3 -1
- package/dist/types/lark/peer_connection.d.ts +7 -1
- package/dist/types/larksr.d.ts +5 -1
- package/dist/types/operation/keymap.d.ts +1 -1
- package/dist/types/protobuf/cloudlark.d.ts +3 -9926
- package/dist/types/screen_state.d.ts +1 -1
- package/package.json +72 -72
- package/types/api.d.ts +1 -1
- package/types/event/event_base.d.ts +1 -1
- package/types/lark/application.d.ts +3 -1
- package/types/lark/peer_connection.d.ts +7 -1
- package/types/larksr.d.ts +5 -1
- package/types/operation/keymap.d.ts +1 -1
- package/types/protobuf/cloudlark.d.ts +3 -9926
- package/types/screen_state.d.ts +1 -1
- package/dist/types/lark/custom.d.ts +0 -7
- package/dist/types/lark/webcodecs.generated.d.ts +0 -417
- package/dist/types/utils/ios-inner-height.d.ts +0 -4
- package/types/lark/custom.d.ts +0 -7
- package/types/lark/webcodecs.generated.d.ts +0 -417
- package/types/utils/ios-inner-height.d.ts +0 -4
|
@@ -1,286 +1,286 @@
|
|
|
1
|
-
# Event Codes
|
|
2
|
-
|
|
3
|
-
The `code` field is attached to the events `LarkEvent = 'larkevent'`, `ERROR = 'error'`, `INFO = 'info'`. The specific values are listed below as `LarkEventType`.
|
|
4
|
-
All event codes may be thrown in the `LarkEvent` event.
|
|
5
|
-
|
|
6
|
-
The `LarkEventType` event codes are also used for listening to event codes when using the iframe poster method. For iframe embedding client and using event codes, refer to the demo: [larkwebclient-iframe-demos](https://github.com/ParaverseTechnology/larkwebclient-iframe-demos)
|
|
7
|
-
|
|
8
|
-
```typescript
|
|
9
|
-
//
|
|
10
|
-
// Unified client event codes.
|
|
11
|
-
//
|
|
12
|
-
export enum LarkEventType {
|
|
13
|
-
// Web client loaded successfully (added in 3.1.8.1)
|
|
14
|
-
LK_WEB_CLIENT_LOAD_SUCCESS = 1,
|
|
15
|
-
// Enter application interface call
|
|
16
|
-
LK_TASK_CREATE_SUCCESS = 10,
|
|
17
|
-
LK_TASK_CREATE_FAILED = 11,
|
|
18
|
-
// Insufficient rendering resources
|
|
19
|
-
LK_RESOURCE_NOT_ENOUGH = 12,
|
|
20
|
-
// Synchronizing application
|
|
21
|
-
LK_TASK_SYNC_APP = 20,
|
|
22
|
-
// Sync task failed (added in 3.1.8.1)
|
|
23
|
-
LK_TASK_SYNC_APP_FAILED = 21,
|
|
24
|
-
//
|
|
25
|
-
// Connect to application server events. Thrown when directly connecting to the rendering server
|
|
26
|
-
// Message source: websocket connection events
|
|
27
|
-
//
|
|
28
|
-
// Connected to rendering server successfully
|
|
29
|
-
LK_RENDER_SERVER_CONNECTED = 100,
|
|
30
|
-
// Failed to connect to rendering server
|
|
31
|
-
LK_RENDER_SERVER_FAILED = 101,
|
|
32
|
-
// Connection to rendering server closed
|
|
33
|
-
LK_RENDER_SERVER_CLOSE = 102,
|
|
34
|
-
// Connection to rendering server error
|
|
35
|
-
LK_RENDER_SERVER_ERROR = 103,
|
|
36
|
-
|
|
37
|
-
//
|
|
38
|
-
// Connect to websocket proxy server events
|
|
39
|
-
// Message source: websocket proxy connection events
|
|
40
|
-
//
|
|
41
|
-
// Connected to proxy server successfully
|
|
42
|
-
LK_PROXY_SERVER_CONNECTED = 200,
|
|
43
|
-
// Failed to connect to proxy server
|
|
44
|
-
LK_PROXY_SERVER_FAILED = 201,
|
|
45
|
-
// Connection to proxy server closed
|
|
46
|
-
LK_PROXY_SERVER_CLOSE = 202,
|
|
47
|
-
// Connection to proxy server error
|
|
48
|
-
LK_PROXY_SERVER_ERROR = 203,
|
|
49
|
-
|
|
50
|
-
//
|
|
51
|
-
// Version check
|
|
52
|
-
// Message source: server protocol response ToClientMessage->VersionCheckResponse
|
|
53
|
-
//
|
|
54
|
-
// Version check successful
|
|
55
|
-
LK_VERSION_CHECK_SUCCESS = 300,
|
|
56
|
-
// Version check failed
|
|
57
|
-
LK_VERSION_CHECK_FAILED = 301,
|
|
58
|
-
|
|
59
|
-
//
|
|
60
|
-
// Task check
|
|
61
|
-
// Message source: server protocol response ToClientMessage->TaskResponse
|
|
62
|
-
//
|
|
63
|
-
// Request task successful
|
|
64
|
-
LK_TASK_SUCCESS = 400,
|
|
65
|
-
// Task not found
|
|
66
|
-
LK_TASK_NOTFOUND = 401,
|
|
67
|
-
// Server error
|
|
68
|
-
LK_TASK_SERVER_ERROR = 402,
|
|
69
|
-
// Application parameter error
|
|
70
|
-
LK_TASK_APP_WRONGPARAM = 403,
|
|
71
|
-
// Task obtained successfully, but no GPU resources available
|
|
72
|
-
LK_TASK_NO_GPU_RESOURCE = 404,
|
|
73
|
-
|
|
74
|
-
//
|
|
75
|
-
// Start streaming
|
|
76
|
-
// Message source: server protocol response ToClientMessage->StartStreamResponse
|
|
77
|
-
//
|
|
78
|
-
// Start streaming successful
|
|
79
|
-
LK_START_STREAM_SUCCESS = 500,
|
|
80
|
-
// Start streaming process failed
|
|
81
|
-
LK_START_STREAM_PROCESS_START_FAILED = 501,
|
|
82
|
-
// Start streaming timeout
|
|
83
|
-
LK_START_STREAM_PROCESS_START_TIMEOUT = 502,
|
|
84
|
-
// Not streaming
|
|
85
|
-
LK_START_STREAM_NOT_STREAMING = 503,
|
|
86
|
-
// Streaming encoder error
|
|
87
|
-
LK_START_STREAM_ENCODER_ERROR = 504,
|
|
88
|
-
|
|
89
|
-
//
|
|
90
|
-
// RTC events
|
|
91
|
-
// Message source: webrtc connection events and ToClientMessage->WebrtcError
|
|
92
|
-
//
|
|
93
|
-
// RTC connection successful
|
|
94
|
-
LK_RTC_EVENT_PEERCONNECTION_CONNECTED = 600,
|
|
95
|
-
// RTC connection closed
|
|
96
|
-
LK_RTC_EVENT_PEERCONNECTION_CLOSED = 601,
|
|
97
|
-
// RTC connection error
|
|
98
|
-
LK_RTC_EVENT_PEERCONNECTION_ERROR = 602,
|
|
99
|
-
// RTC creation error, usually due to browser not supporting webrtc
|
|
100
|
-
// Added in 3.2.0.14
|
|
101
|
-
LK_RTC_EVENT_PEERCONNECTION_CREATE_FAILED = 603,
|
|
102
|
-
// RTC state report (rtt, bitrate, etc.) Added in 3.1.1.8
|
|
103
|
-
LK_RTC_EVENT_PEERCONNECTION_STATE = 610,
|
|
104
|
-
// RTC retry Added in 3.1.6.2
|
|
105
|
-
LK_RTC_EVENT_PEERCONNECTION_RETRY = 611,
|
|
106
|
-
|
|
107
|
-
//
|
|
108
|
-
// Load video stream
|
|
109
|
-
// Message source: browser or native component Fixed in 3.1.6.2
|
|
110
|
-
//
|
|
111
|
-
LK_VIDEO_LOADED = 700,
|
|
112
|
-
// Video autoplay failed, request manual trigger (3.1.8.2)
|
|
113
|
-
LK_VIDEO_PLAY_FAILED = 701,
|
|
114
|
-
// Received cloud video stream but not started playing (3.1.8.3)
|
|
115
|
-
LK_GOT_REMOTE_STREAM = 710,
|
|
116
|
-
// Received cloud video stream and started playing (3.2.13.0)
|
|
117
|
-
LK_VIDEO_PLAY_SUCCSS = 711,
|
|
118
|
-
|
|
119
|
-
//
|
|
120
|
-
// Server-initiated logout
|
|
121
|
-
// Message source: backend protocol NotifyClientLogout
|
|
122
|
-
//
|
|
123
|
-
LK_NOTIFY_CLIENT_LOGOUT_PLAYER_LOGOUT = 800,
|
|
124
|
-
// Host logout in multi-viewer mode
|
|
125
|
-
LK_NOTIFY_CLIENT_LOGOUT_TASKOWNER_LOGOUT = 801,
|
|
126
|
-
|
|
127
|
-
//
|
|
128
|
-
// Server pushes cloud application events
|
|
129
|
-
// Message source: backend protocol AppProcessNotification
|
|
130
|
-
//
|
|
131
|
-
LK_APP_PROCESS_NOTIFI_APP_QUIT = 900,
|
|
132
|
-
// No operation timeout (added in 3.1.8.1)
|
|
133
|
-
LK_NO_OPERATION_TIMEOUT = 901,
|
|
134
|
-
// Loading timeout (added in 3.1.8.8)
|
|
135
|
-
LK_LOADING_TIMEOUT = 902,
|
|
136
|
-
// Cloud application size change
|
|
137
|
-
// Added in 3.1.1.8
|
|
138
|
-
LK_APP_RESIZE = 910,
|
|
139
|
-
// Cloud application mouse mode change
|
|
140
|
-
// Added in 3.1.1.8
|
|
141
|
-
LK_APP_MOUSE_MODE = 911,
|
|
142
|
-
// Received player list
|
|
143
|
-
// Added in 3.1.1.10
|
|
144
|
-
LK_APP_PLAER_LIST = 912,
|
|
145
|
-
// APP requests text input
|
|
146
|
-
LK_APP_REQUEST_TEXT = 913,
|
|
147
|
-
// sdk new
|
|
148
|
-
// Cloud mouse style
|
|
149
|
-
LK_APP_CURSOR_STYLE = 914,
|
|
150
|
-
// User manually clicked close button
|
|
151
|
-
LK_USER_REQUEST_QUIT = 920,
|
|
152
|
-
// Local webpage resize event
|
|
153
|
-
LK_UI_RESIZE = 930,
|
|
154
|
-
|
|
155
|
-
//
|
|
156
|
-
// XR related events
|
|
157
|
-
//
|
|
158
|
-
// Start VR streaming successful
|
|
159
|
-
LK_STARTVRSTREAM_SUCCESS = 1000,
|
|
160
|
-
// Start VR streaming process failed
|
|
161
|
-
LK_STARTVRSTREAM_START_PROCESS_FAILED = 1001,
|
|
162
|
-
// Start VR streaming driver timeout
|
|
163
|
-
LK_STARTVRSTREAM_START_DRIVER_RUNTIME_TIMEOUT = 1002,
|
|
164
|
-
// Start VR streaming UDP port error
|
|
165
|
-
LK_STARTVRSTREAM_START_DRIVER_RUNTIME_UDPPORT_ERROR = 1003,
|
|
166
|
-
// Start VR streaming UDP encoder error
|
|
167
|
-
LK_STARTVRSTREAM_START_DRIVER_RUNTIME_ENCODER_ERROR = 1004,
|
|
168
|
-
|
|
169
|
-
//
|
|
170
|
-
// UI related event notifications
|
|
171
|
-
//
|
|
172
|
-
// Alert box popup (added in 3.1.8.1)
|
|
173
|
-
LK_WEBCLIENT_NOTIFY_ALERT = 1100,
|
|
174
|
-
// Confirm box popup (added in 3.1.8.1)
|
|
175
|
-
LK_WEBCLIENT_NOTIFY_CONFIRM = 1101,
|
|
176
|
-
//
|
|
177
|
-
LK_WEBCLIENT_TOAST_MSG = 1102,
|
|
178
|
-
|
|
179
|
-
// User operation triggered events
|
|
180
|
-
// User screenshot (3.1.8.3)
|
|
181
|
-
LK_USER_CAPTURE_FRAME = 2000,
|
|
182
|
-
// User screenshot with extra data (3.1.8.8)
|
|
183
|
-
LK_USER_CAPTURE_FRAME_WITH_EXTRA_DATA = 2001,
|
|
184
|
-
|
|
185
|
-
// External request for screenshot (3.1.8.3)
|
|
186
|
-
LK_REQUEST_CAPTURE_FRAME = 3000,
|
|
187
|
-
// External request for screenshot with extra data (3.1.8.8)
|
|
188
|
-
LK_REQUEST_CAPTURE_FRAME_WITH_EXTRA_DATA = 3001,
|
|
189
|
-
|
|
190
|
-
//
|
|
191
|
-
// iframe external messages to web client
|
|
192
|
-
//
|
|
193
|
-
// Operations
|
|
194
|
-
// Mouse operations
|
|
195
|
-
LK_IFRAME_POSTER_OPERATE_MOUSE_MOVE = 10000,
|
|
196
|
-
LK_IFRAME_POSTER_OPERATE_MOUSE_DOWN = 10001,
|
|
197
|
-
LK_IFRAME_POSTER_OPERATE_MOUSE_UP = 10002,
|
|
198
|
-
LK_IFRAME_POSTER_OPERATE_MOUSE_WHEEL = 10003,
|
|
199
|
-
// Keyboard operations
|
|
200
|
-
LK_IFRAME_POSTER_OPERATE_KEY_DOWN = 10010,
|
|
201
|
-
LK_IFRAME_POSTER_OPERATE_KEY_UP = 10011,
|
|
202
|
-
// Touch operations
|
|
203
|
-
LK_IFRAME_POSTER_OPERATE_TOUCH_DOWN = 10020,
|
|
204
|
-
LK_IFRAME_POSTER_OPERATE_TOUCH_MOVE = 10021,
|
|
205
|
-
LK_IFRAME_POSTER_OPERATE_TOUCH_UP = 10022,
|
|
206
|
-
// Joystick operations
|
|
207
|
-
LK_IFRAME_POSTER_OPERATE_GAMEPAD_BUTTON_DOWN = 10030,
|
|
208
|
-
LK_IFRAME_POSTER_OPERATE_GAMEPAD_BUTTON_UP = 10031,
|
|
209
|
-
LK_IFRAME_POSTER_OPERATE_GAMEPAD_TRIGGER_VALUE = 10032,
|
|
210
|
-
LK_IFRAME_POSTER_OPERATE_GAMEPAD_JOYSTICK_STATES = 10033,
|
|
211
|
-
// Microphone operations to open or close the default microphone
|
|
212
|
-
LK_IFRAME_POSTER_OPENAUDIO_INPUT = 10040,
|
|
213
|
-
LK_IFRAME_POSTER_CLOSE_AUDIO_INPUT = 10041,
|
|
214
|
-
|
|
215
|
-
// Functions
|
|
216
|
-
// Set mouse mode, lock mode and unlock mode
|
|
217
|
-
LK_IFRAME_POSTER_FUNC_MOUSE_MODE = 10100,
|
|
218
|
-
// Set scale mode
|
|
219
|
-
LK_IFRAME_POSTER_FUNC_SCALE_MODE = 10101,
|
|
220
|
-
// Restart cloud application (added in 3.1.8.1)
|
|
221
|
-
LK_IFRAME_POSTER_FUNC_RESTART_CLOUD_APP = 10102,
|
|
222
|
-
// WeChat browser load success event (added in 3.1.8.1)
|
|
223
|
-
LK_IFRAME_POSTER_FUNC_WX_JS_BRIDGE_READY = 10103,
|
|
224
|
-
// Request to play video (when video component playback fails and requires user trigger
|
|
225
|
-
// but client internal alert is disabled)
|
|
226
|
-
LK_IFRAME_POSTER_FUNC_REQUEST_PLAY_VIDEO = 10104,
|
|
227
|
-
|
|
228
|
-
// Control UI
|
|
229
|
-
// Whether to display the desktop control bar
|
|
230
|
-
LK_IFRAME_POSTER_UI_CONTROLLER_BAR = 10200,
|
|
231
|
-
// Whether to display the player list
|
|
232
|
-
LK_IFRAME_POSTER_UI_PLAYER_LIST = 10201,
|
|
233
|
-
// Whether to display the share URL in share mode
|
|
234
|
-
LK_IFRAME_POSTER_UI_PLAYER_SHARE_URL = 10202,
|
|
235
|
-
// Whether to display the mobile control ball
|
|
236
|
-
LK_IFRAME_POSTER_UI_MOBILE_CONTROL_BALL = 10203,
|
|
237
|
-
// Whether to display the mobile joystick
|
|
238
|
-
LK_IFRMAE_POSTER_UI_MOBILE_JOYSTICK = 10204,
|
|
239
|
-
// Whether to display the mobile virtual keyboard
|
|
240
|
-
LK_IFRAME_POSTER_UI_MOBILE_VIRTUAL_KEYBOARD = 10205,
|
|
241
|
-
// Whether to display the mobile virtual mouse
|
|
242
|
-
LK_IFRAME_POSTER_UI_MOBILE_VIRTUAL_MOUSE = 10206,
|
|
243
|
-
// Whether to display the mobile menu
|
|
244
|
-
LK_IFRAME_POSTER_UI_MOBILE_MENU = 10207,
|
|
245
|
-
// Whether to force landscape mode on mobile
|
|
246
|
-
LK_IFRAME_POSTER_UI_MOBILE_FORCE_LANDSCAPE = 10208,
|
|
247
|
-
// Whether to display touch points
|
|
248
|
-
LK_IFRAME_POSTER_UI_MOBILE_TOUCH_POINT = 10209,
|
|
249
|
-
// Set Toast display level (added in 3.1.8.1)
|
|
250
|
-
LK_IFRAME_POSTER_UI_TOAST_LEVEL = 10210,
|
|
251
|
-
// Set Alert display (added in 3.1.8.1)
|
|
252
|
-
LK_IFRAME_POSTER_UI_ALERT = 10211,
|
|
253
|
-
// Set Confirm display (added in 3.1.8.1)
|
|
254
|
-
LK_IFRAME_POSTER_UI_CONFIRM = 10212,
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
//
|
|
258
|
-
// iframe external messages to web client from datachannel
|
|
259
|
-
//
|
|
260
|
-
LK_DATA_CHANNEL_ESTABLISHED = 20000,
|
|
261
|
-
LK_DATA_CHANNEL_RETYING = 20001,
|
|
262
|
-
LK_DATA_CHANNEL_CLOSE = 20002,
|
|
263
|
-
LK_DATA_CHANNEL_ERROR = 20003,
|
|
264
|
-
LK_DATA_CHANNEL_BINARY_MESSAGE = 20004,
|
|
265
|
-
LK_DATA_CHANNEL_TEXT_MESSAGE = 20005,
|
|
266
|
-
//
|
|
267
|
-
// iframe external messages to web client to datachannel
|
|
268
|
-
//
|
|
269
|
-
LK_RE_CONNECT_DATA_CHANNEL = 20100,
|
|
270
|
-
LK_CLOSE_DATA_CHANNEL = 20101,
|
|
271
|
-
LK_DATA_CHANNEL_SEND_TEXT = 20102,
|
|
272
|
-
LK_DATA_CHANNEL_SEND_BINARY = 20103,
|
|
273
|
-
//
|
|
274
|
-
// iframe external messages to web client from datachannel-renderserver
|
|
275
|
-
//
|
|
276
|
-
LK_DATA_CHANNEL_RENDERSERVER_OPEN = 20200,
|
|
277
|
-
LK_DATA_CHANNEL_RENDERSERVER_CLOSE = 20201,
|
|
278
|
-
LK_DATA_CHANNEL_RENDERSERVER_BINARY_MESSAGE = 20202,
|
|
279
|
-
LK_DATA_CHANNEL_RENDERSERVER_TEXT_MESSAGE = 20203,
|
|
280
|
-
//
|
|
281
|
-
// iframe external messages to web client to datachannel
|
|
282
|
-
//
|
|
283
|
-
LK_DATA_CHANNEL_RENDERSERVER_SEND_TEXT = 20300,
|
|
284
|
-
LK_DATA_CHANNEL_RENDERSERVER_SEND_BINARY = 20301,
|
|
285
|
-
}
|
|
286
|
-
```
|
|
1
|
+
# Event Codes
|
|
2
|
+
|
|
3
|
+
The `code` field is attached to the events `LarkEvent = 'larkevent'`, `ERROR = 'error'`, `INFO = 'info'`. The specific values are listed below as `LarkEventType`.
|
|
4
|
+
All event codes may be thrown in the `LarkEvent` event.
|
|
5
|
+
|
|
6
|
+
The `LarkEventType` event codes are also used for listening to event codes when using the iframe poster method. For iframe embedding client and using event codes, refer to the demo: [larkwebclient-iframe-demos](https://github.com/ParaverseTechnology/larkwebclient-iframe-demos)
|
|
7
|
+
|
|
8
|
+
```typescript
|
|
9
|
+
//
|
|
10
|
+
// Unified client event codes.
|
|
11
|
+
//
|
|
12
|
+
export enum LarkEventType {
|
|
13
|
+
// Web client loaded successfully (added in 3.1.8.1)
|
|
14
|
+
LK_WEB_CLIENT_LOAD_SUCCESS = 1,
|
|
15
|
+
// Enter application interface call
|
|
16
|
+
LK_TASK_CREATE_SUCCESS = 10,
|
|
17
|
+
LK_TASK_CREATE_FAILED = 11,
|
|
18
|
+
// Insufficient rendering resources
|
|
19
|
+
LK_RESOURCE_NOT_ENOUGH = 12,
|
|
20
|
+
// Synchronizing application
|
|
21
|
+
LK_TASK_SYNC_APP = 20,
|
|
22
|
+
// Sync task failed (added in 3.1.8.1)
|
|
23
|
+
LK_TASK_SYNC_APP_FAILED = 21,
|
|
24
|
+
//
|
|
25
|
+
// Connect to application server events. Thrown when directly connecting to the rendering server
|
|
26
|
+
// Message source: websocket connection events
|
|
27
|
+
//
|
|
28
|
+
// Connected to rendering server successfully
|
|
29
|
+
LK_RENDER_SERVER_CONNECTED = 100,
|
|
30
|
+
// Failed to connect to rendering server
|
|
31
|
+
LK_RENDER_SERVER_FAILED = 101,
|
|
32
|
+
// Connection to rendering server closed
|
|
33
|
+
LK_RENDER_SERVER_CLOSE = 102,
|
|
34
|
+
// Connection to rendering server error
|
|
35
|
+
LK_RENDER_SERVER_ERROR = 103,
|
|
36
|
+
|
|
37
|
+
//
|
|
38
|
+
// Connect to websocket proxy server events
|
|
39
|
+
// Message source: websocket proxy connection events
|
|
40
|
+
//
|
|
41
|
+
// Connected to proxy server successfully
|
|
42
|
+
LK_PROXY_SERVER_CONNECTED = 200,
|
|
43
|
+
// Failed to connect to proxy server
|
|
44
|
+
LK_PROXY_SERVER_FAILED = 201,
|
|
45
|
+
// Connection to proxy server closed
|
|
46
|
+
LK_PROXY_SERVER_CLOSE = 202,
|
|
47
|
+
// Connection to proxy server error
|
|
48
|
+
LK_PROXY_SERVER_ERROR = 203,
|
|
49
|
+
|
|
50
|
+
//
|
|
51
|
+
// Version check
|
|
52
|
+
// Message source: server protocol response ToClientMessage->VersionCheckResponse
|
|
53
|
+
//
|
|
54
|
+
// Version check successful
|
|
55
|
+
LK_VERSION_CHECK_SUCCESS = 300,
|
|
56
|
+
// Version check failed
|
|
57
|
+
LK_VERSION_CHECK_FAILED = 301,
|
|
58
|
+
|
|
59
|
+
//
|
|
60
|
+
// Task check
|
|
61
|
+
// Message source: server protocol response ToClientMessage->TaskResponse
|
|
62
|
+
//
|
|
63
|
+
// Request task successful
|
|
64
|
+
LK_TASK_SUCCESS = 400,
|
|
65
|
+
// Task not found
|
|
66
|
+
LK_TASK_NOTFOUND = 401,
|
|
67
|
+
// Server error
|
|
68
|
+
LK_TASK_SERVER_ERROR = 402,
|
|
69
|
+
// Application parameter error
|
|
70
|
+
LK_TASK_APP_WRONGPARAM = 403,
|
|
71
|
+
// Task obtained successfully, but no GPU resources available
|
|
72
|
+
LK_TASK_NO_GPU_RESOURCE = 404,
|
|
73
|
+
|
|
74
|
+
//
|
|
75
|
+
// Start streaming
|
|
76
|
+
// Message source: server protocol response ToClientMessage->StartStreamResponse
|
|
77
|
+
//
|
|
78
|
+
// Start streaming successful
|
|
79
|
+
LK_START_STREAM_SUCCESS = 500,
|
|
80
|
+
// Start streaming process failed
|
|
81
|
+
LK_START_STREAM_PROCESS_START_FAILED = 501,
|
|
82
|
+
// Start streaming timeout
|
|
83
|
+
LK_START_STREAM_PROCESS_START_TIMEOUT = 502,
|
|
84
|
+
// Not streaming
|
|
85
|
+
LK_START_STREAM_NOT_STREAMING = 503,
|
|
86
|
+
// Streaming encoder error
|
|
87
|
+
LK_START_STREAM_ENCODER_ERROR = 504,
|
|
88
|
+
|
|
89
|
+
//
|
|
90
|
+
// RTC events
|
|
91
|
+
// Message source: webrtc connection events and ToClientMessage->WebrtcError
|
|
92
|
+
//
|
|
93
|
+
// RTC connection successful
|
|
94
|
+
LK_RTC_EVENT_PEERCONNECTION_CONNECTED = 600,
|
|
95
|
+
// RTC connection closed
|
|
96
|
+
LK_RTC_EVENT_PEERCONNECTION_CLOSED = 601,
|
|
97
|
+
// RTC connection error
|
|
98
|
+
LK_RTC_EVENT_PEERCONNECTION_ERROR = 602,
|
|
99
|
+
// RTC creation error, usually due to browser not supporting webrtc
|
|
100
|
+
// Added in 3.2.0.14
|
|
101
|
+
LK_RTC_EVENT_PEERCONNECTION_CREATE_FAILED = 603,
|
|
102
|
+
// RTC state report (rtt, bitrate, etc.) Added in 3.1.1.8
|
|
103
|
+
LK_RTC_EVENT_PEERCONNECTION_STATE = 610,
|
|
104
|
+
// RTC retry Added in 3.1.6.2
|
|
105
|
+
LK_RTC_EVENT_PEERCONNECTION_RETRY = 611,
|
|
106
|
+
|
|
107
|
+
//
|
|
108
|
+
// Load video stream
|
|
109
|
+
// Message source: browser or native component Fixed in 3.1.6.2
|
|
110
|
+
//
|
|
111
|
+
LK_VIDEO_LOADED = 700,
|
|
112
|
+
// Video autoplay failed, request manual trigger (3.1.8.2)
|
|
113
|
+
LK_VIDEO_PLAY_FAILED = 701,
|
|
114
|
+
// Received cloud video stream but not started playing (3.1.8.3)
|
|
115
|
+
LK_GOT_REMOTE_STREAM = 710,
|
|
116
|
+
// Received cloud video stream and started playing (3.2.13.0)
|
|
117
|
+
LK_VIDEO_PLAY_SUCCSS = 711,
|
|
118
|
+
|
|
119
|
+
//
|
|
120
|
+
// Server-initiated logout
|
|
121
|
+
// Message source: backend protocol NotifyClientLogout
|
|
122
|
+
//
|
|
123
|
+
LK_NOTIFY_CLIENT_LOGOUT_PLAYER_LOGOUT = 800,
|
|
124
|
+
// Host logout in multi-viewer mode
|
|
125
|
+
LK_NOTIFY_CLIENT_LOGOUT_TASKOWNER_LOGOUT = 801,
|
|
126
|
+
|
|
127
|
+
//
|
|
128
|
+
// Server pushes cloud application events
|
|
129
|
+
// Message source: backend protocol AppProcessNotification
|
|
130
|
+
//
|
|
131
|
+
LK_APP_PROCESS_NOTIFI_APP_QUIT = 900,
|
|
132
|
+
// No operation timeout (added in 3.1.8.1)
|
|
133
|
+
LK_NO_OPERATION_TIMEOUT = 901,
|
|
134
|
+
// Loading timeout (added in 3.1.8.8)
|
|
135
|
+
LK_LOADING_TIMEOUT = 902,
|
|
136
|
+
// Cloud application size change
|
|
137
|
+
// Added in 3.1.1.8
|
|
138
|
+
LK_APP_RESIZE = 910,
|
|
139
|
+
// Cloud application mouse mode change
|
|
140
|
+
// Added in 3.1.1.8
|
|
141
|
+
LK_APP_MOUSE_MODE = 911,
|
|
142
|
+
// Received player list
|
|
143
|
+
// Added in 3.1.1.10
|
|
144
|
+
LK_APP_PLAER_LIST = 912,
|
|
145
|
+
// APP requests text input
|
|
146
|
+
LK_APP_REQUEST_TEXT = 913,
|
|
147
|
+
// sdk new
|
|
148
|
+
// Cloud mouse style
|
|
149
|
+
LK_APP_CURSOR_STYLE = 914,
|
|
150
|
+
// User manually clicked close button
|
|
151
|
+
LK_USER_REQUEST_QUIT = 920,
|
|
152
|
+
// Local webpage resize event
|
|
153
|
+
LK_UI_RESIZE = 930,
|
|
154
|
+
|
|
155
|
+
//
|
|
156
|
+
// XR related events
|
|
157
|
+
//
|
|
158
|
+
// Start VR streaming successful
|
|
159
|
+
LK_STARTVRSTREAM_SUCCESS = 1000,
|
|
160
|
+
// Start VR streaming process failed
|
|
161
|
+
LK_STARTVRSTREAM_START_PROCESS_FAILED = 1001,
|
|
162
|
+
// Start VR streaming driver timeout
|
|
163
|
+
LK_STARTVRSTREAM_START_DRIVER_RUNTIME_TIMEOUT = 1002,
|
|
164
|
+
// Start VR streaming UDP port error
|
|
165
|
+
LK_STARTVRSTREAM_START_DRIVER_RUNTIME_UDPPORT_ERROR = 1003,
|
|
166
|
+
// Start VR streaming UDP encoder error
|
|
167
|
+
LK_STARTVRSTREAM_START_DRIVER_RUNTIME_ENCODER_ERROR = 1004,
|
|
168
|
+
|
|
169
|
+
//
|
|
170
|
+
// UI related event notifications
|
|
171
|
+
//
|
|
172
|
+
// Alert box popup (added in 3.1.8.1)
|
|
173
|
+
LK_WEBCLIENT_NOTIFY_ALERT = 1100,
|
|
174
|
+
// Confirm box popup (added in 3.1.8.1)
|
|
175
|
+
LK_WEBCLIENT_NOTIFY_CONFIRM = 1101,
|
|
176
|
+
//
|
|
177
|
+
LK_WEBCLIENT_TOAST_MSG = 1102,
|
|
178
|
+
|
|
179
|
+
// User operation triggered events
|
|
180
|
+
// User screenshot (3.1.8.3)
|
|
181
|
+
LK_USER_CAPTURE_FRAME = 2000,
|
|
182
|
+
// User screenshot with extra data (3.1.8.8)
|
|
183
|
+
LK_USER_CAPTURE_FRAME_WITH_EXTRA_DATA = 2001,
|
|
184
|
+
|
|
185
|
+
// External request for screenshot (3.1.8.3)
|
|
186
|
+
LK_REQUEST_CAPTURE_FRAME = 3000,
|
|
187
|
+
// External request for screenshot with extra data (3.1.8.8)
|
|
188
|
+
LK_REQUEST_CAPTURE_FRAME_WITH_EXTRA_DATA = 3001,
|
|
189
|
+
|
|
190
|
+
//
|
|
191
|
+
// iframe external messages to web client
|
|
192
|
+
//
|
|
193
|
+
// Operations
|
|
194
|
+
// Mouse operations
|
|
195
|
+
LK_IFRAME_POSTER_OPERATE_MOUSE_MOVE = 10000,
|
|
196
|
+
LK_IFRAME_POSTER_OPERATE_MOUSE_DOWN = 10001,
|
|
197
|
+
LK_IFRAME_POSTER_OPERATE_MOUSE_UP = 10002,
|
|
198
|
+
LK_IFRAME_POSTER_OPERATE_MOUSE_WHEEL = 10003,
|
|
199
|
+
// Keyboard operations
|
|
200
|
+
LK_IFRAME_POSTER_OPERATE_KEY_DOWN = 10010,
|
|
201
|
+
LK_IFRAME_POSTER_OPERATE_KEY_UP = 10011,
|
|
202
|
+
// Touch operations
|
|
203
|
+
LK_IFRAME_POSTER_OPERATE_TOUCH_DOWN = 10020,
|
|
204
|
+
LK_IFRAME_POSTER_OPERATE_TOUCH_MOVE = 10021,
|
|
205
|
+
LK_IFRAME_POSTER_OPERATE_TOUCH_UP = 10022,
|
|
206
|
+
// Joystick operations
|
|
207
|
+
LK_IFRAME_POSTER_OPERATE_GAMEPAD_BUTTON_DOWN = 10030,
|
|
208
|
+
LK_IFRAME_POSTER_OPERATE_GAMEPAD_BUTTON_UP = 10031,
|
|
209
|
+
LK_IFRAME_POSTER_OPERATE_GAMEPAD_TRIGGER_VALUE = 10032,
|
|
210
|
+
LK_IFRAME_POSTER_OPERATE_GAMEPAD_JOYSTICK_STATES = 10033,
|
|
211
|
+
// Microphone operations to open or close the default microphone
|
|
212
|
+
LK_IFRAME_POSTER_OPENAUDIO_INPUT = 10040,
|
|
213
|
+
LK_IFRAME_POSTER_CLOSE_AUDIO_INPUT = 10041,
|
|
214
|
+
|
|
215
|
+
// Functions
|
|
216
|
+
// Set mouse mode, lock mode and unlock mode
|
|
217
|
+
LK_IFRAME_POSTER_FUNC_MOUSE_MODE = 10100,
|
|
218
|
+
// Set scale mode
|
|
219
|
+
LK_IFRAME_POSTER_FUNC_SCALE_MODE = 10101,
|
|
220
|
+
// Restart cloud application (added in 3.1.8.1)
|
|
221
|
+
LK_IFRAME_POSTER_FUNC_RESTART_CLOUD_APP = 10102,
|
|
222
|
+
// WeChat browser load success event (added in 3.1.8.1)
|
|
223
|
+
LK_IFRAME_POSTER_FUNC_WX_JS_BRIDGE_READY = 10103,
|
|
224
|
+
// Request to play video (when video component playback fails and requires user trigger
|
|
225
|
+
// but client internal alert is disabled)
|
|
226
|
+
LK_IFRAME_POSTER_FUNC_REQUEST_PLAY_VIDEO = 10104,
|
|
227
|
+
|
|
228
|
+
// Control UI
|
|
229
|
+
// Whether to display the desktop control bar
|
|
230
|
+
LK_IFRAME_POSTER_UI_CONTROLLER_BAR = 10200,
|
|
231
|
+
// Whether to display the player list
|
|
232
|
+
LK_IFRAME_POSTER_UI_PLAYER_LIST = 10201,
|
|
233
|
+
// Whether to display the share URL in share mode
|
|
234
|
+
LK_IFRAME_POSTER_UI_PLAYER_SHARE_URL = 10202,
|
|
235
|
+
// Whether to display the mobile control ball
|
|
236
|
+
LK_IFRAME_POSTER_UI_MOBILE_CONTROL_BALL = 10203,
|
|
237
|
+
// Whether to display the mobile joystick
|
|
238
|
+
LK_IFRMAE_POSTER_UI_MOBILE_JOYSTICK = 10204,
|
|
239
|
+
// Whether to display the mobile virtual keyboard
|
|
240
|
+
LK_IFRAME_POSTER_UI_MOBILE_VIRTUAL_KEYBOARD = 10205,
|
|
241
|
+
// Whether to display the mobile virtual mouse
|
|
242
|
+
LK_IFRAME_POSTER_UI_MOBILE_VIRTUAL_MOUSE = 10206,
|
|
243
|
+
// Whether to display the mobile menu
|
|
244
|
+
LK_IFRAME_POSTER_UI_MOBILE_MENU = 10207,
|
|
245
|
+
// Whether to force landscape mode on mobile
|
|
246
|
+
LK_IFRAME_POSTER_UI_MOBILE_FORCE_LANDSCAPE = 10208,
|
|
247
|
+
// Whether to display touch points
|
|
248
|
+
LK_IFRAME_POSTER_UI_MOBILE_TOUCH_POINT = 10209,
|
|
249
|
+
// Set Toast display level (added in 3.1.8.1)
|
|
250
|
+
LK_IFRAME_POSTER_UI_TOAST_LEVEL = 10210,
|
|
251
|
+
// Set Alert display (added in 3.1.8.1)
|
|
252
|
+
LK_IFRAME_POSTER_UI_ALERT = 10211,
|
|
253
|
+
// Set Confirm display (added in 3.1.8.1)
|
|
254
|
+
LK_IFRAME_POSTER_UI_CONFIRM = 10212,
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
//
|
|
258
|
+
// iframe external messages to web client from datachannel
|
|
259
|
+
//
|
|
260
|
+
LK_DATA_CHANNEL_ESTABLISHED = 20000,
|
|
261
|
+
LK_DATA_CHANNEL_RETYING = 20001,
|
|
262
|
+
LK_DATA_CHANNEL_CLOSE = 20002,
|
|
263
|
+
LK_DATA_CHANNEL_ERROR = 20003,
|
|
264
|
+
LK_DATA_CHANNEL_BINARY_MESSAGE = 20004,
|
|
265
|
+
LK_DATA_CHANNEL_TEXT_MESSAGE = 20005,
|
|
266
|
+
//
|
|
267
|
+
// iframe external messages to web client to datachannel
|
|
268
|
+
//
|
|
269
|
+
LK_RE_CONNECT_DATA_CHANNEL = 20100,
|
|
270
|
+
LK_CLOSE_DATA_CHANNEL = 20101,
|
|
271
|
+
LK_DATA_CHANNEL_SEND_TEXT = 20102,
|
|
272
|
+
LK_DATA_CHANNEL_SEND_BINARY = 20103,
|
|
273
|
+
//
|
|
274
|
+
// iframe external messages to web client from datachannel-renderserver
|
|
275
|
+
//
|
|
276
|
+
LK_DATA_CHANNEL_RENDERSERVER_OPEN = 20200,
|
|
277
|
+
LK_DATA_CHANNEL_RENDERSERVER_CLOSE = 20201,
|
|
278
|
+
LK_DATA_CHANNEL_RENDERSERVER_BINARY_MESSAGE = 20202,
|
|
279
|
+
LK_DATA_CHANNEL_RENDERSERVER_TEXT_MESSAGE = 20203,
|
|
280
|
+
//
|
|
281
|
+
// iframe external messages to web client to datachannel
|
|
282
|
+
//
|
|
283
|
+
LK_DATA_CHANNEL_RENDERSERVER_SEND_TEXT = 20300,
|
|
284
|
+
LK_DATA_CHANNEL_RENDERSERVER_SEND_BINARY = 20301,
|
|
285
|
+
}
|
|
286
|
+
```
|