@realsee/live 0.1.1 → 0.2.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 (90) hide show
  1. package/README.md +51 -56
  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.RTCExample.html +62 -814
  14. package/docs/classes/RTCProtocol.VRWebViewRTC.html +60 -0
  15. package/docs/classes/shared_utils.Subscribe.html +55 -596
  16. package/docs/enums/RTCProtocol.RTCJoinedInfoCodeEnum.html +9 -0
  17. package/docs/enums/RTCProtocol.RTCType.html +1 -185
  18. package/docs/enums/live.BuiltinActionType.html +15 -325
  19. package/docs/enums/live.BuiltinEventType.html +7 -268
  20. package/docs/enums/live.Command.html +7 -346
  21. package/docs/enums/live.MemUserStatus.html +1 -307
  22. package/docs/enums/live.MicroStatus.html +3 -258
  23. package/docs/enums/live.UserStatus.html +9 -287
  24. package/docs/enums/live.WebSocketCloseError.html +19 -382
  25. package/docs/enums/live.WebSocketErrorType.html +1 -307
  26. package/docs/enums/live.WebSocketState.html +13 -325
  27. package/docs/index.html +327 -512
  28. package/docs/interfaces/RTCProtocol.GetVoiceSignReturnType.html +1 -0
  29. package/docs/interfaces/RTCProtocol.RTCJoinedInfo.html +1 -0
  30. package/docs/interfaces/RTCProtocol.RTCProtocol-1.html +60 -765
  31. package/docs/interfaces/RTCProtocol.VRWebViewRTCOptions.html +1 -0
  32. package/docs/interfaces/live.Live.html +119 -1302
  33. package/docs/interfaces/live.LiveOptions.html +22 -499
  34. package/docs/interfaces/live.LiveReact.html +52 -984
  35. package/docs/modules/RTCProtocol.html +17 -361
  36. package/docs/modules/live.html +103 -1219
  37. package/docs/modules/shared_utils.html +10 -248
  38. package/docs/modules.html +1 -125
  39. package/lib/RTC/BrowserRTC.d.ts +30 -0
  40. package/lib/RTC/BrowserRTC.js +163 -0
  41. package/lib/RTC/BrowserRTC.js.map +1 -0
  42. package/lib/RTC/VRWebViewRTC.d.ts +23 -0
  43. package/lib/RTC/VRWebViewRTC.js +124 -0
  44. package/lib/RTC/VRWebViewRTC.js.map +1 -0
  45. package/lib/RTC/index.d.ts +22 -0
  46. package/lib/{RTCProtocol → RTC}/index.js +3 -7
  47. package/lib/RTC/index.js.map +1 -0
  48. package/lib/createLive.d.ts +1 -1
  49. package/lib/createLive.js +53 -24
  50. package/lib/createLive.js.map +1 -1
  51. package/lib/createLiveReact.d.ts +12 -11
  52. package/lib/createLiveReact.js +9 -15
  53. package/lib/createLiveReact.js.map +1 -1
  54. package/lib/shared-utils/Subscribe.d.ts +1 -1
  55. package/lib/shared-utils/appendUri.js +1 -1
  56. package/lib/shared-utils/appendUri.js.map +1 -1
  57. package/lib/typings/EventType.d.ts +10 -0
  58. package/lib/typings/GetVoiceSign.d.ts +11 -0
  59. package/lib/typings/GetVoiceSign.js +3 -0
  60. package/lib/typings/GetVoiceSign.js.map +1 -0
  61. package/lib/typings/Live.d.ts +6 -4
  62. package/lib/typings/LiveMsg.d.ts +4 -0
  63. package/lib/typings/LiveMsg.js +5 -1
  64. package/lib/typings/LiveMsg.js.map +1 -1
  65. package/lib/typings/LiveOptions.d.ts +3 -7
  66. package/lib/typings/RTCEventType.d.ts +2 -14
  67. package/lib/typings/RTCEventType.js +0 -7
  68. package/lib/typings/RTCEventType.js.map +1 -1
  69. package/lib/typings/RTCJoinedInfo.d.ts +28 -0
  70. package/lib/typings/RTCJoinedInfo.js +23 -0
  71. package/lib/typings/RTCJoinedInfo.js.map +1 -0
  72. package/lib/{RTCProtocol/index.d.ts → typings/RTCProtocol.d.ts} +1 -19
  73. package/lib/typings/RTCProtocol.js +9 -0
  74. package/lib/typings/RTCProtocol.js.map +1 -0
  75. package/lib/typings/VRWebViewRTCOptions.d.ts +6 -0
  76. package/lib/typings/VRWebViewRTCOptions.js +3 -0
  77. package/lib/typings/VRWebViewRTCOptions.js.map +1 -0
  78. package/lib/typings/WebSocket.d.ts +2 -1
  79. package/lib/typings/WebSocket.js +1 -0
  80. package/lib/typings/WebSocket.js.map +1 -1
  81. package/package.json +8 -4
  82. package/umd/{RTCProtocol.046933a5.js → RTCProtocol.543610f0.js} +1 -1
  83. package/umd/createLive.1ecf7dd4.js +1 -0
  84. package/umd/createLiveReact.9075a8fd.js +1 -0
  85. package/docs/assets/css/main.css +0 -2787
  86. package/docs/assets/js/main.js +0 -248
  87. package/docs/assets/js/search.js +0 -1
  88. package/lib/RTCProtocol/index.js.map +0 -1
  89. package/umd/createLive.6845145e.js +0 -1
  90. package/umd/createLiveReact.406cf5a3.js +0 -1
