@realsee/live 0.1.1 → 0.2.0

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 (88) 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 +50 -22
  50. package/lib/createLive.js.map +1 -1
  51. package/lib/createLiveReact.d.ts +11 -10
  52. package/lib/createLiveReact.js +4 -6
  53. package/lib/createLiveReact.js.map +1 -1
  54. package/lib/shared-utils/Subscribe.d.ts +1 -1
  55. package/lib/typings/EventType.d.ts +10 -0
  56. package/lib/typings/GetVoiceSign.d.ts +11 -0
  57. package/lib/typings/GetVoiceSign.js +3 -0
  58. package/lib/typings/GetVoiceSign.js.map +1 -0
  59. package/lib/typings/Live.d.ts +6 -4
  60. package/lib/typings/LiveMsg.d.ts +4 -0
  61. package/lib/typings/LiveMsg.js +4 -0
  62. package/lib/typings/LiveMsg.js.map +1 -1
  63. package/lib/typings/LiveOptions.d.ts +3 -7
  64. package/lib/typings/RTCEventType.d.ts +2 -14
  65. package/lib/typings/RTCEventType.js +0 -7
  66. package/lib/typings/RTCEventType.js.map +1 -1
  67. package/lib/typings/RTCJoinedInfo.d.ts +28 -0
  68. package/lib/typings/RTCJoinedInfo.js +23 -0
  69. package/lib/typings/RTCJoinedInfo.js.map +1 -0
  70. package/lib/{RTCProtocol/index.d.ts → typings/RTCProtocol.d.ts} +1 -19
  71. package/lib/typings/RTCProtocol.js +9 -0
  72. package/lib/typings/RTCProtocol.js.map +1 -0
  73. package/lib/typings/VRWebViewRTCOptions.d.ts +6 -0
  74. package/lib/typings/VRWebViewRTCOptions.js +3 -0
  75. package/lib/typings/VRWebViewRTCOptions.js.map +1 -0
  76. package/lib/typings/WebSocket.d.ts +2 -1
  77. package/lib/typings/WebSocket.js +1 -0
  78. package/lib/typings/WebSocket.js.map +1 -1
  79. package/package.json +8 -4
  80. package/umd/{RTCProtocol.046933a5.js → RTCProtocol.543610f0.js} +1 -1
  81. package/umd/createLive.a6edf473.js +1 -0
  82. package/umd/createLiveReact.e21b4514.js +1 -0
  83. package/docs/assets/css/main.css +0 -2787
  84. package/docs/assets/js/main.js +0 -248
  85. package/docs/assets/js/search.js +0 -1
  86. package/lib/RTCProtocol/index.js.map +0 -1
  87. package/umd/createLive.6845145e.js +0 -1
  88. package/umd/createLiveReact.406cf5a3.js +0 -1
