@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/interfaces/RTCProtocol.RTCProtocol-1.html CHANGED
@@ -1,765 +1,60 @@
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="../modules/RTCProtocol.html">RTCProtocol</a>
57
- </li>
58
- <li>
59
- <a href="RTCProtocol.RTCProtocol-1.html">RTCProtocol</a>
60
- </li>
61
- </ul>
62
- <h1>Interface RTCProtocol</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-hierarchy">
70
- <h3>Hierarchy</h3>
71
- <ul class="tsd-hierarchy">
72
- <li>
73
- <a href="../classes/shared_utils.Subscribe.html" class="tsd-signature-type" data-tsd-kind="Class">Subscribe</a><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">&gt;</span>
74
- <ul class="tsd-hierarchy">
75
- <li>
76
- <span class="target">RTCProtocol</span>
77
- </li>
78
- </ul>
79
- </li>
80
- </ul>
81
- </section>
82
- <section class="tsd-panel">
83
- <h3>Implemented by</h3>
84
- <ul class="tsd-hierarchy">
85
- <li><a href="../classes/RTCProtocol.RTCExample.html" class="tsd-signature-type" data-tsd-kind="Class">RTCExample</a></li>
86
- </ul>
87
- </section>
88
- <section class="tsd-panel-group tsd-index-group">
89
- <h2>Index</h2>
90
- <section class="tsd-panel tsd-index-panel">
91
- <div class="tsd-index-content">
92
- <section class="tsd-index-section ">
93
- <h3>Properties</h3>
94
- <ul class="tsd-index-list">
95
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#joined" class="tsd-kind-icon">joined</a></li>
96
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#micro" class="tsd-kind-icon">micro</a></li>
97
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#type" class="tsd-kind-icon">type</a></li>
98
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#voiceId" class="tsd-kind-icon">voice<wbr>Id</a></li>
99
- </ul>
100
- </section>
101
- <section class="tsd-index-section ">
102
- <h3>Methods</h3>
103
- <ul class="tsd-index-list">
104
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#detectMicro" class="tsd-kind-icon">detect<wbr>Micro</a></li>
105
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#emit" class="tsd-kind-icon">emit</a></li>
106
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#hasListener" class="tsd-kind-icon">has<wbr>Listener</a></li>
107
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#join" class="tsd-kind-icon">join</a></li>
108
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#off" class="tsd-kind-icon">off</a></li>
109
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#on" class="tsd-kind-icon">on</a></li>
110
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#once" class="tsd-kind-icon">once</a></li>
111
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#quit" class="tsd-kind-icon">quit</a></li>
112
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#shock" class="tsd-kind-icon">shock</a></li>
113
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#toggleMicro" class="tsd-kind-icon">toggle<wbr>Micro</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="joined" class="tsd-anchor"></a>
123
- <h3>joined</h3>
124
- <div class="tsd-signature tsd-kind-icon">joined<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 RTCProtocol/index.ts:9</li>
128
- </ul>
129
- </aside>
130
- </section>
131
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
132
- <a name="micro" class="tsd-anchor"></a>
133
- <h3>micro</h3>
134
- <div class="tsd-signature tsd-kind-icon">micro<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
135
- <aside class="tsd-sources">
136
- <ul>
137
- <li>Defined in RTCProtocol/index.ts:10</li>
138
- </ul>
139
- </aside>
140
- </section>
141
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
142
- <a name="type" class="tsd-anchor"></a>
143
- <h3>type</h3>
144
- <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/RTCProtocol.RTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCType</a></div>
145
- <aside class="tsd-sources">
146
- <ul>
147
- <li>Defined in RTCProtocol/index.ts:12</li>
148
- </ul>
149
- </aside>
150
- </section>
151
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
152
- <a name="voiceId" class="tsd-anchor"></a>
153
- <h3>voice<wbr>Id</h3>
154
- <div class="tsd-signature tsd-kind-icon">voice<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
155
- <aside class="tsd-sources">
156
- <ul>
157
- <li>Defined in RTCProtocol/index.ts:11</li>
158
- </ul>
159
- </aside>
160
- </section>
161
- </section>
162
- <section class="tsd-panel-group tsd-member-group ">
163
- <h2>Methods</h2>
164
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
165
- <a name="detectMicro" class="tsd-anchor"></a>
166
- <h3>detect<wbr>Micro</h3>
167
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
168
- <li class="tsd-signature tsd-kind-icon">detect<wbr>Micro<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">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
169
- </ul>
170
- <ul class="tsd-descriptions">
171
- <li class="tsd-description">
172
- <aside class="tsd-sources">
173
- <ul>
174
- <li>Defined in RTCProtocol/index.ts:29</li>
175
- </ul>
176
- </aside>
177
- <div class="tsd-comment tsd-typography">
178
- <div class="lead">
179
- <p>监测麦克风授权。</p>
180
- </div>
181
- </div>
182
- <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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
183
- </li>
184
- </ul>
185
- </section>
186
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited">
187
- <a name="emit" class="tsd-anchor"></a>
188
- <h3>emit</h3>
189
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited">
190
- <li class="tsd-signature tsd-kind-icon">emit&lt;K&gt;<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">K</span>, <span class="tsd-signature-symbol">...</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
191
- </ul>
192
- <ul class="tsd-descriptions">
193
- <li class="tsd-description">
194
- <aside class="tsd-sources">
195
- <p>Inherited from <a href="../classes/shared_utils.Subscribe.html">Subscribe</a>.<a href="../classes/shared_utils.Subscribe.html#emit">emit</a></p>
196
- <ul>
197
- <li>Defined in shared-utils/Subscribe.ts:127</li>
198
- </ul>
199
- </aside>
200
- <div class="tsd-comment tsd-typography">
201
- <div class="lead">
202
- <p>触发事件</p>
203
- </div>
204
- </div>
205
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
206
- <ul class="tsd-type-parameters">
207
- <li>
208
- <h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a></h4>
209
- <div class="tsd-comment tsd-typography">
210
- <p>预设的监听事件名称</p>
211
- </div>
212
- </li>
213
- </ul>
214
- <h4 class="tsd-parameters-title">Parameters</h4>
215
- <ul class="tsd-parameters">
216
- <li>
217
- <h5>name: <span class="tsd-signature-type">K</span></h5>
218
- <div class="tsd-comment tsd-typography">
219
- <p>事件类型</p>
220
- </div>
221
- </li>
222
- <li>
223
- <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>data: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5>
224
- <div class="tsd-comment tsd-typography">
225
- <p>触发事件的数据</p>
226
- </div>
227
- </li>
228
- </ul>
229
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
230
- <p>canceled 是否被触发取消</p>
231
- </li>
232
- </ul>
233
- </section>
234
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
235
- <a name="hasListener" class="tsd-anchor"></a>
236
- <h3>has<wbr>Listener</h3>
237
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
238
- <li class="tsd-signature tsd-kind-icon">has<wbr>Listener<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
239
- </ul>
240
- <ul class="tsd-descriptions">
241
- <li class="tsd-description">
242
- <aside class="tsd-sources">
243
- <p>Inherited from <a href="../classes/shared_utils.Subscribe.html">Subscribe</a>.<a href="../classes/shared_utils.Subscribe.html#hasListener">hasListener</a></p>
244
- <ul>
245
- <li>Defined in shared-utils/Subscribe.ts:48</li>
246
- </ul>
247
- </aside>
248
- <div class="tsd-comment tsd-typography">
249
- <div class="lead">
250
- <p>判断是否注册了事件</p>
251
- </div>
252
- </div>
253
- <h4 class="tsd-parameters-title">Parameters</h4>
254
- <ul class="tsd-parameters">
255
- <li>
256
- <h5>name: <span class="tsd-signature-symbol">keyof </span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a></h5>
257
- <div class="tsd-comment tsd-typography">
258
- <p>事件类型</p>
259
- </div>
260
- </li>
261
- </ul>
262
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
263
- </li>
264
- </ul>
265
- </section>
266
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
267
- <a name="join" class="tsd-anchor"></a>
268
- <h3>join</h3>
269
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
270
- <li class="tsd-signature tsd-kind-icon">join<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>roomId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><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>type<span class="tsd-signature-symbol">: </span><a href="../enums/RTCProtocol.RTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCType</a><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><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
271
- </ul>
272
- <ul class="tsd-descriptions">
273
- <li class="tsd-description">
274
- <aside class="tsd-sources">
275
- <ul>
276
- <li>Defined in RTCProtocol/index.ts:19</li>
277
- </ul>
278
- </aside>
279
- <div class="tsd-comment tsd-typography">
280
- <div class="lead">
281
- <p>加入房间。</p>
282
- </div>
283
- </div>
284
- <h4 class="tsd-parameters-title">Parameters</h4>
285
- <ul class="tsd-parameters">
286
- <li>
287
- <h5>options: <span class="tsd-signature-symbol">{ </span>roomId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><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>type<span class="tsd-signature-symbol">: </span><a href="../enums/RTCProtocol.RTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCType</a><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>
288
- <ul class="tsd-parameters">
289
- <li class="tsd-parameter">
290
- <h5>room<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><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>
291
- </li>
292
- <li class="tsd-parameter">
293
- <h5>type<span class="tsd-signature-symbol">: </span><a href="../enums/RTCProtocol.RTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCType</a></h5>
294
- </li>
295
- <li class="tsd-parameter">
296
- <h5>user<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
297
- </li>
298
- <li class="tsd-parameter">
299
- <h5>voice<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
300
- </li>
301
- </ul>
302
- </li>
303
- </ul>
304
- <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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
305
- </li>
306
- </ul>
307
- </section>
308
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited">
309
- <a name="off" class="tsd-anchor"></a>
310
- <h3>off</h3>
311
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited">
312
- <li class="tsd-signature tsd-kind-icon">off&lt;K&gt;<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">K</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
313
- </ul>
314
- <ul class="tsd-descriptions">
315
- <li class="tsd-description">
316
- <aside class="tsd-sources">
317
- <p>Inherited from <a href="../classes/shared_utils.Subscribe.html">Subscribe</a>.<a href="../classes/shared_utils.Subscribe.html#off">off</a></p>
318
- <ul>
319
- <li>Defined in shared-utils/Subscribe.ts:97</li>
320
- </ul>
321
- </aside>
322
- <div class="tsd-comment tsd-typography">
323
- <div class="lead">
324
- <p>解除事件</p>
325
- </div>
326
- <p>如果 name 不传的话解除对应所有事件
327
- 如果 name, callback 不传的话解除所有name的所有事件</p>
328
- </div>
329
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
330
- <ul class="tsd-type-parameters">
331
- <li>
332
- <h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a></h4>
333
- <div class="tsd-comment tsd-typography">
334
- <p>预设的监听事件名称</p>
335
- </div>
336
- </li>
337
- </ul>
338
- <h4 class="tsd-parameters-title">Parameters</h4>
339
- <ul class="tsd-parameters">
340
- <li>
341
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> name: <span class="tsd-signature-type">K</span></h5>
342
- <div class="tsd-comment tsd-typography">
343
- <p>事件类型</p>
344
- </div>
345
- </li>
346
- <li>
347
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5>
348
- <div class="tsd-comment tsd-typography">
349
- <p>事件回调函数</p>
350
- </div>
351
- <ul class="tsd-parameters">
352
- <li class="tsd-parameter-signature">
353
- <ul class="tsd-signatures tsd-kind-type-literal">
354
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li>
355
- </ul>
356
- <ul class="tsd-descriptions">
357
- <li class="tsd-description">
358
- <h4 class="tsd-parameters-title">Parameters</h4>
359
- <ul class="tsd-parameters">
360
- <li>
361
- <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5>
362
- </li>
363
- </ul>
364
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4>
365
- </li>
366
- </ul>
367
- </li>
368
- </ul>
369
- </li>
370
- </ul>
371
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
372
- </li>
373
- </ul>
374
- </section>
375
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited">
376
- <a name="on" class="tsd-anchor"></a>
377
- <h3>on</h3>
378
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited">
379
- <li class="tsd-signature tsd-kind-icon">on&lt;K&gt;<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">K</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span>, once<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </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">void</span></li>
380
- </ul>
381
- <ul class="tsd-descriptions">
382
- <li class="tsd-description">
383
- <aside class="tsd-sources">
384
- <p>Inherited from <a href="../classes/shared_utils.Subscribe.html">Subscribe</a>.<a href="../classes/shared_utils.Subscribe.html#on">on</a></p>
385
- <ul>
386
- <li>Defined in shared-utils/Subscribe.ts:62</li>
387
- </ul>
388
- </aside>
389
- <div class="tsd-comment tsd-typography">
390
- <div class="lead">
391
- <p>注册事件</p>
392
- </div>
393
- <dl class="tsd-comment-tags">
394
- <dt>template</dt>
395
- <dd><p>回调函数函数上下文</p>
396
- </dd>
397
- </dl>
398
- </div>
399
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
400
- <ul class="tsd-type-parameters">
401
- <li>
402
- <h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a></h4>
403
- <div class="tsd-comment tsd-typography">
404
- <p>预设的监听事件名称</p>
405
- </div>
406
- </li>
407
- </ul>
408
- <h4 class="tsd-parameters-title">Parameters</h4>
409
- <ul class="tsd-parameters">
410
- <li>
411
- <h5>name: <span class="tsd-signature-type">K</span></h5>
412
- <div class="tsd-comment tsd-typography">
413
- <p>事件类型</p>
414
- </div>
415
- </li>
416
- <li>
417
- <h5>callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5>
418
- <div class="tsd-comment tsd-typography">
419
- <p>事件回调函数</p>
420
- </div>
421
- <ul class="tsd-parameters">
422
- <li class="tsd-parameter-signature">
423
- <ul class="tsd-signatures tsd-kind-type-literal">
424
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li>
425
- </ul>
426
- <ul class="tsd-descriptions">
427
- <li class="tsd-description">
428
- <h4 class="tsd-parameters-title">Parameters</h4>
429
- <ul class="tsd-parameters">
430
- <li>
431
- <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5>
432
- </li>
433
- </ul>
434
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4>
435
- </li>
436
- </ul>
437
- </li>
438
- </ul>
439
- </li>
440
- <li>
441
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> once: <span class="tsd-signature-type">boolean</span></h5>
442
- <div class="tsd-comment tsd-typography">
443
- <p>是否只执行一次</p>
444
- </div>
445
- </li>
446
- </ul>
447
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h4>
448
- <p>解除事件</p>
449
- <ul class="tsd-parameters">
450
- <li class="tsd-parameter-signature">
451
- <ul class="tsd-signatures tsd-kind-type-literal">
452
- <li class="tsd-signature tsd-kind-icon"><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>
453
- </ul>
454
- <ul class="tsd-descriptions">
455
- <li class="tsd-description">
456
- <div class="tsd-comment tsd-typography">
457
- <div class="lead">
458
- <p>注册事件</p>
459
- </div>
460
- <dl class="tsd-comment-tags">
461
- <dt>template</dt>
462
- <dd><p>预设的监听事件名称</p>
463
- </dd>
464
- <dt>template</dt>
465
- <dd><p>回调函数函数上下文</p>
466
- </dd>
467
- </dl>
468
- </div>
469
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
470
- <p>解除事件</p>
471
- </li>
472
- </ul>
473
- </li>
474
- </ul>
475
- </li>
476
- </ul>
477
- </section>
478
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited">
479
- <a name="once" class="tsd-anchor"></a>
480
- <h3>once</h3>
481
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited">
482
- <li class="tsd-signature tsd-kind-icon">once&lt;K&gt;<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">K</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </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">void</span></li>
483
- </ul>
484
- <ul class="tsd-descriptions">
485
- <li class="tsd-description">
486
- <aside class="tsd-sources">
487
- <p>Inherited from <a href="../classes/shared_utils.Subscribe.html">Subscribe</a>.<a href="../classes/shared_utils.Subscribe.html#once">once</a></p>
488
- <ul>
489
- <li>Defined in shared-utils/Subscribe.ts:81</li>
490
- </ul>
491
- </aside>
492
- <div class="tsd-comment tsd-typography">
493
- <div class="lead">
494
- <p>注册事件(是否只执行一次)</p>
495
- </div>
496
- <dl class="tsd-comment-tags">
497
- <dt>template</dt>
498
- <dd><p>回调函数函数上下文</p>
499
- </dd>
500
- </dl>
501
- </div>
502
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
503
- <ul class="tsd-type-parameters">
504
- <li>
505
- <h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a></h4>
506
- <div class="tsd-comment tsd-typography">
507
- <p>预设的监听事件名称</p>
508
- </div>
509
- </li>
510
- </ul>
511
- <h4 class="tsd-parameters-title">Parameters</h4>
512
- <ul class="tsd-parameters">
513
- <li>
514
- <h5>name: <span class="tsd-signature-type">K</span></h5>
515
- <div class="tsd-comment tsd-typography">
516
- <p>事件类型</p>
517
- </div>
518
- </li>
519
- <li>
520
- <h5>callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5>
521
- <div class="tsd-comment tsd-typography">
522
- <p>事件回调函数</p>
523
- </div>
524
- <ul class="tsd-parameters">
525
- <li class="tsd-parameter-signature">
526
- <ul class="tsd-signatures tsd-kind-type-literal">
527
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li>
528
- </ul>
529
- <ul class="tsd-descriptions">
530
- <li class="tsd-description">
531
- <h4 class="tsd-parameters-title">Parameters</h4>
532
- <ul class="tsd-parameters">
533
- <li>
534
- <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5>
535
- </li>
536
- </ul>
537
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4>
538
- </li>
539
- </ul>
540
- </li>
541
- </ul>
542
- </li>
543
- </ul>
544
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h4>
545
- <p>解除事件</p>
546
- <ul class="tsd-parameters">
547
- <li class="tsd-parameter-signature">
548
- <ul class="tsd-signatures tsd-kind-type-literal">
549
- <li class="tsd-signature tsd-kind-icon"><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>
550
- </ul>
551
- <ul class="tsd-descriptions">
552
- <li class="tsd-description">
553
- <div class="tsd-comment tsd-typography">
554
- <div class="lead">
555
- <p>注册事件(是否只执行一次)</p>
556
- </div>
557
- <dl class="tsd-comment-tags">
558
- <dt>template</dt>
559
- <dd><p>预设的监听事件名称</p>
560
- </dd>
561
- <dt>template</dt>
562
- <dd><p>回调函数函数上下文</p>
563
- </dd>
564
- </dl>
565
- </div>
566
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
567
- <p>解除事件</p>
568
- </li>
569
- </ul>
570
- </li>
571
- </ul>
572
- </li>
573
- </ul>
574
- </section>
575
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
576
- <a name="quit" class="tsd-anchor"></a>
577
- <h3>quit</h3>
578
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
579
- <li class="tsd-signature tsd-kind-icon">quit<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">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
580
- </ul>
581
- <ul class="tsd-descriptions">
582
- <li class="tsd-description">
583
- <aside class="tsd-sources">
584
- <ul>
585
- <li>Defined in RTCProtocol/index.ts:24</li>
586
- </ul>
587
- </aside>
588
- <div class="tsd-comment tsd-typography">
589
- <div class="lead">
590
- <p>离开房间。</p>
591
- </div>
592
- </div>
593
- <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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
594
- </li>
595
- </ul>
596
- </section>
597
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
598
- <a name="shock" class="tsd-anchor"></a>
599
- <h3>shock</h3>
600
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
601
- <li class="tsd-signature tsd-kind-icon">shock<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>
602
- </ul>
603
- <ul class="tsd-descriptions">
604
- <li class="tsd-description">
605
- <aside class="tsd-sources">
606
- <ul>
607
- <li>Defined in RTCProtocol/index.ts:39</li>
608
- </ul>
609
- </aside>
610
- <div class="tsd-comment tsd-typography">
611
- <div class="lead">
612
- <p>震动。</p>
613
- </div>
614
- </div>
615
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
616
- </li>
617
- </ul>
618
- </section>
619
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
620
- <a name="toggleMicro" class="tsd-anchor"></a>
621
- <h3>toggle<wbr>Micro</h3>
622
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
623
- <li class="tsd-signature tsd-kind-icon">toggle<wbr>Micro<span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
624
- </ul>
625
- <ul class="tsd-descriptions">
626
- <li class="tsd-description">
627
- <aside class="tsd-sources">
628
- <ul>
629
- <li>Defined in RTCProtocol/index.ts:34</li>
630
- </ul>
631
- </aside>
632
- <div class="tsd-comment tsd-typography">
633
- <div class="lead">
634
- <p>关闭\开启 本地麦克风。</p>
635
- </div>
636
- </div>
637
- <h4 class="tsd-parameters-title">Parameters</h4>
638
- <ul class="tsd-parameters">
639
- <li>
640
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> flag: <span class="tsd-signature-type">boolean</span></h5>
641
- </li>
642
- </ul>
643
- <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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
644
- </li>
645
- </ul>
646
- </section>
647
- </section>
648
- </div>
649
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
650
- <nav class="tsd-navigation primary">
651
- <ul>
652
- <li class=" ">
653
- <a href="../modules.html">Modules</a>
654
- </li>
655
- <li class="current tsd-kind-module">
656
- <a href="../modules/RTCProtocol.html">RTCProtocol</a>
657
- </li>
658
- <li class=" tsd-kind-module">
659
- <a href="../modules/live.html">live</a>
660
- </li>
661
- <li class=" tsd-kind-module">
662
- <a href="../modules/shared_utils.html">shared-<wbr>utils</a>
663
- </li>
664
- </ul>
665
- </nav>
666
- <nav class="tsd-navigation secondary menu-sticky">
667
- <ul class="before-current">
668
- <li class=" tsd-kind-enum tsd-parent-kind-module">
669
- <a href="../enums/RTCProtocol.RTCType.html" class="tsd-kind-icon">RTCType</a>
670
- </li>
671
- <li class=" tsd-kind-class tsd-parent-kind-module">
672
- <a href="../classes/RTCProtocol.RTCExample.html" class="tsd-kind-icon">RTCExample</a>
673
- </li>
674
- </ul>
675
- <ul class="current">
676
- <li class="current tsd-kind-interface tsd-parent-kind-module">
677
- <a href="RTCProtocol.RTCProtocol-1.html" class="tsd-kind-icon">RTCProtocol</a>
678
- <ul>
679
- <li class=" tsd-kind-property tsd-parent-kind-interface">
680
- <a href="RTCProtocol.RTCProtocol-1.html#joined" class="tsd-kind-icon">joined</a>
681
- </li>
682
- <li class=" tsd-kind-property tsd-parent-kind-interface">
683
- <a href="RTCProtocol.RTCProtocol-1.html#micro" class="tsd-kind-icon">micro</a>
684
- </li>
685
- <li class=" tsd-kind-property tsd-parent-kind-interface">
686
- <a href="RTCProtocol.RTCProtocol-1.html#type" class="tsd-kind-icon">type</a>
687
- </li>
688
- <li class=" tsd-kind-property tsd-parent-kind-interface">
689
- <a href="RTCProtocol.RTCProtocol-1.html#voiceId" class="tsd-kind-icon">voice<wbr>Id</a>
690
- </li>
691
- <li class=" tsd-kind-method tsd-parent-kind-interface">
692
- <a href="RTCProtocol.RTCProtocol-1.html#detectMicro" class="tsd-kind-icon">detect<wbr>Micro</a>
693
- </li>
694
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited">
695
- <a href="RTCProtocol.RTCProtocol-1.html#emit" class="tsd-kind-icon">emit</a>
696
- </li>
697
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
698
- <a href="RTCProtocol.RTCProtocol-1.html#hasListener" class="tsd-kind-icon">has<wbr>Listener</a>
699
- </li>
700
- <li class=" tsd-kind-method tsd-parent-kind-interface">
701
- <a href="RTCProtocol.RTCProtocol-1.html#join" class="tsd-kind-icon">join</a>
702
- </li>
703
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited">
704
- <a href="RTCProtocol.RTCProtocol-1.html#off" class="tsd-kind-icon">off</a>
705
- </li>
706
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited">
707
- <a href="RTCProtocol.RTCProtocol-1.html#on" class="tsd-kind-icon">on</a>
708
- </li>
709
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited">
710
- <a href="RTCProtocol.RTCProtocol-1.html#once" class="tsd-kind-icon">once</a>
711
- </li>
712
- <li class=" tsd-kind-method tsd-parent-kind-interface">
713
- <a href="RTCProtocol.RTCProtocol-1.html#quit" class="tsd-kind-icon">quit</a>
714
- </li>
715
- <li class=" tsd-kind-method tsd-parent-kind-interface">
716
- <a href="RTCProtocol.RTCProtocol-1.html#shock" class="tsd-kind-icon">shock</a>
717
- </li>
718
- <li class=" tsd-kind-method tsd-parent-kind-interface">
719
- <a href="RTCProtocol.RTCProtocol-1.html#toggleMicro" class="tsd-kind-icon">toggle<wbr>Micro</a>
720
- </li>
721
- </ul>
722
- </li>
723
- </ul>
724
- <ul class="after-current">
725
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
726
- <a href="../modules/RTCProtocol.html#RTCActionReactCallback" class="tsd-kind-icon">RTCAction<wbr>React<wbr>Callback</a>
727
- </li>
728
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
729
- <a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-kind-icon">RTCEvent<wbr>Type</a>
730
- </li>
731
- </ul>
732
- </nav>
733
- </div>
734
- </div>
735
- </div>
736
- <footer>
737
- <div class="container">
738
- <h2>Legend</h2>
739
- <div class="tsd-legend-group">
740
- <ul class="tsd-legend">
741
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
742
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
743
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
744
- <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
745
- </ul>
746
- <ul class="tsd-legend">
747
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
748
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
749
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
750
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
751
- </ul>
752
- <ul class="tsd-legend">
753
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
754
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
755
- </ul>
756
- <ul class="tsd-legend">
757
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
758
- </ul>
759
- </div>
760
- </div>
761
- </footer>
762
- <div class="overlay"></div>
763
- <script src="../assets/js/main.js"></script>
764
- </body>
765
- </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="../modules/RTCProtocol.html">RTCProtocol</a></li><li><a href="RTCProtocol.RTCProtocol-1.html">RTCProtocol</a></li></ul><h1>Interface RTCProtocol</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="../classes/shared_utils.Subscribe.html" class="tsd-signature-type" data-tsd-kind="Class">Subscribe</a><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">RTCProtocol</span></li></ul></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/RTCProtocol.BrowserRTC.html" class="tsd-signature-type" data-tsd-kind="Class">BrowserRTC</a></li><li><a href="../classes/RTCProtocol.BrowserRTC4Chime.html" class="tsd-signature-type" data-tsd-kind="Class">BrowserRTC4Chime</a></li><li><a href="../classes/RTCProtocol.RTCExample.html" class="tsd-signature-type" data-tsd-kind="Class">RTCExample</a></li><li><a href="../classes/RTCProtocol.VRWebViewRTC.html" class="tsd-signature-type" data-tsd-kind="Class">VRWebViewRTC</a></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="RTCProtocol.RTCProtocol-1.html#joined" class="tsd-kind-icon">joined</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#micro" class="tsd-kind-icon">micro</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#voiceId" class="tsd-kind-icon">voice<wbr/>Id</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="RTCProtocol.RTCProtocol-1.html#detectMicro" class="tsd-kind-icon">detect<wbr/>Micro</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#hasListener" class="tsd-kind-icon">has<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#join" class="tsd-kind-icon">join</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#quit" class="tsd-kind-icon">quit</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#shock" class="tsd-kind-icon">shock</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#toggleMicro" class="tsd-kind-icon">toggle<wbr/>Micro</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="joined" class="tsd-anchor"></a><h3>joined</h3><div class="tsd-signature tsd-kind-icon">joined<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:10</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="micro" class="tsd-anchor"></a><h3>micro</h3><div class="tsd-signature tsd-kind-icon">micro<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:11</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/RTCProtocol.RTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCType</a></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="voiceId" class="tsd-anchor"></a><h3>voice<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">voice<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:12</li></ul></aside></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="detectMicro" class="tsd-anchor"></a><h3>detect<wbr/>Micro</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">detect<wbr/>Micro<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">boolean</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/RTCProtocol.ts:30</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>监测麦克风授权。</p>
3
+ </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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a id="emit" class="tsd-anchor"></a><h3>emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, <span class="tsd-signature-symbol">...</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</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"><p>Inherited from <a href="../classes/shared_utils.Subscribe.html">Subscribe</a>.<a href="../classes/shared_utils.Subscribe.html#emit">emit</a></p><ul><li>Defined in shared-utils/Subscribe.ts:127</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>触发事件</p>
5
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a></h4><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>预设的监听事件名称</p>
7
+ </div></div></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>事件类型</p>
9
+ </div></div></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>data: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
10
+ <p>触发事件的数据</p>
11
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>canceled 是否被触发取消</p>
12
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a id="hasListener" class="tsd-anchor"></a><h3>has<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">has<wbr/>Listener<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><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"><p>Inherited from <a href="../classes/shared_utils.Subscribe.html">Subscribe</a>.<a href="../classes/shared_utils.Subscribe.html#hasListener">hasListener</a></p><ul><li>Defined in shared-utils/Subscribe.ts:48</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
13
+ <p>判断是否注册了事件</p>
14
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-symbol">keyof </span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
15
+ <p>事件类型</p>
16
+ </div></div></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="join" class="tsd-anchor"></a><h3>join</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">join<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>roomId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><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>type<span class="tsd-signature-symbol">: </span><a href="../enums/RTCProtocol.RTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCType</a><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><span class="tsd-signature-type">boolean</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/RTCProtocol.ts:20</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>options: <span class="tsd-signature-symbol">{ </span>roomId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><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>type<span class="tsd-signature-symbol">: </span><a href="../enums/RTCProtocol.RTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCType</a><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">undefined</span><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>type<span class="tsd-signature-symbol">: </span><a href="../enums/RTCProtocol.RTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCType</a></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><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a id="off" class="tsd-anchor"></a><h3>off</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</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"><p>Inherited from <a href="../classes/shared_utils.Subscribe.html">Subscribe</a>.<a href="../classes/shared_utils.Subscribe.html#off">off</a></p><ul><li>Defined in shared-utils/Subscribe.ts:97</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
19
+ <p>解除事件</p>
20
+ </div><div><p>如果 name 不传的话解除对应所有事件
21
+ 如果 name, callback 不传的话解除所有name的所有事件</p>
22
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a></h4><div class="tsd-comment tsd-typography"><div class="lead">
23
+ <p>预设的监听事件名称</p>
24
+ </div></div></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> name: <span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
25
+ <p>事件类型</p>
26
+ </div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
27
+ <p>事件回调函数</p>
28
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><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><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a id="on" class="tsd-anchor"></a><h3>on</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span>, once<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </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">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="../classes/shared_utils.Subscribe.html">Subscribe</a>.<a href="../classes/shared_utils.Subscribe.html#on">on</a></p><ul><li>Defined in shared-utils/Subscribe.ts:62</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
29
+ <p>注册事件</p>
30
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a></h4><div class="tsd-comment tsd-typography"><div class="lead">
31
+ <p>预设的监听事件名称</p>
32
+ </div></div></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
33
+ <p>事件类型</p>
34
+ </div></div></li><li><h5>callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
35
+ <p>事件回调函数</p>
36
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><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><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> once: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
37
+ <p>是否只执行一次</p>
38
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h4><div><p>解除事件</p>
39
+ </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><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"><div class="tsd-comment tsd-typography"><div class="lead">
40
+ <p>注册事件</p>
41
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>解除事件</p>
42
+ </div></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a id="once" class="tsd-anchor"></a><h3>once</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </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">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="../classes/shared_utils.Subscribe.html">Subscribe</a>.<a href="../classes/shared_utils.Subscribe.html#once">once</a></p><ul><li>Defined in shared-utils/Subscribe.ts:81</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
43
+ <p>注册事件(是否只执行一次)</p>
44
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a></h4><div class="tsd-comment tsd-typography"><div class="lead">
45
+ <p>预设的监听事件名称</p>
46
+ </div></div></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
47
+ <p>事件类型</p>
48
+ </div></div></li><li><h5>callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
49
+ <p>事件回调函数</p>
50
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><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><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h4><div><p>解除事件</p>
51
+ </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><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"><div class="tsd-comment tsd-typography"><div class="lead">
52
+ <p>注册事件(是否只执行一次)</p>
53
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>解除事件</p>
54
+ </div></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="quit" class="tsd-anchor"></a><h3>quit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">quit<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">boolean</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/RTCProtocol.ts:25</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
55
+ <p>离开房间。</p>
56
+ </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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="shock" class="tsd-anchor"></a><h3>shock</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">shock<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/RTCProtocol.ts:40</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
57
+ <p>震动。</p>
58
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="toggleMicro" class="tsd-anchor"></a><h3>toggle<wbr/>Micro</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">toggle<wbr/>Micro<span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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">boolean</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/RTCProtocol.ts:35</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
59
+ <p>关闭\开启 本地麦克风。</p>
60
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> flag: <span class="tsd-signature-type">boolean</span></h5></li></ul><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">boolean</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="current tsd-kind-module"><a href="../modules/RTCProtocol.html">RTCProtocol</a></li><li class=" 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="RTCProtocol.RTCProtocol-1.html" class="tsd-kind-icon">RTCProtocol</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#joined" class="tsd-kind-icon">joined</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#micro" class="tsd-kind-icon">micro</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#voiceId" class="tsd-kind-icon">voice<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#detectMicro" class="tsd-kind-icon">detect<wbr/>Micro</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#hasListener" class="tsd-kind-icon">has<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#join" class="tsd-kind-icon">join</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#quit" class="tsd-kind-icon">quit</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#shock" class="tsd-kind-icon">shock</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#toggleMicro" class="tsd-kind-icon">toggle<wbr/>Micro</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>