@realsee/live 0.1.1 → 0.3.0-alpha.1

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.
Files changed (102) hide show
  1. package/README.md +111 -58
  2. package/docs/.nojekyll +1 -0
  3. package/docs/assets/custom.css +43 -0
  4. package/docs/assets/highlight.css +127 -0
  5. package/docs/assets/icons.css +1043 -0
  6. package/docs/assets/{images/icons.png → icons.png} +0 -0
  7. package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
  8. package/docs/assets/main.js +52 -0
  9. package/docs/assets/search.js +1 -0
  10. package/docs/assets/style.css +1388 -0
  11. package/docs/assets/{images/widgets.png → widgets.png} +0 -0
  12. package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  13. package/docs/classes/RTCProtocol.BrowserRTC.html +60 -0
  14. package/docs/classes/RTCProtocol.BrowserRTC4Chime.html +66 -0
  15. package/docs/classes/RTCProtocol.RTCExample.html +62 -814
  16. package/docs/classes/RTCProtocol.VRWebViewRTC.html +60 -0
  17. package/docs/classes/shared_utils.Subscribe.html +55 -596
  18. package/docs/enums/RTCProtocol.RTCJoinedInfoCodeEnum.html +9 -0
  19. package/docs/enums/RTCProtocol.RTCType.html +1 -185
  20. package/docs/enums/live.BuiltinActionType.html +15 -325
  21. package/docs/enums/live.BuiltinEventType.html +7 -268
  22. package/docs/enums/live.Command.html +7 -346
  23. package/docs/enums/live.MemUserStatus.html +1 -307
  24. package/docs/enums/live.MicroStatus.html +3 -258
  25. package/docs/enums/live.UserStatus.html +9 -287
  26. package/docs/enums/live.WebSocketCloseError.html +19 -382
  27. package/docs/enums/live.WebSocketErrorType.html +1 -307
  28. package/docs/enums/live.WebSocketState.html +13 -325
  29. package/docs/index.html +356 -510
  30. package/docs/interfaces/RTCProtocol.GetVoiceSignReturnType.html +1 -0
  31. package/docs/interfaces/RTCProtocol.RTCJoinedInfo.html +1 -0
  32. package/docs/interfaces/RTCProtocol.RTCProtocol-1.html +60 -765
  33. package/docs/interfaces/RTCProtocol.VRWebViewRTCOptions.html +1 -0
  34. package/docs/interfaces/live.Live.html +119 -1302
  35. package/docs/interfaces/live.LiveOptions.html +22 -499
  36. package/docs/interfaces/live.LiveReact.html +52 -984
  37. package/docs/modules/RTCProtocol.html +17 -361
  38. package/docs/modules/live.html +103 -1219
  39. package/docs/modules/shared_utils.html +10 -248
  40. package/docs/modules.html +1 -125
  41. package/lib/RTC/BrowserRTC.d.ts +30 -0
  42. package/lib/RTC/BrowserRTC.js +169 -0
  43. package/lib/RTC/BrowserRTC.js.map +1 -0
  44. package/lib/RTC/BrowserRTC4Chime.d.ts +53 -0
  45. package/lib/RTC/BrowserRTC4Chime.js +299 -0
  46. package/lib/RTC/BrowserRTC4Chime.js.map +1 -0
  47. package/lib/RTC/VRWebViewRTC.d.ts +23 -0
  48. package/lib/RTC/VRWebViewRTC.js +124 -0
  49. package/lib/RTC/VRWebViewRTC.js.map +1 -0
  50. package/lib/RTC/index.d.ts +22 -0
  51. package/lib/{RTCProtocol → RTC}/index.js +3 -7
  52. package/lib/RTC/index.js.map +1 -0
  53. package/lib/createLive.d.ts +1 -1
  54. package/lib/createLive.js +50 -22
  55. package/lib/createLive.js.map +1 -1
  56. package/lib/createLiveReact.d.ts +11 -10
  57. package/lib/createLiveReact.js +4 -6
  58. package/lib/createLiveReact.js.map +1 -1
  59. package/lib/shared-utils/Subscribe.d.ts +1 -1
  60. package/lib/typings/Chime/AttendeeResponse.d.ts +5 -0
  61. package/lib/typings/Chime/AttendeeResponse.js +3 -0
  62. package/lib/typings/Chime/AttendeeResponse.js.map +1 -0
  63. package/lib/typings/Chime/MeetingResponse.d.ts +12 -0
  64. package/lib/typings/Chime/MeetingResponse.js +3 -0
  65. package/lib/typings/Chime/MeetingResponse.js.map +1 -0
  66. package/lib/typings/Chime/MeetingSessionConfigurationOptions.d.ts +16 -0
  67. package/lib/typings/Chime/MeetingSessionConfigurationOptions.js +3 -0
  68. package/lib/typings/Chime/MeetingSessionConfigurationOptions.js.map +1 -0
  69. package/lib/typings/EventType.d.ts +10 -0
  70. package/lib/typings/GetVoiceSign.d.ts +11 -0
  71. package/lib/typings/GetVoiceSign.js +3 -0
  72. package/lib/typings/GetVoiceSign.js.map +1 -0
  73. package/lib/typings/Live.d.ts +6 -4
  74. package/lib/typings/LiveMsg.d.ts +4 -0
  75. package/lib/typings/LiveMsg.js +4 -0
  76. package/lib/typings/LiveMsg.js.map +1 -1
  77. package/lib/typings/LiveOptions.d.ts +3 -7
  78. package/lib/typings/RTCEventType.d.ts +2 -14
  79. package/lib/typings/RTCEventType.js +0 -7
  80. package/lib/typings/RTCEventType.js.map +1 -1
  81. package/lib/typings/RTCJoinedInfo.d.ts +28 -0
  82. package/lib/typings/RTCJoinedInfo.js +23 -0
  83. package/lib/typings/RTCJoinedInfo.js.map +1 -0
  84. package/lib/{RTCProtocol/index.d.ts → typings/RTCProtocol.d.ts} +1 -19
  85. package/lib/typings/RTCProtocol.js +9 -0
  86. package/lib/typings/RTCProtocol.js.map +1 -0
  87. package/lib/typings/VRWebViewRTCOptions.d.ts +6 -0
  88. package/lib/typings/VRWebViewRTCOptions.js +3 -0
  89. package/lib/typings/VRWebViewRTCOptions.js.map +1 -0
  90. package/lib/typings/WebSocket.d.ts +2 -1
  91. package/lib/typings/WebSocket.js +1 -0
  92. package/lib/typings/WebSocket.js.map +1 -1
  93. package/package.json +8 -3
  94. package/umd/{RTCProtocol.046933a5.js → RTCProtocol.543610f0.js} +1 -1
  95. package/umd/createLive.a6edf473.js +1 -0
  96. package/umd/createLiveReact.e21b4514.js +1 -0
  97. package/docs/assets/css/main.css +0 -2787
  98. package/docs/assets/js/main.js +0 -248
  99. package/docs/assets/js/search.js +0 -1
  100. package/lib/RTCProtocol/index.js.map +0 -1
  101. package/umd/createLive.6845145e.js +0 -1
  102. package/umd/createLiveReact.406cf5a3.js +0 -1