package/docs/interfaces/live.LiveOptions.html CHANGED
@@ -1,499 +1,22 @@
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>LiveOptions | 如视 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.LiveOptions.html">LiveOptions</a>
60
- </li>
61
- </ul>
62
- <h1>Interface LiveOptions&lt;TicketArgs&gt;</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>依赖配置。</p>
73
- </div>
74
- </div>
75
- </section>
76
- <section class="tsd-panel tsd-type-parameters">
77
- <h3>Type parameters</h3>
78
- <ul class="tsd-type-parameters">
79
- <li>
80
- <h4>TicketArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
81
- </li>
82
- </ul>
83
- </section>
84
- <section class="tsd-panel tsd-hierarchy">
85
- <h3>Hierarchy</h3>
86
- <ul class="tsd-hierarchy">
87
- <li>
88
- <span class="target">LiveOptions</span>
89
- </li>
90
- </ul>
91
- </section>
92
- <section class="tsd-panel-group tsd-index-group">
93
- <h2>Index</h2>
94
- <section class="tsd-panel tsd-index-panel">
95
- <div class="tsd-index-content">
96
- <section class="tsd-index-section ">
97
- <h3>Properties</h3>
98
- <ul class="tsd-index-list">
99
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#__debug__" class="tsd-kind-icon">__debug__</a></li>
100
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#autoReconnect" class="tsd-kind-icon">auto<wbr>Reconnect</a></li>
101
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#healthCheck" class="tsd-kind-icon">health<wbr>Check</a></li>
102
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#rtc" class="tsd-kind-icon">rtc</a></li>
103
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#ticketArgs" class="tsd-kind-icon">ticket<wbr>Args</a></li>
104
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#url" class="tsd-kind-icon">url</a></li>
105
- </ul>
106
- </section>
107
- <section class="tsd-index-section ">
108
- <h3>Methods</h3>
109
- <ul class="tsd-index-list">
110
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="live.LiveOptions.html#canForbidUserKick" class="tsd-kind-icon">can<wbr>Forbid<wbr>User<wbr>Kick</a></li>
111
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="live.LiveOptions.html#canForbidUserMicro" class="tsd-kind-icon">can<wbr>Forbid<wbr>User<wbr>Micro</a></li>
112
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="live.LiveOptions.html#canForbidUserSync" class="tsd-kind-icon">can<wbr>Forbid<wbr>User<wbr>Sync</a></li>
113
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="live.LiveOptions.html#getTicket" class="tsd-kind-icon">get<wbr>Ticket</a></li>
114
- </ul>
115
- </section>
116
- </div>
117
- </section>
118
- </section>
119
- <section class="tsd-panel-group tsd-member-group ">
120
- <h2>Properties</h2>
121
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
122
- <a name="__debug__" class="tsd-anchor"></a>
123
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> __debug__</h3>
124
- <div class="tsd-signature tsd-kind-icon">__debug__<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
125
- <aside class="tsd-sources">
126
- <ul>
127
- <li>Defined in typings/LiveOptions.ts:51</li>
128
- </ul>
129
- </aside>
130
- <div class="tsd-comment tsd-typography">
131
- <div class="lead">
132
- <p>是否开启调试模式：此模式下会在终端打印日志方便调试。</p>
133
- </div>
134
- </div>
135
- </section>
136
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
137
- <a name="autoReconnect" class="tsd-anchor"></a>
138
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> auto<wbr>Reconnect</h3>
139
- <div class="tsd-signature tsd-kind-icon">auto<wbr>Reconnect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div>
140
- <aside class="tsd-sources">
141
- <ul>
142
- <li>Defined in typings/LiveOptions.ts:31</li>
143
- </ul>
144
- </aside>
145
- <div class="tsd-comment tsd-typography">
146
- <div class="lead">
147
- <p>异常断开是否自动重连：默认 <code>true</code> 重连三次.
148
- 可以设置 <code>false</code> 关闭自动重连，以监控 <code>ws.readyStateUpdate</code> 事件自己来实现重连逻辑。</p>
149
- </div>
150
- </div>
151
- </section>
152
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
153
- <a name="healthCheck" class="tsd-anchor"></a>
154
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> health<wbr>Check</h3>
155
- <div class="tsd-signature tsd-kind-icon">health<wbr>Check<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div>
156
- <aside class="tsd-sources">
157
- <ul>
158
- <li>Defined in typings/LiveOptions.ts:35</li>
159
- </ul>
160
- </aside>
161
- <div class="tsd-comment tsd-typography">
162
- <div class="lead">
163
- <p>是否开启定时健康检查</p>
164
- </div>
165
- </div>
166
- </section>
167
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
168
- <a name="rtc" class="tsd-anchor"></a>
169
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> rtc</h3>
170
- <div class="tsd-signature tsd-kind-icon">rtc<span class="tsd-signature-symbol">:</span> <a href="RTCProtocol.RTCProtocol-1.html" class="tsd-signature-type" data-tsd-kind="Interface">RTCProtocol</a></div>
171
- <aside class="tsd-sources">
172
- <ul>
173
- <li>Defined in typings/LiveOptions.ts:14</li>
174
- </ul>
175
- </aside>
176
- <div class="tsd-comment tsd-typography">
177
- <div class="lead">
178
- <p>RTC实例。</p>
179
- </div>
180
- </div>
181
- </section>
182
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
183
- <a name="ticketArgs" class="tsd-anchor"></a>
184
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> ticket<wbr>Args</h3>
185
- <div class="tsd-signature tsd-kind-icon">ticket<wbr>Args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TicketArgs</span></div>
186
- <aside class="tsd-sources">
187
- <ul>
188
- <li>Defined in typings/LiveOptions.ts:22</li>
189
- </ul>
190
- </aside>
191
- <div class="tsd-comment tsd-typography">
192
- <div class="lead">
193
- <p>getTicket 依赖的参数</p>
194
- </div>
195
- </div>
196
- </section>
197
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
198
- <a name="url" class="tsd-anchor"></a>
199
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3>
200
- <div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
201
- <aside class="tsd-sources">
202
- <ul>
203
- <li>Defined in typings/LiveOptions.ts:10</li>
204
- </ul>
205
- </aside>
206
- <div class="tsd-comment tsd-typography">
207
- <div class="lead">
208
- <p>创建<code>WebSocket</code>所依赖的URL。</p>
209
- </div>
210
- </div>
211
- </section>
212
- </section>
213
- <section class="tsd-panel-group tsd-member-group ">
214
- <h2>Methods</h2>
215
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
216
- <a name="canForbidUserKick" class="tsd-anchor"></a>
217
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr>Forbid<wbr>User<wbr>Kick</h3>
218
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
219
- <li class="tsd-signature tsd-kind-icon">can<wbr>Forbid<wbr>User<wbr>Kick<span class="tsd-signature-symbol">(</span>users<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">boolean</span></li>
220
- </ul>
221
- <ul class="tsd-descriptions">
222
- <li class="tsd-description">
223
- <aside class="tsd-sources">
224
- <ul>
225
- <li>Defined in typings/LiveOptions.ts:47</li>
226
- </ul>
227
- </aside>
228
- <div class="tsd-comment tsd-typography">
229
- <div class="lead">
230
- <p>能否强制&quot;踢掉&quot;某个/些用户。</p>
231
- </div>
232
- </div>
233
- <h4 class="tsd-parameters-title">Parameters</h4>
234
- <ul class="tsd-parameters">
235
- <li>
236
- <h5>users: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
237
- </li>
238
- </ul>
239
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
240
- </li>
241
- </ul>
242
- </section>
243
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
244
- <a name="canForbidUserMicro" class="tsd-anchor"></a>
245
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr>Forbid<wbr>User<wbr>Micro</h3>
246
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
247
- <li class="tsd-signature tsd-kind-icon">can<wbr>Forbid<wbr>User<wbr>Micro<span class="tsd-signature-symbol">(</span>users<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">boolean</span></li>
248
- </ul>
249
- <ul class="tsd-descriptions">
250
- <li class="tsd-description">
251
- <aside class="tsd-sources">
252
- <ul>
253
- <li>Defined in typings/LiveOptions.ts:39</li>
254
- </ul>
255
- </aside>
256
- <div class="tsd-comment tsd-typography">
257
- <div class="lead">
258
- <p>能否禁用某个/些用户的麦克风</p>
259
- </div>
260
- </div>
261
- <h4 class="tsd-parameters-title">Parameters</h4>
262
- <ul class="tsd-parameters">
263
- <li>
264
- <h5>users: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
265
- </li>
266
- </ul>
267
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
268
- </li>
269
- </ul>
270
- </section>
271
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
272
- <a name="canForbidUserSync" class="tsd-anchor"></a>
273
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr>Forbid<wbr>User<wbr>Sync</h3>
274
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
275
- <li class="tsd-signature tsd-kind-icon">can<wbr>Forbid<wbr>User<wbr>Sync<span class="tsd-signature-symbol">(</span>users<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">boolean</span></li>
276
- </ul>
277
- <ul class="tsd-descriptions">
278
- <li class="tsd-description">
279
- <aside class="tsd-sources">
280
- <ul>
281
- <li>Defined in typings/LiveOptions.ts:43</li>
282
- </ul>
283
- </aside>
284
- <div class="tsd-comment tsd-typography">
285
- <div class="lead">
286
- <p>能否限制某个/些用户的帧数据同步</p>
287
- </div>
288
- </div>
289
- <h4 class="tsd-parameters-title">Parameters</h4>
290
- <ul class="tsd-parameters">
291
- <li>
292
- <h5>users: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
293
- </li>
294
- </ul>
295
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
296
- </li>
297
- </ul>
298
- </section>
299
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
300
- <a name="getTicket" class="tsd-anchor"></a>
301
- <h3>get<wbr>Ticket</h3>
302
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
303
- <li class="tsd-signature tsd-kind-icon">get<wbr>Ticket<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TicketArgs</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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
304
- </ul>
305
- <ul class="tsd-descriptions">
306
- <li class="tsd-description">
307
- <aside class="tsd-sources">
308
- <ul>
309
- <li>Defined in typings/LiveOptions.ts:18</li>
310
- </ul>
311
- </aside>
312
- <div class="tsd-comment tsd-typography">
313
- <div class="lead">
314
- <p>获取建立 WebSocket 连接的依赖Tick</p>
315
- </div>
316
- </div>
317
- <h4 class="tsd-parameters-title">Parameters</h4>
318
- <ul class="tsd-parameters">
319
- <li>
320
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> params: <span class="tsd-signature-type">TicketArgs</span></h5>
321
- </li>
322
- </ul>
323
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
324
- </li>
325
- </ul>
326
- </section>
327
- </section>
328
- </div>
329
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
330
- <nav class="tsd-navigation primary">
331
- <ul>
332
- <li class=" ">
333
- <a href="../modules.html">Modules</a>
334
- </li>
335
- <li class=" tsd-kind-module">
336
- <a href="../modules/RTCProtocol.html">RTCProtocol</a>
337
- </li>
338
- <li class="current tsd-kind-module">
339
- <a href="../modules/live.html">live</a>
340
- </li>
341
- <li class=" tsd-kind-module">
342
- <a href="../modules/shared_utils.html">shared-<wbr>utils</a>
343
- </li>
344
- </ul>
345
- </nav>
346
- <nav class="tsd-navigation secondary menu-sticky">
347
- <ul class="before-current">
348
- <li class=" tsd-kind-enum tsd-parent-kind-module">
349
- <a href="../enums/live.BuiltinActionType.html" class="tsd-kind-icon">Builtin<wbr>Action<wbr>Type</a>
350
- </li>
351
- <li class=" tsd-kind-enum tsd-parent-kind-module">
352
- <a href="../enums/live.BuiltinEventType.html" class="tsd-kind-icon">Builtin<wbr>Event<wbr>Type</a>
353
- </li>
354
- <li class=" tsd-kind-enum tsd-parent-kind-module">
355
- <a href="../enums/live.Command.html" class="tsd-kind-icon">Command</a>
356
- </li>
357
- <li class=" tsd-kind-enum tsd-parent-kind-module">
358
- <a href="../enums/live.MemUserStatus.html" class="tsd-kind-icon">Mem<wbr>User<wbr>Status</a>
359
- </li>
360
- <li class=" tsd-kind-enum tsd-parent-kind-module">
361
- <a href="../enums/live.MicroStatus.html" class="tsd-kind-icon">Micro<wbr>Status</a>
362
- </li>
363
- <li class=" tsd-kind-enum tsd-parent-kind-module">
364
- <a href="../enums/live.UserStatus.html" class="tsd-kind-icon">User<wbr>Status</a>
365
- </li>
366
- <li class=" tsd-kind-enum tsd-parent-kind-module">
367
- <a href="../enums/live.WebSocketCloseError.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Close<wbr>Error</a>
368
- </li>
369
- <li class=" tsd-kind-enum tsd-parent-kind-module">
370
- <a href="../enums/live.WebSocketErrorType.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Error<wbr>Type</a>
371
- </li>
372
- <li class=" tsd-kind-enum tsd-parent-kind-module">
373
- <a href="../enums/live.WebSocketState.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>State</a>
374
- </li>
375
- <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
376
- <a href="live.Live.html" class="tsd-kind-icon">Live</a>
377
- </li>
378
- </ul>
379
- <ul class="current">
380
- <li class="current tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
381
- <a href="live.LiveOptions.html" class="tsd-kind-icon">Live<wbr>Options</a>
382
- <ul>
383
- <li class=" tsd-kind-property tsd-parent-kind-interface">
384
- <a href="live.LiveOptions.html#__debug__" class="tsd-kind-icon">__debug__</a>
385
- </li>
386
- <li class=" tsd-kind-property tsd-parent-kind-interface">
387
- <a href="live.LiveOptions.html#autoReconnect" class="tsd-kind-icon">auto<wbr>Reconnect</a>
388
- </li>
389
- <li class=" tsd-kind-property tsd-parent-kind-interface">
390
- <a href="live.LiveOptions.html#healthCheck" class="tsd-kind-icon">health<wbr>Check</a>
391
- </li>
392
- <li class=" tsd-kind-property tsd-parent-kind-interface">
393
- <a href="live.LiveOptions.html#rtc" class="tsd-kind-icon">rtc</a>
394
- </li>
395
- <li class=" tsd-kind-property tsd-parent-kind-interface">
396
- <a href="live.LiveOptions.html#ticketArgs" class="tsd-kind-icon">ticket<wbr>Args</a>
397
- </li>
398
- <li class=" tsd-kind-property tsd-parent-kind-interface">
399
- <a href="live.LiveOptions.html#url" class="tsd-kind-icon">url</a>
400
- </li>
401
- <li class=" tsd-kind-method tsd-parent-kind-interface">
402
- <a href="live.LiveOptions.html#canForbidUserKick" class="tsd-kind-icon">can<wbr>Forbid<wbr>User<wbr>Kick</a>
403
- </li>
404
- <li class=" tsd-kind-method tsd-parent-kind-interface">
405
- <a href="live.LiveOptions.html#canForbidUserMicro" class="tsd-kind-icon">can<wbr>Forbid<wbr>User<wbr>Micro</a>
406
- </li>
407
- <li class=" tsd-kind-method tsd-parent-kind-interface">
408
- <a href="live.LiveOptions.html#canForbidUserSync" class="tsd-kind-icon">can<wbr>Forbid<wbr>User<wbr>Sync</a>
409
- </li>
410
- <li class=" tsd-kind-method tsd-parent-kind-interface">
411
- <a href="live.LiveOptions.html#getTicket" class="tsd-kind-icon">get<wbr>Ticket</a>
412
- </li>
413
- </ul>
414
- </li>
415
- </ul>
416
- <ul class="after-current">
417
- <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
418
- <a href="live.LiveReact.html" class="tsd-kind-icon">Live<wbr>React</a>
419
- </li>
420
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
421
- <a href="../modules/live.html#BuiltinMsg" class="tsd-kind-icon">Builtin<wbr>Msg</a>
422
- </li>
423
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
424
- <a href="../modules/live.html#EventType" class="tsd-kind-icon">Event<wbr>Type</a>
425
- </li>
426
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
427
- <a href="../modules/live.html#LiveActionReactCallback" class="tsd-kind-icon">Live<wbr>Action<wbr>React<wbr>Callback</a>
428
- </li>
429
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
430
- <a href="../modules/live.html#LiveEventType" class="tsd-kind-icon">Live<wbr>Event<wbr>Type</a>
431
- </li>
432
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
433
- <a href="../modules/live.html#LiveMsg" class="tsd-kind-icon">Live<wbr>Msg</a>
434
- </li>
435
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
436
- <a href="../modules/live.html#LiveProviderPropTypes" class="tsd-kind-icon">Live<wbr>Provider<wbr>Prop<wbr>Types</a>
437
- </li>
438
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
439
- <a href="../modules/live.html#ReqLiveMsg" class="tsd-kind-icon">Req<wbr>Live<wbr>Msg</a>
440
- </li>
441
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
442
- <a href="../modules/live.html#RoomInfo" class="tsd-kind-icon">Room<wbr>Info</a>
443
- </li>
444
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
445
- <a href="../modules/live.html#UserInfo" class="tsd-kind-icon">User<wbr>Info</a>
446
- </li>
447
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
448
- <a href="../modules/live.html#UserInfoExt" class="tsd-kind-icon">User<wbr>Info<wbr>Ext</a>
449
- </li>
450
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
451
- <a href="../modules/live.html#WebSocketError" class="tsd-kind-icon">Web<wbr>Socket<wbr>Error</a>
452
- </li>
453
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
454
- <a href="../modules/live.html#WebSocketEventType" class="tsd-kind-icon">Web<wbr>Socket<wbr>Event<wbr>Type</a>
455
- </li>
456
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
457
- <a href="../modules/live.html#createLive" class="tsd-kind-icon">create<wbr>Live</a>
458
- </li>
459
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
460
- <a href="../modules/live.html#createLiveReact" class="tsd-kind-icon">create<wbr>Live<wbr>React</a>
461
- </li>
462
- <li class=" tsd-kind-function tsd-parent-kind-module">
463
- <a href="../modules/live.html#parseLiveMsg" class="tsd-kind-icon">parse<wbr>Live<wbr>Msg</a>
464
- </li>
465
- </ul>
466
- </nav>
467
- </div>
468
- </div>
469
- </div>
470
- <footer>
471
- <div class="container">
472
- <h2>Legend</h2>
473
- <div class="tsd-legend-group">
474
- <ul class="tsd-legend">
475
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
476
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
477
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
478
- <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
479
- </ul>
480
- <ul class="tsd-legend">
481
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
482
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
483
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
484
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
485
- </ul>
486
- <ul class="tsd-legend">
487
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
488
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
489
- </ul>
490
- <ul class="tsd-legend">
491
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
492
- </ul>
493
- </div>
494
- </div>
495
- </footer>
496
- <div class="overlay"></div>
497
- <script src="../assets/js/main.js"></script>
498
- </body>
499
- </html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LiveOptions | 如视 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.LiveOptions.html">LiveOptions</a></li></ul><h1>Interface LiveOptions</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>依赖配置。</p>
3
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">LiveOptions</span></li></ul></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#__debug__" class="tsd-kind-icon">__debug__</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#autoReconnect" class="tsd-kind-icon">auto<wbr/>Reconnect</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#healthCheck" class="tsd-kind-icon">health<wbr/>Check</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#rtc" class="tsd-kind-icon">rtc</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#url" class="tsd-kind-icon">url</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="live.LiveOptions.html#canForbidUserKick" class="tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Kick</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="live.LiveOptions.html#canForbidUserMicro" class="tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Micro</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="live.LiveOptions.html#canForbidUserSync" class="tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Sync</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="live.LiveOptions.html#getTicket" class="tsd-kind-icon">get<wbr/>Ticket</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="__debug__" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> __debug__</h3><div class="tsd-signature tsd-kind-icon">__debug__<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveOptions.ts:48</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-property tsd-parent-kind-interface"><a id="autoReconnect" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> auto<wbr/>Reconnect</h3><div class="tsd-signature tsd-kind-icon">auto<wbr/>Reconnect<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveOptions.ts:28</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>异常断开是否自动重连：默认 <code>true</code> 重连三次.
7
+ 可以设置 <code>false</code> 关闭自动重连，以监控 <code>ws.readyStateUpdate</code> 事件自己来实现重连逻辑。</p>
8
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="healthCheck" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> health<wbr/>Check</h3><div class="tsd-signature tsd-kind-icon">health<wbr/>Check<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveOptions.ts:32</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
9
+ <p>是否开启定时健康检查</p>
10
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="rtc" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> rtc</h3><div class="tsd-signature tsd-kind-icon">rtc<span class="tsd-signature-symbol">?:</span> <a href="RTCProtocol.RTCProtocol-1.html" class="tsd-signature-type" data-tsd-kind="Interface">RTCProtocol</a></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveOptions.ts:14</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
11
+ <p>RTC实例。</p>
12
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveOptions.ts:10</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
13
+ <p>创建<code>WebSocket</code>所依赖的URL。</p>
14
+ </div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="canForbidUserKick" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr/>Forbid<wbr/>User<wbr/>Kick</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Kick<span class="tsd-signature-symbol">(</span>users<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/LiveOptions.ts:44</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
15
+ <p>能否强制&quot;踢掉&quot;某个/些用户。</p>
16
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>users: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="canForbidUserMicro" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr/>Forbid<wbr/>User<wbr/>Micro</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Micro<span class="tsd-signature-symbol">(</span>users<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/LiveOptions.ts:36</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
17
+ <p>能否禁用某个/些用户的麦克风</p>
18
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>users: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="canForbidUserSync" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr/>Forbid<wbr/>User<wbr/>Sync</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Sync<span class="tsd-signature-symbol">(</span>users<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/LiveOptions.ts:40</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
19
+ <p>能否限制某个/些用户的帧数据同步</p>
20
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>users: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getTicket" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> get<wbr/>Ticket</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Ticket<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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/LiveOptions.ts:18</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
21
+ <p>获取建立 WebSocket 连接的依赖Tick</p>
22
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></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-interface tsd-parent-kind-module"><a href="live.LiveOptions.html" class="tsd-kind-icon">Live<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#__debug__" class="tsd-kind-icon">__debug__</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#autoReconnect" class="tsd-kind-icon">auto<wbr/>Reconnect</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#healthCheck" class="tsd-kind-icon">health<wbr/>Check</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#rtc" class="tsd-kind-icon">rtc</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="live.LiveOptions.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="live.LiveOptions.html#canForbidUserKick" class="tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Kick</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="live.LiveOptions.html#canForbidUserMicro" class="tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Micro</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="live.LiveOptions.html#canForbidUserSync" class="tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Sync</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="live.LiveOptions.html#getTicket" class="tsd-kind-icon">get<wbr/>Ticket</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><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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>