@@ -1,361 +1,17 @@
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>RTCProtocol | 如视 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="RTCProtocol.html">RTCProtocol</a>
57
- </li>
58
- </ul>
59
- <h1>Module RTCProtocol</h1>
60
- </div>
61
- </div>
62
- </header>
63
- <div class="container container-main">
64
- <div class="row">
65
- <div class="col-8 col-content">
66
- <section class="tsd-panel-group tsd-index-group">
67
- <h2>Index</h2>
68
- <section class="tsd-panel tsd-index-panel">
69
- <div class="tsd-index-content">
70
- <section class="tsd-index-section ">
71
- <h3>Enumerations</h3>
72
- <ul class="tsd-index-list">
73
- <li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/RTCProtocol.RTCType.html" class="tsd-kind-icon">RTCType</a></li>
74
- </ul>
75
- </section>
76
- <section class="tsd-index-section ">
77
- <h3>Classes</h3>
78
- <ul class="tsd-index-list">
79
- <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/RTCProtocol.RTCExample.html" class="tsd-kind-icon">RTCExample</a></li>
80
- </ul>
81
- </section>
82
- <section class="tsd-index-section ">
83
- <h3>Interfaces</h3>
84
- <ul class="tsd-index-list">
85
- <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/RTCProtocol.RTCProtocol-1.html" class="tsd-kind-icon">RTCProtocol</a></li>
86
- </ul>
87
- </section>
88
- <section class="tsd-index-section ">
89
- <h3>Type aliases</h3>
90
- <ul class="tsd-index-list">
91
- <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="RTCProtocol.html#RTCActionReactCallback" class="tsd-kind-icon">RTCAction<wbr>React<wbr>Callback</a></li>
92
- <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="RTCProtocol.html#RTCEventType" class="tsd-kind-icon">RTCEvent<wbr>Type</a></li>
93
- </ul>
94
- </section>
95
- </div>
96
- </section>
97
- </section>
98
- <section class="tsd-panel-group tsd-member-group ">
99
- <h2>Type aliases</h2>
100
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
101
- <a name="RTCActionReactCallback" class="tsd-anchor"></a>
102
- <h3>RTCAction<wbr>React<wbr>Callback</h3>
103
- <div class="tsd-signature tsd-kind-icon">RTCAction<wbr>React<wbr>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/RTCProtocol.RTCProtocol-1.html" class="tsd-signature-type" data-tsd-kind="Interface">RTCProtocol</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;join&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;quit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;shock&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;toggleMicro&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;detectMicro&quot;</span><span class="tsd-signature-symbol">&gt;</span></div>
104
- <aside class="tsd-sources">
105
- <ul>
106
- <li>Defined in RTCProtocol/index.ts:69</li>
107
- </ul>
108
- </aside>
109
- </section>
110
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
111
- <a name="RTCEventType" class="tsd-anchor"></a>
112
- <h3>RTCEvent<wbr>Type</h3>
113
- <div class="tsd-signature tsd-kind-icon">RTCEvent<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>initWillStart<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>inited<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>joinWillStart<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>joined<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>userVolumes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>weakNetwork<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div>
114
- <aside class="tsd-sources">
115
- <ul>
116
- <li>Defined in typings/RTCEventType.ts:12</li>
117
- </ul>
118
- </aside>
119
- <div class="tsd-comment tsd-typography">
120
- <div class="lead">
121
- <p>RTC 异步事件类型。</p>
122
- </div>
123
- </div>
124
- <div class="tsd-type-declaration">
125
- <h4>Type declaration</h4>
126
- <ul class="tsd-parameters">
127
- <li class="tsd-parameter">
128
- <h5>error<span class="tsd-signature-symbol">: </span>function</h5>
129
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
130
- <li class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
131
- </ul>
132
- <ul class="tsd-descriptions">
133
- <li class="tsd-description">
134
- <aside class="tsd-sources">
135
- <ul>
136
- <li>Defined in typings/RTCEventType.ts:17</li>
137
- </ul>
138
- </aside>
139
- <div class="tsd-comment tsd-typography">
140
- <div class="lead">
141
- <p>错误\异常</p>
142
- </div>
143
- </div>
144
- <h4 class="tsd-parameters-title">Parameters</h4>
145
- <ul class="tsd-parameters">
146
- <li>
147
- <h5>error: <span class="tsd-signature-type">Error</span></h5>
148
- <div class="tsd-comment tsd-typography">
149
- </div>
150
- </li>
151
- </ul>
152
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
153
- </li>
154
- </ul>
155
- </li>
156
- <li class="tsd-parameter">
157
- <h5>init<wbr>Will<wbr>Start<span class="tsd-signature-symbol">: </span>function</h5>
158
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
159
- <li class="tsd-signature tsd-kind-icon">init<wbr>Will<wbr>Start<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
160
- </ul>
161
- <ul class="tsd-descriptions">
162
- <li class="tsd-description">
163
- <aside class="tsd-sources">
164
- <ul>
165
- <li>Defined in typings/RTCEventType.ts:21</li>
166
- </ul>
167
- </aside>
168
- <div class="tsd-comment tsd-typography">
169
- <div class="lead">
170
- <p>即将执行初始化工作。</p>
171
- </div>
172
- </div>
173
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
174
- </li>
175
- </ul>
176
- </li>
177
- <li class="tsd-parameter">
178
- <h5>inited<span class="tsd-signature-symbol">: </span>function</h5>
179
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
180
- <li class="tsd-signature tsd-kind-icon">inited<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
181
- </ul>
182
- <ul class="tsd-descriptions">
183
- <li class="tsd-description">
184
- <aside class="tsd-sources">
185
- <ul>
186
- <li>Defined in typings/RTCEventType.ts:25</li>
187
- </ul>
188
- </aside>
189
- <div class="tsd-comment tsd-typography">
190
- <div class="lead">
191
- <p>完成初始化</p>
192
- </div>
193
- </div>
194
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
195
- </li>
196
- </ul>
197
- </li>
198
- <li class="tsd-parameter">
199
- <h5>join<wbr>Will<wbr>Start<span class="tsd-signature-symbol">: </span>function</h5>
200
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
201
- <li class="tsd-signature tsd-kind-icon">join<wbr>Will<wbr>Start<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
202
- </ul>
203
- <ul class="tsd-descriptions">
204
- <li class="tsd-description">
205
- <aside class="tsd-sources">
206
- <ul>
207
- <li>Defined in typings/RTCEventType.ts:30</li>
208
- </ul>
209
- </aside>
210
- <div class="tsd-comment tsd-typography">
211
- <div class="lead">
212
- <p>即将加入房间。</p>
213
- </div>
214
- </div>
215
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
216
- </li>
217
- </ul>
218
- </li>
219
- <li class="tsd-parameter">
220
- <h5>joined<span class="tsd-signature-symbol">: </span>function</h5>
221
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
222
- <li class="tsd-signature tsd-kind-icon">joined<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
223
- </ul>
224
- <ul class="tsd-descriptions">
225
- <li class="tsd-description">
226
- <aside class="tsd-sources">
227
- <ul>
228
- <li>Defined in typings/RTCEventType.ts:34</li>
229
- </ul>
230
- </aside>
231
- <div class="tsd-comment tsd-typography">
232
- <div class="lead">
233
- <p>成功加入语音房间。</p>
234
- </div>
235
- </div>
236
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
237
- </li>
238
- </ul>
239
- </li>
240
- <li class="tsd-parameter">
241
- <h5>user<wbr>Volumes<span class="tsd-signature-symbol">: </span>function</h5>
242
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
243
- <li class="tsd-signature tsd-kind-icon">user<wbr>Volumes<span class="tsd-signature-symbol">(</span>userVolumes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">UserVolume</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
244
- </ul>
245
- <ul class="tsd-descriptions">
246
- <li class="tsd-description">
247
- <aside class="tsd-sources">
248
- <ul>
249
- <li>Defined in typings/RTCEventType.ts:43</li>
250
- </ul>
251
- </aside>
252
- <div class="tsd-comment tsd-typography">
253
- <div class="lead">
254
- <p>每个用户的音量。</p>
255
- </div>
256
- </div>
257
- <h4 class="tsd-parameters-title">Parameters</h4>
258
- <ul class="tsd-parameters">
259
- <li>
260
- <h5>userVolumes: <span class="tsd-signature-type">UserVolume</span><span class="tsd-signature-symbol">[]</span></h5>
261
- <div class="tsd-comment tsd-typography">
262
- </div>
263
- </li>
264
- </ul>
265
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
266
- </li>
267
- </ul>
268
- </li>
269
- <li class="tsd-parameter">
270
- <h5>weak<wbr>Network<span class="tsd-signature-symbol">: </span>function</h5>
271
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
272
- <li class="tsd-signature tsd-kind-icon">weak<wbr>Network<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
273
- </ul>
274
- <ul class="tsd-descriptions">
275
- <li class="tsd-description">
276
- <aside class="tsd-sources">
277
- <ul>
278
- <li>Defined in typings/RTCEventType.ts:38</li>
279
- </ul>
280
- </aside>
281
- <div class="tsd-comment tsd-typography">
282
- <div class="lead">
283
- <p>弱网提醒事件。</p>
284
- </div>
285
- </div>
286
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
287
- </li>
288
- </ul>
289
- </li>
290
- </ul>
291
- </div>
292
- </section>
293
- </section>
294
- </div>
295
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
296
- <nav class="tsd-navigation primary">
297
- <ul>
298
- <li class=" ">
299
- <a href="../modules.html">Modules</a>
300
- </li>
301
- <li class="current tsd-kind-module">
302
- <a href="RTCProtocol.html">RTCProtocol</a>
303
- </li>
304
- <li class=" tsd-kind-module">
305
- <a href="live.html">live</a>
306
- </li>
307
- <li class=" tsd-kind-module">
308
- <a href="shared_utils.html">shared-<wbr>utils</a>
309
- </li>
310
- </ul>
311
- </nav>
312
- <nav class="tsd-navigation secondary menu-sticky">
313
- <ul class="before-current">
314
- <li class=" tsd-kind-enum tsd-parent-kind-module">
315
- <a href="../enums/RTCProtocol.RTCType.html" class="tsd-kind-icon">RTCType</a>
316
- </li>
317
- <li class=" tsd-kind-class tsd-parent-kind-module">
318
- <a href="../classes/RTCProtocol.RTCExample.html" class="tsd-kind-icon">RTCExample</a>
319
- </li>
320
- <li class=" tsd-kind-interface tsd-parent-kind-module">
321
- <a href="../interfaces/RTCProtocol.RTCProtocol-1.html" class="tsd-kind-icon">RTCProtocol</a>
322
- </li>
323
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
324
- <a href="RTCProtocol.html#RTCActionReactCallback" class="tsd-kind-icon">RTCAction<wbr>React<wbr>Callback</a>
325
- </li>
326
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
327
- <a href="RTCProtocol.html#RTCEventType" class="tsd-kind-icon">RTCEvent<wbr>Type</a>
328
- </li>
329
- </ul>
330
- </nav>
331
- </div>
332
- </div>
333
- </div>
334
- <footer>
335
- <div class="container">
336
- <h2>Legend</h2>
337
- <div class="tsd-legend-group">
338
- <ul class="tsd-legend">
339
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
340
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
341
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
342
- <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
343
- </ul>
344
- <ul class="tsd-legend">
345
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
346
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
347
- </ul>
348
- <ul class="tsd-legend">
349
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
350
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
351
- </ul>
352
- <ul class="tsd-legend">
353
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
354
- </ul>
355
- </div>
356
- </div>
357
- </footer>
358
- <div class="overlay"></div>
359
- <script src="../assets/js/main.js"></script>
360
- </body>
361
- </html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RTCProtocol | 如视 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="RTCProtocol.html">RTCProtocol</a></li></ul><h1>Module RTCProtocol</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><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>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/RTCProtocol.RTCJoinedInfoCodeEnum.html" class="tsd-kind-icon">RTCJoined<wbr/>Info<wbr/>Code<wbr/>Enum</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/RTCProtocol.RTCType.html" class="tsd-kind-icon">RTCType</a></li></ul></section><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/RTCProtocol.RTCExample.html" class="tsd-kind-icon">RTCExample</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/RTCProtocol.VRWebViewRTC.html" class="tsd-kind-icon">VRWeb<wbr/>ViewRTC</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/RTCProtocol.GetVoiceSignReturnType.html" class="tsd-kind-icon">Get<wbr/>Voice<wbr/>Sign<wbr/>Return<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/RTCProtocol.RTCJoinedInfo.html" class="tsd-kind-icon">RTCJoined<wbr/>Info</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/RTCProtocol.RTCProtocol-1.html" class="tsd-kind-icon">RTCProtocol</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/RTCProtocol.VRWebViewRTCOptions.html" class="tsd-kind-icon">VRWeb<wbr/>ViewRTCOptions</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="RTCProtocol.html#GetVoiceSign" class="tsd-kind-icon">Get<wbr/>Voice<wbr/>Sign</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="RTCProtocol.html#RTCActionReactCallback" class="tsd-kind-icon">RTCAction<wbr/>React<wbr/>Callback</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="RTCProtocol.html#RTCEventType" class="tsd-kind-icon">RTCEvent<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="RTCProtocol.html#UserVolume" class="tsd-kind-icon">User<wbr/>Volume</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="GetVoiceSign" class="tsd-anchor"></a><h3>Get<wbr/>Voice<wbr/>Sign</h3><div class="tsd-signature tsd-kind-icon">Get<wbr/>Voice<wbr/>Sign<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>{ voiceId, userId, roomId }<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>roomId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>userId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>voiceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/RTCProtocol.GetVoiceSignReturnType.html" class="tsd-signature-type" data-tsd-kind="Interface">GetVoiceSignReturnType</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/GetVoiceSign.ts:8</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>{ voiceId, userId, roomId }<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>roomId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>userId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>voiceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/RTCProtocol.GetVoiceSignReturnType.html" class="tsd-signature-type" data-tsd-kind="Interface">GetVoiceSignReturnType</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>{ voiceId, userId, roomId }: <span class="tsd-signature-symbol">{ </span>roomId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>userId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>voiceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>room<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>user<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>voice<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/RTCProtocol.GetVoiceSignReturnType.html" class="tsd-signature-type" data-tsd-kind="Interface">GetVoiceSignReturnType</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="RTCActionReactCallback" class="tsd-anchor"></a><h3>RTCAction<wbr/>React<wbr/>Callback</h3><div class="tsd-signature tsd-kind-icon">RTCAction<wbr/>React<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/RTCProtocol.RTCProtocol-1.html" class="tsd-signature-type" data-tsd-kind="Interface">RTCProtocol</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;join&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;quit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;shock&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;toggleMicro&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;detectMicro&quot;</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:43</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="RTCEventType" class="tsd-anchor"></a><h3>RTCEvent<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">RTCEvent<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>joinWillStart<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>joined<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>userVolumes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>weakNetwork<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCEventType.ts:14</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>RTC 异步事件类型。</p>
3
+ </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>error<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RTCProtocol.RTCJoinedInfo.html" class="tsd-signature-type" data-tsd-kind="Interface">RTCJoinedInfo</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/RTCEventType.ts:19</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>错误\异常</p>
5
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>error: <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/RTCProtocol.RTCJoinedInfo.html" class="tsd-signature-type" data-tsd-kind="Interface">RTCJoinedInfo</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
6
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>join<wbr/>Will<wbr/>Start<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">join<wbr/>Will<wbr/>Start<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/RTCEventType.ts:24</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
7
+ <p>即将加入房间。</p>
8
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>joined<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">joined<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/RTCEventType.ts:28</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
9
+ <p>成功加入语音房间。</p>
10
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>user<wbr/>Volumes<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">user<wbr/>Volumes<span class="tsd-signature-symbol">(</span>userVolumes<span class="tsd-signature-symbol">: </span><a href="RTCProtocol.html#UserVolume" class="tsd-signature-type" data-tsd-kind="Type alias">UserVolume</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/RTCEventType.ts:39</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
11
+ <p>每个用户的音量。</p>
12
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>userVolumes: <a href="RTCProtocol.html#UserVolume" class="tsd-signature-type" data-tsd-kind="Type alias">UserVolume</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
13
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>weak<wbr/>Network<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">weak<wbr/>Network<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/RTCEventType.ts:33</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>弱网提醒事件。</p>
15
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="UserVolume" class="tsd-anchor"></a><h3>User<wbr/>Volume</h3><div class="tsd-signature tsd-kind-icon">User<wbr/>Volume<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>audioVolume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>userId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCEventType.ts:6</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
16
+ <p>用户的音量信息。</p>
17
+ </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>audio<wbr/>Volume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>user<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></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="current tsd-kind-module"><a href="RTCProtocol.html">RTCProtocol</a></li><li class=" tsd-kind-module"><a href="live.html">live</a></li><li class=" tsd-kind-module"><a href="shared_utils.html">shared-<wbr/>utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/RTCProtocol.RTCJoinedInfoCodeEnum.html" class="tsd-kind-icon">RTCJoined<wbr/>Info<wbr/>Code<wbr/>Enum</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/RTCProtocol.RTCType.html" class="tsd-kind-icon">RTCType</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/RTCProtocol.RTCExample.html" class="tsd-kind-icon">RTCExample</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/RTCProtocol.VRWebViewRTC.html" class="tsd-kind-icon">VRWeb<wbr/>ViewRTC</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/RTCProtocol.GetVoiceSignReturnType.html" class="tsd-kind-icon">Get<wbr/>Voice<wbr/>Sign<wbr/>Return<wbr/>Type</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/RTCProtocol.RTCJoinedInfo.html" class="tsd-kind-icon">RTCJoined<wbr/>Info</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/RTCProtocol.RTCProtocol-1.html" class="tsd-kind-icon">RTCProtocol</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/RTCProtocol.VRWebViewRTCOptions.html" class="tsd-kind-icon">VRWeb<wbr/>ViewRTCOptions</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="RTCProtocol.html#GetVoiceSign" class="tsd-kind-icon">Get<wbr/>Voice<wbr/>Sign</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="RTCProtocol.html#RTCActionReactCallback" class="tsd-kind-icon">RTCAction<wbr/>React<wbr/>Callback</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="RTCProtocol.html#RTCEventType" class="tsd-kind-icon">RTCEvent<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="RTCProtocol.html#UserVolume" class="tsd-kind-icon">User<wbr/>Volume</a></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>