package/docs/enums/live.WebSocketCloseError.html CHANGED
@@ -1,382 +1,19 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>WebSocketCloseError | 如视 Live SDK - v0.1.1</title>
7
- <meta name="description" content="Documentation for 如视 Live SDK - v0.1.1">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- <script async src="../assets/js/search.js" id="search-script"></script>
11
- </head>
12
- <body>
13
- <header>
14
- <div class="tsd-page-toolbar">
15
- <div class="container">
16
- <div class="table-wrap">
17
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
- <div class="field">
19
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
- <input id="tsd-search-field" type="text" />
21
- </div>
22
- <ul class="results">
23
- <li class="state loading">Preparing search index...</li>
24
- <li class="state failure">The search index is not available</li>
25
- </ul>
26
- <a href="../index.html" class="title">如视 Live SDK - v0.1.1</a>
27
- </div>
28
- <div class="table-cell" id="tsd-widgets">
29
- <div id="tsd-filter">
30
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
- <div class="tsd-filter-group">
32
- <div class="tsd-select" id="tsd-filter-visibility">
33
- <span class="tsd-select-label">All</span>
34
- <ul class="tsd-select-list">
35
- <li data-value="public">Public</li>
36
- <li data-value="protected">Public/Protected</li>
37
- <li data-value="private" class="selected">All</li>
38
- </ul>
39
- </div>
40
- <input type="checkbox" id="tsd-filter-inherited" checked />
41
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
- </div>
43
- </div>
44
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
45
- </div>
46
- </div>
47
- </div>
48
- </div>
49
- <div class="tsd-page-title">
50
- <div class="container">
51
- <ul class="tsd-breadcrumb">
52
- <li>
53
- <a href="../modules.html">如视 Live SDK - v0.1.1</a>
54
- </li>
55
- <li>
56
- <a href="../modules/live.html">live</a>
57
- </li>
58
- <li>
59
- <a href="live.WebSocketCloseError.html">WebSocketCloseError</a>
60
- </li>
61
- </ul>
62
- <h1>Enumeration WebSocketCloseError</h1>
63
- </div>
64
- </div>
65
- </header>
66
- <div class="container container-main">
67
- <div class="row">
68
- <div class="col-8 col-content">
69
- <section class="tsd-panel tsd-comment">
70
- <div class="tsd-comment tsd-typography">
71
- <div class="lead">
72
- <p>WebSocket 异常关闭枚举：<a href="https://developer.mozilla.org/zh-CN/docs/Web/API/CloseEvent%E3%80%82">https://developer.mozilla.org/zh-CN/docs/Web/API/CloseEvent。</a></p>
73
- </div>
74
- </div>
75
- </section>
76
- <section class="tsd-panel-group tsd-index-group">
77
- <h2>Index</h2>
78
- <section class="tsd-panel tsd-index-panel">
79
- <div class="tsd-index-content">
80
- <section class="tsd-index-section ">
81
- <h3>Enumeration members</h3>
82
- <ul class="tsd-index-list">
83
- <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1001" class="tsd-kind-icon">Err_<wbr>1001</a></li>
84
- <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1002" class="tsd-kind-icon">Err_<wbr>1002</a></li>
85
- <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1003" class="tsd-kind-icon">Err_<wbr>1003</a></li>
86
- <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1006" class="tsd-kind-icon">Err_<wbr>1006</a></li>
87
- <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1007" class="tsd-kind-icon">Err_<wbr>1007</a></li>
88
- <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1008" class="tsd-kind-icon">Err_<wbr>1008</a></li>
89
- <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1009" class="tsd-kind-icon">Err_<wbr>1009</a></li>
90
- <li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_unknown" class="tsd-kind-icon">Err_<wbr>unknown</a></li>
91
- </ul>
92
- </section>
93
- </div>
94
- </section>
95
- </section>
96
- <section class="tsd-panel-group tsd-member-group ">
97
- <h2>Enumeration members</h2>
98
- <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
99
- <a name="Err_1001" class="tsd-anchor"></a>
100
- <h3>Err_<wbr>1001</h3>
101
- <div class="tsd-signature tsd-kind-icon">Err_<wbr>1001<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;CLOSE_GOING_AWAY&quot;</span></div>
102
- <aside class="tsd-sources">
103
- <ul>
104
- <li>Defined in typings/WebSocket.ts:54</li>
105
- </ul>
106
- </aside>
107
- <div class="tsd-comment tsd-typography">
108
- <div class="lead">
109
- <p>终端离开, 可能因为服务端错误, 也可能因为浏览器正从打开连接的页面跳转离开。</p>
110
- </div>
111
- </div>
112
- </section>
113
- <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
114
- <a name="Err_1002" class="tsd-anchor"></a>
115
- <h3>Err_<wbr>1002</h3>
116
- <div class="tsd-signature tsd-kind-icon">Err_<wbr>1002<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;CLOSE_PROTOCOL_ERROR&quot;</span></div>
117
- <aside class="tsd-sources">
118
- <ul>
119
- <li>Defined in typings/WebSocket.ts:59</li>
120
- </ul>
121
- </aside>
122
- <div class="tsd-comment tsd-typography">
123
- <div class="lead">
124
- <p>由于协议错误而中断连接。</p>
125
- </div>
126
- </div>
127
- </section>
128
- <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
129
- <a name="Err_1003" class="tsd-anchor"></a>
130
- <h3>Err_<wbr>1003</h3>
131
- <div class="tsd-signature tsd-kind-icon">Err_<wbr>1003<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;CLOSE_UNSUPPORTED&quot;</span></div>
132
- <aside class="tsd-sources">
133
- <ul>
134
- <li>Defined in typings/WebSocket.ts:64</li>
135
- </ul>
136
- </aside>
137
- <div class="tsd-comment tsd-typography">
138
- <div class="lead">
139
- <p>由于接收到不允许的数据类型而断开连接 (如仅接收文本数据的终端接收到了二进制数据)。</p>
140
- </div>
141
- </div>
142
- </section>
143
- <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
144
- <a name="Err_1006" class="tsd-anchor"></a>
145
- <h3>Err_<wbr>1006</h3>
146
- <div class="tsd-signature tsd-kind-icon">Err_<wbr>1006<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;CLOSE_ABNORMAL&quot;</span></div>
147
- <aside class="tsd-sources">
148
- <ul>
149
- <li>Defined in typings/WebSocket.ts:69</li>
150
- </ul>
151
- </aside>
152
- <div class="tsd-comment tsd-typography">
153
- <div class="lead">
154
- <p>安全因素或WebSocket连接次数达到上限。</p>
155
- </div>
156
- </div>
157
- </section>
158
- <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
159
- <a name="Err_1007" class="tsd-anchor"></a>
160
- <h3>Err_<wbr>1007</h3>
161
- <div class="tsd-signature tsd-kind-icon">Err_<wbr>1007<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;Unsupported Data&quot;</span></div>
162
- <aside class="tsd-sources">
163
- <ul>
164
- <li>Defined in typings/WebSocket.ts:74</li>
165
- </ul>
166
- </aside>
167
- <div class="tsd-comment tsd-typography">
168
- <div class="lead">
169
- <p>由于收到了格式不符的数据而断开连接 (如文本消息中包含了非 UTF-8 数据)。</p>
170
- </div>
171
- </div>
172
- </section>
173
- <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
174
- <a name="Err_1008" class="tsd-anchor"></a>
175
- <h3>Err_<wbr>1008</h3>
176
- <div class="tsd-signature tsd-kind-icon">Err_<wbr>1008<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;Policy Violation&quot;</span></div>
177
- <aside class="tsd-sources">
178
- <ul>
179
- <li>Defined in typings/WebSocket.ts:78</li>
180
- </ul>
181
- </aside>
182
- <div class="tsd-comment tsd-typography">
183
- <div class="lead">
184
- <p>由于收到不符合约定的数据而断开连接。</p>
185
- </div>
186
- </div>
187
- </section>
188
- <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
189
- <a name="Err_1009" class="tsd-anchor"></a>
190
- <h3>Err_<wbr>1009</h3>
191
- <div class="tsd-signature tsd-kind-icon">Err_<wbr>1009<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;CLOSE_TOO_LARGE&quot;</span></div>
192
- <aside class="tsd-sources">
193
- <ul>
194
- <li>Defined in typings/WebSocket.ts:82</li>
195
- </ul>
196
- </aside>
197
- <div class="tsd-comment tsd-typography">
198
- <div class="lead">
199
- <p>由于收到过大的数据帧而断开连接。</p>
200
- </div>
201
- </div>
202
- </section>
203
- <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
204
- <a name="Err_unknown" class="tsd-anchor"></a>
205
- <h3>Err_<wbr>unknown</h3>
206
- <div class="tsd-signature tsd-kind-icon">Err_<wbr>unknown<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;unknown&quot;</span></div>
207
- <aside class="tsd-sources">
208
- <ul>
209
- <li>Defined in typings/WebSocket.ts:86</li>
210
- </ul>
211
- </aside>
212
- <div class="tsd-comment tsd-typography">
213
- <div class="lead">
214
- <p>未知错误。</p>
215
- </div>
216
- </div>
217
- </section>
218
- </section>
219
- </div>
220
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
221
- <nav class="tsd-navigation primary">
222
- <ul>
223
- <li class=" ">
224
- <a href="../modules.html">Modules</a>
225
- </li>
226
- <li class=" tsd-kind-module">
227
- <a href="../modules/RTCProtocol.html">RTCProtocol</a>
228
- </li>
229
- <li class="current tsd-kind-module">
230
- <a href="../modules/live.html">live</a>
231
- </li>
232
- <li class=" tsd-kind-module">
233
- <a href="../modules/shared_utils.html">shared-<wbr>utils</a>
234
- </li>
235
- </ul>
236
- </nav>
237
- <nav class="tsd-navigation secondary menu-sticky">
238
- <ul class="before-current">
239
- <li class=" tsd-kind-enum tsd-parent-kind-module">
240
- <a href="live.BuiltinActionType.html" class="tsd-kind-icon">Builtin<wbr>Action<wbr>Type</a>
241
- </li>
242
- <li class=" tsd-kind-enum tsd-parent-kind-module">
243
- <a href="live.BuiltinEventType.html" class="tsd-kind-icon">Builtin<wbr>Event<wbr>Type</a>
244
- </li>
245
- <li class=" tsd-kind-enum tsd-parent-kind-module">
246
- <a href="live.Command.html" class="tsd-kind-icon">Command</a>
247
- </li>
248
- <li class=" tsd-kind-enum tsd-parent-kind-module">
249
- <a href="live.MemUserStatus.html" class="tsd-kind-icon">Mem<wbr>User<wbr>Status</a>
250
- </li>
251
- <li class=" tsd-kind-enum tsd-parent-kind-module">
252
- <a href="live.MicroStatus.html" class="tsd-kind-icon">Micro<wbr>Status</a>
253
- </li>
254
- <li class=" tsd-kind-enum tsd-parent-kind-module">
255
- <a href="live.UserStatus.html" class="tsd-kind-icon">User<wbr>Status</a>
256
- </li>
257
- </ul>
258
- <ul class="current">
259
- <li class="current tsd-kind-enum tsd-parent-kind-module">
260
- <a href="live.WebSocketCloseError.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Close<wbr>Error</a>
261
- <ul>
262
- <li class=" tsd-kind-enum-member tsd-parent-kind-enum">
263
- <a href="live.WebSocketCloseError.html#Err_1001" class="tsd-kind-icon">Err_<wbr>1001</a>
264
- </li>
265
- <li class=" tsd-kind-enum-member tsd-parent-kind-enum">
266
- <a href="live.WebSocketCloseError.html#Err_1002" class="tsd-kind-icon">Err_<wbr>1002</a>
267
- </li>
268
- <li class=" tsd-kind-enum-member tsd-parent-kind-enum">
269
- <a href="live.WebSocketCloseError.html#Err_1003" class="tsd-kind-icon">Err_<wbr>1003</a>
270
- </li>
271
- <li class=" tsd-kind-enum-member tsd-parent-kind-enum">
272
- <a href="live.WebSocketCloseError.html#Err_1006" class="tsd-kind-icon">Err_<wbr>1006</a>
273
- </li>
274
- <li class=" tsd-kind-enum-member tsd-parent-kind-enum">
275
- <a href="live.WebSocketCloseError.html#Err_1007" class="tsd-kind-icon">Err_<wbr>1007</a>
276
- </li>
277
- <li class=" tsd-kind-enum-member tsd-parent-kind-enum">
278
- <a href="live.WebSocketCloseError.html#Err_1008" class="tsd-kind-icon">Err_<wbr>1008</a>
279
- </li>
280
- <li class=" tsd-kind-enum-member tsd-parent-kind-enum">
281
- <a href="live.WebSocketCloseError.html#Err_1009" class="tsd-kind-icon">Err_<wbr>1009</a>
282
- </li>
283
- <li class=" tsd-kind-enum-member tsd-parent-kind-enum">
284
- <a href="live.WebSocketCloseError.html#Err_unknown" class="tsd-kind-icon">Err_<wbr>unknown</a>
285
- </li>
286
- </ul>
287
- </li>
288
- </ul>
289
- <ul class="after-current">
290
- <li class=" tsd-kind-enum tsd-parent-kind-module">
291
- <a href="live.WebSocketErrorType.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Error<wbr>Type</a>
292
- </li>
293
- <li class=" tsd-kind-enum tsd-parent-kind-module">
294
- <a href="live.WebSocketState.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>State</a>
295
- </li>
296
- <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
297
- <a href="../interfaces/live.Live.html" class="tsd-kind-icon">Live</a>
298
- </li>
299
- <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
300
- <a href="../interfaces/live.LiveOptions.html" class="tsd-kind-icon">Live<wbr>Options</a>
301
- </li>
302
- <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
303
- <a href="../interfaces/live.LiveReact.html" class="tsd-kind-icon">Live<wbr>React</a>
304
- </li>
305
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
306
- <a href="../modules/live.html#BuiltinMsg" class="tsd-kind-icon">Builtin<wbr>Msg</a>
307
- </li>
308
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
309
- <a href="../modules/live.html#EventType" class="tsd-kind-icon">Event<wbr>Type</a>
310
- </li>
311
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
312
- <a href="../modules/live.html#LiveActionReactCallback" class="tsd-kind-icon">Live<wbr>Action<wbr>React<wbr>Callback</a>
313
- </li>
314
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
315
- <a href="../modules/live.html#LiveEventType" class="tsd-kind-icon">Live<wbr>Event<wbr>Type</a>
316
- </li>
317
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
318
- <a href="../modules/live.html#LiveMsg" class="tsd-kind-icon">Live<wbr>Msg</a>
319
- </li>
320
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
321
- <a href="../modules/live.html#LiveProviderPropTypes" class="tsd-kind-icon">Live<wbr>Provider<wbr>Prop<wbr>Types</a>
322
- </li>
323
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
324
- <a href="../modules/live.html#ReqLiveMsg" class="tsd-kind-icon">Req<wbr>Live<wbr>Msg</a>
325
- </li>
326
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
327
- <a href="../modules/live.html#RoomInfo" class="tsd-kind-icon">Room<wbr>Info</a>
328
- </li>
329
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
330
- <a href="../modules/live.html#UserInfo" class="tsd-kind-icon">User<wbr>Info</a>
331
- </li>
332
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
333
- <a href="../modules/live.html#UserInfoExt" class="tsd-kind-icon">User<wbr>Info<wbr>Ext</a>
334
- </li>
335
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
336
- <a href="../modules/live.html#WebSocketError" class="tsd-kind-icon">Web<wbr>Socket<wbr>Error</a>
337
- </li>
338
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
339
- <a href="../modules/live.html#WebSocketEventType" class="tsd-kind-icon">Web<wbr>Socket<wbr>Event<wbr>Type</a>
340
- </li>
341
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
342
- <a href="../modules/live.html#createLive" class="tsd-kind-icon">create<wbr>Live</a>
343
- </li>
344
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
345
- <a href="../modules/live.html#createLiveReact" class="tsd-kind-icon">create<wbr>Live<wbr>React</a>
346
- </li>
347
- <li class=" tsd-kind-function tsd-parent-kind-module">
348
- <a href="../modules/live.html#parseLiveMsg" class="tsd-kind-icon">parse<wbr>Live<wbr>Msg</a>
349
- </li>
350
- </ul>
351
- </nav>
352
- </div>
353
- </div>
354
- </div>
355
- <footer>
356
- <div class="container">
357
- <h2>Legend</h2>
358
- <div class="tsd-legend-group">
359
- <ul class="tsd-legend">
360
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
361
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
362
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
363
- <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
364
- </ul>
365
- <ul class="tsd-legend">
366
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
367
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
368
- </ul>
369
- <ul class="tsd-legend">
370
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
371
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
372
- </ul>
373
- <ul class="tsd-legend">
374
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
375
- </ul>
376
- </div>
377
- </div>
378
- </footer>
379
- <div class="overlay"></div>
380
- <script src="../assets/js/main.js"></script>
381
- </body>
382
- </html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WebSocketCloseError | 如视 Live SDK</title><meta name="description" content="Documentation for 如视 Live SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Live SDK</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">如视 Live SDK</a></li><li><a href="../modules/live.html">live</a></li><li><a href="live.WebSocketCloseError.html">WebSocketCloseError</a></li></ul><h1>Enumeration WebSocketCloseError</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>WebSocket 异常关闭枚举：<a href="https://developer.mozilla.org/zh-CN/docs/Web/API/CloseEvent%E3%80%82">https://developer.mozilla.org/zh-CN/docs/Web/API/CloseEvent。</a></p>
3
+ </div></div></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1001" class="tsd-kind-icon">Err_<wbr/>1001</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1002" class="tsd-kind-icon">Err_<wbr/>1002</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1003" class="tsd-kind-icon">Err_<wbr/>1003</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1006" class="tsd-kind-icon">Err_<wbr/>1006</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1007" class="tsd-kind-icon">Err_<wbr/>1007</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1008" class="tsd-kind-icon">Err_<wbr/>1008</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1009" class="tsd-kind-icon">Err_<wbr/>1009</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_unknown" class="tsd-kind-icon">Err_<wbr/>unknown</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_1001" class="tsd-anchor"></a><h3>Err_<wbr/>1001</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1001<span class="tsd-signature-symbol"> = &quot;CLOSE_GOING_AWAY&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:55</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>终端离开, 可能因为服务端错误, 也可能因为浏览器正从打开连接的页面跳转离开。</p>
5
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_1002" class="tsd-anchor"></a><h3>Err_<wbr/>1002</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1002<span class="tsd-signature-symbol"> = &quot;CLOSE_PROTOCOL_ERROR&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:60</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>由于协议错误而中断连接。</p>
7
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_1003" class="tsd-anchor"></a><h3>Err_<wbr/>1003</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1003<span class="tsd-signature-symbol"> = &quot;CLOSE_UNSUPPORTED&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:65</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>由于接收到不允许的数据类型而断开连接 (如仅接收文本数据的终端接收到了二进制数据)。</p>
9
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_1006" class="tsd-anchor"></a><h3>Err_<wbr/>1006</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1006<span class="tsd-signature-symbol"> = &quot;CLOSE_ABNORMAL&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:70</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
10
+ <p>安全因素或WebSocket连接次数达到上限。</p>
11
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_1007" class="tsd-anchor"></a><h3>Err_<wbr/>1007</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1007<span class="tsd-signature-symbol"> = &quot;Unsupported Data&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:75</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
12
+ <p>由于收到了格式不符的数据而断开连接 (如文本消息中包含了非 UTF-8 数据)。</p>
13
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_1008" class="tsd-anchor"></a><h3>Err_<wbr/>1008</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1008<span class="tsd-signature-symbol"> = &quot;Policy Violation&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:79</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>由于收到不符合约定的数据而断开连接。</p>
15
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_1009" class="tsd-anchor"></a><h3>Err_<wbr/>1009</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1009<span class="tsd-signature-symbol"> = &quot;CLOSE_TOO_LARGE&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:83</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
16
+ <p>由于收到过大的数据帧而断开连接。</p>
17
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_unknown" class="tsd-anchor"></a><h3>Err_<wbr/>unknown</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>unknown<span class="tsd-signature-symbol"> = &quot;unknown&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:87</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
18
+ <p>未知错误。</p>
19
+ </div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/RTCProtocol.html">RTCProtocol</a></li><li class="current tsd-kind-module"><a href="../modules/live.html">live</a></li><li class=" tsd-kind-module"><a href="../modules/shared_utils.html">shared-<wbr/>utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum tsd-parent-kind-module"><a href="live.WebSocketCloseError.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Close<wbr/>Error</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1001" class="tsd-kind-icon">Err_<wbr/>1001</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1002" class="tsd-kind-icon">Err_<wbr/>1002</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1003" class="tsd-kind-icon">Err_<wbr/>1003</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1006" class="tsd-kind-icon">Err_<wbr/>1006</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1007" class="tsd-kind-icon">Err_<wbr/>1007</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1008" class="tsd-kind-icon">Err_<wbr/>1008</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1009" class="tsd-kind-icon">Err_<wbr/>1009</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_unknown" class="tsd-kind-icon">Err_<wbr/>unknown</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>