speaker-calibration 2.2.221 → 2.2.222
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintignore +71 -71
- package/.eslintrc.json +40 -40
- package/.github/workflows/update-phrases.yml +37 -0
- package/.prettierignore +69 -69
- package/.prettierrc +14 -14
- package/LICENSE +20 -20
- package/README.md +133 -133
- package/__mocks__/fileMock.js +1 -1
- package/__mocks__/styleMock.js +1 -1
- package/babel.config.js +3 -3
- package/coverage/clover.xml +71 -71
- package/coverage/coverage-final.json +224 -224
- package/coverage/lcov-report/PythonServerInterface.js.html +265 -265
- package/coverage/lcov-report/base.css +354 -354
- package/coverage/lcov-report/block-navigation.js +82 -82
- package/coverage/lcov-report/index.html +123 -123
- package/coverage/lcov-report/prettify.css +101 -101
- package/coverage/lcov-report/prettify.js +937 -937
- package/coverage/lcov-report/sorter.js +189 -189
- package/coverage/lcov-report/src/index.html +121 -121
- package/coverage/lcov-report/src/server/PythonServerInterface.js.html +268 -268
- package/coverage/lcov-report/src/server/index.html +123 -123
- package/coverage/lcov-report/src/tasks/audioCalibrator.js.html +499 -499
- package/coverage/lcov-report/src/tasks/audioRecorder.js.html +412 -412
- package/coverage/lcov-report/src/tasks/index.html +143 -143
- package/coverage/lcov-report/src/tasks/volume/index.html +123 -123
- package/coverage/lcov-report/src/tasks/volume/volume.js.html +409 -409
- package/coverage/lcov-report/src/utils.js.html +172 -172
- package/coverage/lcov.info +91 -91
- package/dist/example/NoSleep.min.js +1 -1
- package/dist/example/fetch-languages-sheets.js +77 -77
- package/dist/example/i18n.js +29082 -29082
- package/dist/example/index.html +47 -47
- package/dist/example/listener.html +81 -81
- package/dist/example/server.js +51 -51
- package/dist/example/speaker.html +145 -145
- package/dist/example/speakerUI.js +273 -273
- package/dist/example/styles.css +152 -152
- package/dist/listener.js +3 -3
- package/dist/main.js +11 -11
- package/dist/mlsGen.js +6814 -6814
- package/dist/mlsGen.wasm +0 -0
- package/dist/package-lock.json +1018 -1018
- package/dist/package.json +18 -18
- package/doc/AudioCalibrator.html +417 -417
- package/doc/AudioPeer.html +251 -251
- package/doc/AudioRecorder.html +195 -195
- package/doc/ImpulseResponse.html +215 -215
- package/doc/Listener.html +308 -308
- package/doc/MlsGenInterface.html +226 -226
- package/doc/MyEventEmitter.html +274 -274
- package/doc/PythonServerAPI.html +109 -109
- package/doc/Speaker.html +276 -276
- package/doc/Takes%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +128 -128
- package/doc/Takes%20the%20url%20of%20the%20current%20site%0Aand%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +138 -138
- package/doc/Takes%20the%20url%20of%20the%20current%20site%20and%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +137 -137
- package/doc/Volume.html +88 -88
- package/doc/audioCalibrator.js.html +179 -179
- package/doc/audioPeer.js.html +175 -175
- package/doc/audioRecorder.js.html +163 -163
- package/doc/creates%20a%20new%20AudioRecorder%20instance.%20%0ASets%20up%20the%20audio%20context%20and%20file%20reader..html +114 -114
- package/doc/fonts/OpenSans-Bold-webfont.svg +1829 -1829
- package/doc/fonts/OpenSans-BoldItalic-webfont.svg +1829 -1829
- package/doc/fonts/OpenSans-Italic-webfont.svg +1829 -1829
- package/doc/fonts/OpenSans-Light-webfont.svg +1830 -1830
- package/doc/fonts/OpenSans-LightItalic-webfont.svg +1834 -1834
- package/doc/fonts/OpenSans-Regular-webfont.svg +1830 -1830
- package/doc/global.html +308 -308
- package/doc/index.html +58 -58
- package/doc/listener.js.html +170 -170
- package/doc/mlsGen_mlsGenInterface.js.html +117 -117
- package/doc/myEventEmitter.js.html +124 -124
- package/doc/peer-connection_audioPeer.js.html +188 -188
- package/doc/peer-connection_listener.js.html +311 -311
- package/doc/peer-connection_speaker.js.html +381 -381
- package/doc/scripts/linenumber.js +25 -25
- package/doc/scripts/prettify/Apache-License-2.0.txt +202 -202
- package/doc/scripts/prettify/lang-css.js +24 -24
- package/doc/scripts/prettify/prettify.js +640 -640
- package/doc/server_PythonServerAPI.js.html +160 -160
- package/doc/speaker.js.html +248 -248
- package/doc/styles/jsdoc-default.css +371 -371
- package/doc/styles/prettify-jsdoc.css +111 -111
- package/doc/styles/prettify-tomorrow.css +163 -163
- package/doc/tasks_audioCalibrator.js.html +207 -207
- package/doc/tasks_audioRecorder.js.html +190 -190
- package/doc/tasks_impulse-response_impulseResponse.js.html +442 -442
- package/doc/tasks_impulse-response_mlsGen_mlsGenInterface.js.html +175 -175
- package/doc/tasks_volume_volume.js.html +185 -185
- package/doc/utils.js.html +105 -105
- package/jest.config.js +173 -173
- package/makefile +74 -0
- package/netlify.toml +26 -26
- package/package.json +78 -78
- package/src/config/firebase.js +26 -26
- package/src/index.html +21 -21
- package/src/listener-app/listener.js +377 -377
- package/src/main.js +22 -22
- package/src/myEventEmitter.js +83 -83
- package/src/peer-connection/audioPeer.js +148 -148
- package/src/peer-connection/listener.js +467 -467
- package/src/peer-connection/peerErrors.js +25 -25
- package/src/peer-connection/speaker.js +818 -812
- package/src/powerCheck.js +98 -98
- package/src/server/PythonServerAPI.js +869 -869
- package/src/tasks/audioCalibrator.js +360 -360
- package/src/tasks/audioRecorder.js +315 -315
- package/src/tasks/combination/combination.js +3171 -3171
- package/src/tasks/combination/mlsGen/mlsGen.cpp +98 -98
- package/src/tasks/combination/mlsGen/mlsGen.hpp +303 -303
- package/src/tasks/combination/mlsGen/mlsGenInterface.js +131 -131
- package/src/tasks/combination/mlsGen/mlsGenTest.cpp +180 -180
- package/src/tasks/impulse-response/impulseResponse.js +610 -610
- package/src/tasks/impulse-response/mlsGen/mlsGen.cpp +98 -98
- package/src/tasks/impulse-response/mlsGen/mlsGen.hpp +303 -303
- package/src/tasks/impulse-response/mlsGen/mlsGenInterface.js +131 -131
- package/src/tasks/impulse-response/mlsGen/mlsGenTest.cpp +180 -180
- package/src/tasks/volume/volume.cpp +2 -2
- package/src/tasks/volume/volume.hpp +22 -22
- package/src/tasks/volume/volume.js +279 -279
- package/src/utils.js +205 -205
- package/webpack.config.js +64 -64
- package/.gitignore +0 -81
package/doc/Listener.html
CHANGED
|
@@ -1,308 +1,308 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8" />
|
|
5
|
-
<title>JSDoc: Class: Listener</title>
|
|
6
|
-
|
|
7
|
-
<script src="scripts/prettify/prettify.js"></script>
|
|
8
|
-
<script src="scripts/prettify/lang-css.js"></script>
|
|
9
|
-
<!--[if lt IE 9]>
|
|
10
|
-
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
11
|
-
<![endif]-->
|
|
12
|
-
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css" />
|
|
13
|
-
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css" />
|
|
14
|
-
</head>
|
|
15
|
-
|
|
16
|
-
<body>
|
|
17
|
-
<div id="main">
|
|
18
|
-
<h1 class="page-title">Class: Listener</h1>
|
|
19
|
-
|
|
20
|
-
<section>
|
|
21
|
-
<header>
|
|
22
|
-
<h2>
|
|
23
|
-
<span class="attribs"><span class="type-signature"></span></span>Listener<span
|
|
24
|
-
class="signature"
|
|
25
|
-
>(params)</span
|
|
26
|
-
><span class="type-signature"></span>
|
|
27
|
-
</h2>
|
|
28
|
-
|
|
29
|
-
<div class="class-description">
|
|
30
|
-
Handles the listener's side of the connection. Responsible for getting access to user's
|
|
31
|
-
microphone, and initiating a call to the Speaker.
|
|
32
|
-
</div>
|
|
33
|
-
</header>
|
|
34
|
-
|
|
35
|
-
<article>
|
|
36
|
-
<div class="container-overview">
|
|
37
|
-
<h2>Constructor</h2>
|
|
38
|
-
|
|
39
|
-
<h4 class="name" id="Listener">
|
|
40
|
-
<span class="type-signature"></span>new Listener<span class="signature">(params)</span
|
|
41
|
-
><span class="type-signature"></span>
|
|
42
|
-
</h4>
|
|
43
|
-
|
|
44
|
-
<div class="description">
|
|
45
|
-
Takes a target element where html elements will be appended.
|
|
46
|
-
</div>
|
|
47
|
-
|
|
48
|
-
<h5>Parameters:</h5>
|
|
49
|
-
|
|
50
|
-
<table class="params">
|
|
51
|
-
<thead>
|
|
52
|
-
<tr>
|
|
53
|
-
<th>Name</th>
|
|
54
|
-
|
|
55
|
-
<th>Type</th>
|
|
56
|
-
|
|
57
|
-
<th class="last">Description</th>
|
|
58
|
-
</tr>
|
|
59
|
-
</thead>
|
|
60
|
-
|
|
61
|
-
<tbody>
|
|
62
|
-
<tr>
|
|
63
|
-
<td class="name"><code>params</code></td>
|
|
64
|
-
|
|
65
|
-
<td class="type">
|
|
66
|
-
<span class="param-type"
|
|
67
|
-
><a href="global.html#initParameters">initParameters</a></span
|
|
68
|
-
>
|
|
69
|
-
</td>
|
|
70
|
-
|
|
71
|
-
<td class="description last">see type definition for initParameters</td>
|
|
72
|
-
</tr>
|
|
73
|
-
</tbody>
|
|
74
|
-
</table>
|
|
75
|
-
|
|
76
|
-
<dl class="details">
|
|
77
|
-
<dt class="tag-source">Source:</dt>
|
|
78
|
-
<dd class="tag-source">
|
|
79
|
-
<ul class="dummy">
|
|
80
|
-
<li>
|
|
81
|
-
<a href="peer-connection_listener.js.html">peer-connection/listener.js</a>,
|
|
82
|
-
<a href="peer-connection_listener.js.html#line9">line 9</a>
|
|
83
|
-
</li>
|
|
84
|
-
</ul>
|
|
85
|
-
</dd>
|
|
86
|
-
</dl>
|
|
87
|
-
</div>
|
|
88
|
-
|
|
89
|
-
<h3 class="subsection-title">Extends</h3>
|
|
90
|
-
|
|
91
|
-
<ul>
|
|
92
|
-
<li><a href="AudioPeer.html">AudioPeer</a></li>
|
|
93
|
-
</ul>
|
|
94
|
-
|
|
95
|
-
<h3 class="subsection-title">Members</h3>
|
|
96
|
-
|
|
97
|
-
<h4 class="name" id="displayUpdate">
|
|
98
|
-
<span class="type-signature"></span>displayUpdate<span class="type-signature"></span>
|
|
99
|
-
</h4>
|
|
100
|
-
|
|
101
|
-
<div class="description">Helper method to display information to DOM element</div>
|
|
102
|
-
|
|
103
|
-
<dl class="details">
|
|
104
|
-
<dt class="tag-overrides">Overrides:</dt>
|
|
105
|
-
<dd class="tag-overrides">
|
|
106
|
-
<ul class="dummy">
|
|
107
|
-
<li>
|
|
108
|
-
<a href="AudioPeer.html#displayUpdate">AudioPeer#displayUpdate</a>
|
|
109
|
-
</li>
|
|
110
|
-
</ul>
|
|
111
|
-
</dd>
|
|
112
|
-
|
|
113
|
-
<dt class="tag-source">Source:</dt>
|
|
114
|
-
<dd class="tag-source">
|
|
115
|
-
<ul class="dummy">
|
|
116
|
-
<li>
|
|
117
|
-
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
118
|
-
<a href="peer-connection_audioPeer.js.html#line59">line 59</a>
|
|
119
|
-
</li>
|
|
120
|
-
</ul>
|
|
121
|
-
</dd>
|
|
122
|
-
</dl>
|
|
123
|
-
|
|
124
|
-
<h4 class="name" id="onPeerClose">
|
|
125
|
-
<span class="type-signature"></span>onPeerClose<span class="type-signature"></span>
|
|
126
|
-
</h4>
|
|
127
|
-
|
|
128
|
-
<div class="description">
|
|
129
|
-
Callback method that cleans up after peer connection is closed
|
|
130
|
-
</div>
|
|
131
|
-
|
|
132
|
-
<dl class="details">
|
|
133
|
-
<dt class="tag-overrides">Overrides:</dt>
|
|
134
|
-
<dd class="tag-overrides">
|
|
135
|
-
<ul class="dummy">
|
|
136
|
-
<li>
|
|
137
|
-
<a href="AudioPeer.html#onPeerClose">AudioPeer#onPeerClose</a>
|
|
138
|
-
</li>
|
|
139
|
-
</ul>
|
|
140
|
-
</dd>
|
|
141
|
-
|
|
142
|
-
<dt class="tag-source">Source:</dt>
|
|
143
|
-
<dd class="tag-source">
|
|
144
|
-
<ul class="dummy">
|
|
145
|
-
<li>
|
|
146
|
-
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
147
|
-
<a href="peer-connection_audioPeer.js.html#line90">line 90</a>
|
|
148
|
-
</li>
|
|
149
|
-
</ul>
|
|
150
|
-
</dd>
|
|
151
|
-
</dl>
|
|
152
|
-
|
|
153
|
-
<h4 class="name" id="onPeerDisconnected">
|
|
154
|
-
<span class="type-signature"></span>onPeerDisconnected<span
|
|
155
|
-
class="type-signature"
|
|
156
|
-
></span>
|
|
157
|
-
</h4>
|
|
158
|
-
|
|
159
|
-
<div class="description">
|
|
160
|
-
Callback method for when a peer connection is lost saves the last peer id, last server
|
|
161
|
-
id, and attempts to reconnect
|
|
162
|
-
</div>
|
|
163
|
-
|
|
164
|
-
<dl class="details">
|
|
165
|
-
<dt class="tag-overrides">Overrides:</dt>
|
|
166
|
-
<dd class="tag-overrides">
|
|
167
|
-
<ul class="dummy">
|
|
168
|
-
<li>
|
|
169
|
-
<a href="AudioPeer.html#onPeerDisconnected">AudioPeer#onPeerDisconnected</a>
|
|
170
|
-
</li>
|
|
171
|
-
</ul>
|
|
172
|
-
</dd>
|
|
173
|
-
|
|
174
|
-
<dt class="tag-source">Source:</dt>
|
|
175
|
-
<dd class="tag-source">
|
|
176
|
-
<ul class="dummy">
|
|
177
|
-
<li>
|
|
178
|
-
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
179
|
-
<a href="peer-connection_audioPeer.js.html#line77">line 77</a>
|
|
180
|
-
</li>
|
|
181
|
-
</ul>
|
|
182
|
-
</dd>
|
|
183
|
-
</dl>
|
|
184
|
-
|
|
185
|
-
<h4 class="name" id="onPeerError">
|
|
186
|
-
<span class="type-signature"></span>onPeerError<span class="type-signature"></span>
|
|
187
|
-
</h4>
|
|
188
|
-
|
|
189
|
-
<div class="description">Helper method for when an error occurs</div>
|
|
190
|
-
|
|
191
|
-
<dl class="details">
|
|
192
|
-
<dt class="tag-overrides">Overrides:</dt>
|
|
193
|
-
<dd class="tag-overrides">
|
|
194
|
-
<ul class="dummy">
|
|
195
|
-
<li>
|
|
196
|
-
<a href="AudioPeer.html#onPeerError">AudioPeer#onPeerError</a>
|
|
197
|
-
</li>
|
|
198
|
-
</ul>
|
|
199
|
-
</dd>
|
|
200
|
-
|
|
201
|
-
<dt class="tag-source">Source:</dt>
|
|
202
|
-
<dd class="tag-source">
|
|
203
|
-
<ul class="dummy">
|
|
204
|
-
<li>
|
|
205
|
-
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
206
|
-
<a href="peer-connection_audioPeer.js.html#line99">line 99</a>
|
|
207
|
-
</li>
|
|
208
|
-
</ul>
|
|
209
|
-
</dd>
|
|
210
|
-
</dl>
|
|
211
|
-
|
|
212
|
-
<h4 class="name" id="parseURLSearchParams">
|
|
213
|
-
<span class="type-signature"></span>parseURLSearchParams<span
|
|
214
|
-
class="type-signature"
|
|
215
|
-
></span>
|
|
216
|
-
</h4>
|
|
217
|
-
|
|
218
|
-
<div class="description">Helper method that converts url paramters to an object</div>
|
|
219
|
-
|
|
220
|
-
<dl class="details">
|
|
221
|
-
<dt class="tag-overrides">Overrides:</dt>
|
|
222
|
-
<dd class="tag-overrides">
|
|
223
|
-
<ul class="dummy">
|
|
224
|
-
<li>
|
|
225
|
-
<a href="AudioPeer.html#parseURLSearchParams">AudioPeer#parseURLSearchParams</a>
|
|
226
|
-
</li>
|
|
227
|
-
</ul>
|
|
228
|
-
</dd>
|
|
229
|
-
|
|
230
|
-
<dt class="tag-source">Source:</dt>
|
|
231
|
-
<dd class="tag-source">
|
|
232
|
-
<ul class="dummy">
|
|
233
|
-
<li>
|
|
234
|
-
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
235
|
-
<a href="peer-connection_audioPeer.js.html#line108">line 108</a>
|
|
236
|
-
</li>
|
|
237
|
-
</ul>
|
|
238
|
-
</dd>
|
|
239
|
-
</dl>
|
|
240
|
-
|
|
241
|
-
<h4 class="name" id="queryStringFromObject">
|
|
242
|
-
<span class="type-signature"></span>queryStringFromObject<span
|
|
243
|
-
class="type-signature"
|
|
244
|
-
></span>
|
|
245
|
-
</h4>
|
|
246
|
-
|
|
247
|
-
<div class="description">Helper method that converts an object to a query string</div>
|
|
248
|
-
|
|
249
|
-
<dl class="details">
|
|
250
|
-
<dt class="tag-overrides">Overrides:</dt>
|
|
251
|
-
<dd class="tag-overrides">
|
|
252
|
-
<ul class="dummy">
|
|
253
|
-
<li>
|
|
254
|
-
<a href="AudioPeer.html#queryStringFromObject">AudioPeer#queryStringFromObject</a>
|
|
255
|
-
</li>
|
|
256
|
-
</ul>
|
|
257
|
-
</dd>
|
|
258
|
-
|
|
259
|
-
<dt class="tag-source">Source:</dt>
|
|
260
|
-
<dd class="tag-source">
|
|
261
|
-
<ul class="dummy">
|
|
262
|
-
<li>
|
|
263
|
-
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
264
|
-
<a href="peer-connection_audioPeer.js.html#line118">line 118</a>
|
|
265
|
-
</li>
|
|
266
|
-
</ul>
|
|
267
|
-
</dd>
|
|
268
|
-
</dl>
|
|
269
|
-
</article>
|
|
270
|
-
</section>
|
|
271
|
-
</div>
|
|
272
|
-
|
|
273
|
-
<nav>
|
|
274
|
-
<h2><a href="index.html">Home</a></h2>
|
|
275
|
-
<h3>Classes</h3>
|
|
276
|
-
<ul>
|
|
277
|
-
<li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
|
|
278
|
-
<li><a href="AudioPeer.html">AudioPeer</a></li>
|
|
279
|
-
<li><a href="AudioRecorder.html">AudioRecorder</a></li>
|
|
280
|
-
<li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
|
|
281
|
-
<li><a href="Listener.html">Listener</a></li>
|
|
282
|
-
<li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
|
|
283
|
-
<li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
|
|
284
|
-
<li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
|
|
285
|
-
<li><a href="Speaker.html">Speaker</a></li>
|
|
286
|
-
<li><a href="Volume.html">Volume</a></li>
|
|
287
|
-
</ul>
|
|
288
|
-
<h3>Global</h3>
|
|
289
|
-
<ul>
|
|
290
|
-
<li><a href="global.html#csvToArray">csvToArray</a></li>
|
|
291
|
-
<li><a href="global.html#saveToCSV">saveToCSV</a></li>
|
|
292
|
-
<li><a href="global.html#sleep">sleep</a></li>
|
|
293
|
-
</ul>
|
|
294
|
-
</nav>
|
|
295
|
-
|
|
296
|
-
<br class="clear" />
|
|
297
|
-
|
|
298
|
-
<footer>
|
|
299
|
-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
|
|
300
|
-
Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
|
|
301
|
-
</footer>
|
|
302
|
-
|
|
303
|
-
<script>
|
|
304
|
-
prettyPrint();
|
|
305
|
-
</script>
|
|
306
|
-
<script src="scripts/linenumber.js"></script>
|
|
307
|
-
</body>
|
|
308
|
-
</html>
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8" />
|
|
5
|
+
<title>JSDoc: Class: Listener</title>
|
|
6
|
+
|
|
7
|
+
<script src="scripts/prettify/prettify.js"></script>
|
|
8
|
+
<script src="scripts/prettify/lang-css.js"></script>
|
|
9
|
+
<!--[if lt IE 9]>
|
|
10
|
+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
11
|
+
<![endif]-->
|
|
12
|
+
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css" />
|
|
13
|
+
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css" />
|
|
14
|
+
</head>
|
|
15
|
+
|
|
16
|
+
<body>
|
|
17
|
+
<div id="main">
|
|
18
|
+
<h1 class="page-title">Class: Listener</h1>
|
|
19
|
+
|
|
20
|
+
<section>
|
|
21
|
+
<header>
|
|
22
|
+
<h2>
|
|
23
|
+
<span class="attribs"><span class="type-signature"></span></span>Listener<span
|
|
24
|
+
class="signature"
|
|
25
|
+
>(params)</span
|
|
26
|
+
><span class="type-signature"></span>
|
|
27
|
+
</h2>
|
|
28
|
+
|
|
29
|
+
<div class="class-description">
|
|
30
|
+
Handles the listener's side of the connection. Responsible for getting access to user's
|
|
31
|
+
microphone, and initiating a call to the Speaker.
|
|
32
|
+
</div>
|
|
33
|
+
</header>
|
|
34
|
+
|
|
35
|
+
<article>
|
|
36
|
+
<div class="container-overview">
|
|
37
|
+
<h2>Constructor</h2>
|
|
38
|
+
|
|
39
|
+
<h4 class="name" id="Listener">
|
|
40
|
+
<span class="type-signature"></span>new Listener<span class="signature">(params)</span
|
|
41
|
+
><span class="type-signature"></span>
|
|
42
|
+
</h4>
|
|
43
|
+
|
|
44
|
+
<div class="description">
|
|
45
|
+
Takes a target element where html elements will be appended.
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
<h5>Parameters:</h5>
|
|
49
|
+
|
|
50
|
+
<table class="params">
|
|
51
|
+
<thead>
|
|
52
|
+
<tr>
|
|
53
|
+
<th>Name</th>
|
|
54
|
+
|
|
55
|
+
<th>Type</th>
|
|
56
|
+
|
|
57
|
+
<th class="last">Description</th>
|
|
58
|
+
</tr>
|
|
59
|
+
</thead>
|
|
60
|
+
|
|
61
|
+
<tbody>
|
|
62
|
+
<tr>
|
|
63
|
+
<td class="name"><code>params</code></td>
|
|
64
|
+
|
|
65
|
+
<td class="type">
|
|
66
|
+
<span class="param-type"
|
|
67
|
+
><a href="global.html#initParameters">initParameters</a></span
|
|
68
|
+
>
|
|
69
|
+
</td>
|
|
70
|
+
|
|
71
|
+
<td class="description last">see type definition for initParameters</td>
|
|
72
|
+
</tr>
|
|
73
|
+
</tbody>
|
|
74
|
+
</table>
|
|
75
|
+
|
|
76
|
+
<dl class="details">
|
|
77
|
+
<dt class="tag-source">Source:</dt>
|
|
78
|
+
<dd class="tag-source">
|
|
79
|
+
<ul class="dummy">
|
|
80
|
+
<li>
|
|
81
|
+
<a href="peer-connection_listener.js.html">peer-connection/listener.js</a>,
|
|
82
|
+
<a href="peer-connection_listener.js.html#line9">line 9</a>
|
|
83
|
+
</li>
|
|
84
|
+
</ul>
|
|
85
|
+
</dd>
|
|
86
|
+
</dl>
|
|
87
|
+
</div>
|
|
88
|
+
|
|
89
|
+
<h3 class="subsection-title">Extends</h3>
|
|
90
|
+
|
|
91
|
+
<ul>
|
|
92
|
+
<li><a href="AudioPeer.html">AudioPeer</a></li>
|
|
93
|
+
</ul>
|
|
94
|
+
|
|
95
|
+
<h3 class="subsection-title">Members</h3>
|
|
96
|
+
|
|
97
|
+
<h4 class="name" id="displayUpdate">
|
|
98
|
+
<span class="type-signature"></span>displayUpdate<span class="type-signature"></span>
|
|
99
|
+
</h4>
|
|
100
|
+
|
|
101
|
+
<div class="description">Helper method to display information to DOM element</div>
|
|
102
|
+
|
|
103
|
+
<dl class="details">
|
|
104
|
+
<dt class="tag-overrides">Overrides:</dt>
|
|
105
|
+
<dd class="tag-overrides">
|
|
106
|
+
<ul class="dummy">
|
|
107
|
+
<li>
|
|
108
|
+
<a href="AudioPeer.html#displayUpdate">AudioPeer#displayUpdate</a>
|
|
109
|
+
</li>
|
|
110
|
+
</ul>
|
|
111
|
+
</dd>
|
|
112
|
+
|
|
113
|
+
<dt class="tag-source">Source:</dt>
|
|
114
|
+
<dd class="tag-source">
|
|
115
|
+
<ul class="dummy">
|
|
116
|
+
<li>
|
|
117
|
+
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
118
|
+
<a href="peer-connection_audioPeer.js.html#line59">line 59</a>
|
|
119
|
+
</li>
|
|
120
|
+
</ul>
|
|
121
|
+
</dd>
|
|
122
|
+
</dl>
|
|
123
|
+
|
|
124
|
+
<h4 class="name" id="onPeerClose">
|
|
125
|
+
<span class="type-signature"></span>onPeerClose<span class="type-signature"></span>
|
|
126
|
+
</h4>
|
|
127
|
+
|
|
128
|
+
<div class="description">
|
|
129
|
+
Callback method that cleans up after peer connection is closed
|
|
130
|
+
</div>
|
|
131
|
+
|
|
132
|
+
<dl class="details">
|
|
133
|
+
<dt class="tag-overrides">Overrides:</dt>
|
|
134
|
+
<dd class="tag-overrides">
|
|
135
|
+
<ul class="dummy">
|
|
136
|
+
<li>
|
|
137
|
+
<a href="AudioPeer.html#onPeerClose">AudioPeer#onPeerClose</a>
|
|
138
|
+
</li>
|
|
139
|
+
</ul>
|
|
140
|
+
</dd>
|
|
141
|
+
|
|
142
|
+
<dt class="tag-source">Source:</dt>
|
|
143
|
+
<dd class="tag-source">
|
|
144
|
+
<ul class="dummy">
|
|
145
|
+
<li>
|
|
146
|
+
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
147
|
+
<a href="peer-connection_audioPeer.js.html#line90">line 90</a>
|
|
148
|
+
</li>
|
|
149
|
+
</ul>
|
|
150
|
+
</dd>
|
|
151
|
+
</dl>
|
|
152
|
+
|
|
153
|
+
<h4 class="name" id="onPeerDisconnected">
|
|
154
|
+
<span class="type-signature"></span>onPeerDisconnected<span
|
|
155
|
+
class="type-signature"
|
|
156
|
+
></span>
|
|
157
|
+
</h4>
|
|
158
|
+
|
|
159
|
+
<div class="description">
|
|
160
|
+
Callback method for when a peer connection is lost saves the last peer id, last server
|
|
161
|
+
id, and attempts to reconnect
|
|
162
|
+
</div>
|
|
163
|
+
|
|
164
|
+
<dl class="details">
|
|
165
|
+
<dt class="tag-overrides">Overrides:</dt>
|
|
166
|
+
<dd class="tag-overrides">
|
|
167
|
+
<ul class="dummy">
|
|
168
|
+
<li>
|
|
169
|
+
<a href="AudioPeer.html#onPeerDisconnected">AudioPeer#onPeerDisconnected</a>
|
|
170
|
+
</li>
|
|
171
|
+
</ul>
|
|
172
|
+
</dd>
|
|
173
|
+
|
|
174
|
+
<dt class="tag-source">Source:</dt>
|
|
175
|
+
<dd class="tag-source">
|
|
176
|
+
<ul class="dummy">
|
|
177
|
+
<li>
|
|
178
|
+
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
179
|
+
<a href="peer-connection_audioPeer.js.html#line77">line 77</a>
|
|
180
|
+
</li>
|
|
181
|
+
</ul>
|
|
182
|
+
</dd>
|
|
183
|
+
</dl>
|
|
184
|
+
|
|
185
|
+
<h4 class="name" id="onPeerError">
|
|
186
|
+
<span class="type-signature"></span>onPeerError<span class="type-signature"></span>
|
|
187
|
+
</h4>
|
|
188
|
+
|
|
189
|
+
<div class="description">Helper method for when an error occurs</div>
|
|
190
|
+
|
|
191
|
+
<dl class="details">
|
|
192
|
+
<dt class="tag-overrides">Overrides:</dt>
|
|
193
|
+
<dd class="tag-overrides">
|
|
194
|
+
<ul class="dummy">
|
|
195
|
+
<li>
|
|
196
|
+
<a href="AudioPeer.html#onPeerError">AudioPeer#onPeerError</a>
|
|
197
|
+
</li>
|
|
198
|
+
</ul>
|
|
199
|
+
</dd>
|
|
200
|
+
|
|
201
|
+
<dt class="tag-source">Source:</dt>
|
|
202
|
+
<dd class="tag-source">
|
|
203
|
+
<ul class="dummy">
|
|
204
|
+
<li>
|
|
205
|
+
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
206
|
+
<a href="peer-connection_audioPeer.js.html#line99">line 99</a>
|
|
207
|
+
</li>
|
|
208
|
+
</ul>
|
|
209
|
+
</dd>
|
|
210
|
+
</dl>
|
|
211
|
+
|
|
212
|
+
<h4 class="name" id="parseURLSearchParams">
|
|
213
|
+
<span class="type-signature"></span>parseURLSearchParams<span
|
|
214
|
+
class="type-signature"
|
|
215
|
+
></span>
|
|
216
|
+
</h4>
|
|
217
|
+
|
|
218
|
+
<div class="description">Helper method that converts url paramters to an object</div>
|
|
219
|
+
|
|
220
|
+
<dl class="details">
|
|
221
|
+
<dt class="tag-overrides">Overrides:</dt>
|
|
222
|
+
<dd class="tag-overrides">
|
|
223
|
+
<ul class="dummy">
|
|
224
|
+
<li>
|
|
225
|
+
<a href="AudioPeer.html#parseURLSearchParams">AudioPeer#parseURLSearchParams</a>
|
|
226
|
+
</li>
|
|
227
|
+
</ul>
|
|
228
|
+
</dd>
|
|
229
|
+
|
|
230
|
+
<dt class="tag-source">Source:</dt>
|
|
231
|
+
<dd class="tag-source">
|
|
232
|
+
<ul class="dummy">
|
|
233
|
+
<li>
|
|
234
|
+
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
235
|
+
<a href="peer-connection_audioPeer.js.html#line108">line 108</a>
|
|
236
|
+
</li>
|
|
237
|
+
</ul>
|
|
238
|
+
</dd>
|
|
239
|
+
</dl>
|
|
240
|
+
|
|
241
|
+
<h4 class="name" id="queryStringFromObject">
|
|
242
|
+
<span class="type-signature"></span>queryStringFromObject<span
|
|
243
|
+
class="type-signature"
|
|
244
|
+
></span>
|
|
245
|
+
</h4>
|
|
246
|
+
|
|
247
|
+
<div class="description">Helper method that converts an object to a query string</div>
|
|
248
|
+
|
|
249
|
+
<dl class="details">
|
|
250
|
+
<dt class="tag-overrides">Overrides:</dt>
|
|
251
|
+
<dd class="tag-overrides">
|
|
252
|
+
<ul class="dummy">
|
|
253
|
+
<li>
|
|
254
|
+
<a href="AudioPeer.html#queryStringFromObject">AudioPeer#queryStringFromObject</a>
|
|
255
|
+
</li>
|
|
256
|
+
</ul>
|
|
257
|
+
</dd>
|
|
258
|
+
|
|
259
|
+
<dt class="tag-source">Source:</dt>
|
|
260
|
+
<dd class="tag-source">
|
|
261
|
+
<ul class="dummy">
|
|
262
|
+
<li>
|
|
263
|
+
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
264
|
+
<a href="peer-connection_audioPeer.js.html#line118">line 118</a>
|
|
265
|
+
</li>
|
|
266
|
+
</ul>
|
|
267
|
+
</dd>
|
|
268
|
+
</dl>
|
|
269
|
+
</article>
|
|
270
|
+
</section>
|
|
271
|
+
</div>
|
|
272
|
+
|
|
273
|
+
<nav>
|
|
274
|
+
<h2><a href="index.html">Home</a></h2>
|
|
275
|
+
<h3>Classes</h3>
|
|
276
|
+
<ul>
|
|
277
|
+
<li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
|
|
278
|
+
<li><a href="AudioPeer.html">AudioPeer</a></li>
|
|
279
|
+
<li><a href="AudioRecorder.html">AudioRecorder</a></li>
|
|
280
|
+
<li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
|
|
281
|
+
<li><a href="Listener.html">Listener</a></li>
|
|
282
|
+
<li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
|
|
283
|
+
<li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
|
|
284
|
+
<li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
|
|
285
|
+
<li><a href="Speaker.html">Speaker</a></li>
|
|
286
|
+
<li><a href="Volume.html">Volume</a></li>
|
|
287
|
+
</ul>
|
|
288
|
+
<h3>Global</h3>
|
|
289
|
+
<ul>
|
|
290
|
+
<li><a href="global.html#csvToArray">csvToArray</a></li>
|
|
291
|
+
<li><a href="global.html#saveToCSV">saveToCSV</a></li>
|
|
292
|
+
<li><a href="global.html#sleep">sleep</a></li>
|
|
293
|
+
</ul>
|
|
294
|
+
</nav>
|
|
295
|
+
|
|
296
|
+
<br class="clear" />
|
|
297
|
+
|
|
298
|
+
<footer>
|
|
299
|
+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
|
|
300
|
+
Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
|
|
301
|
+
</footer>
|
|
302
|
+
|
|
303
|
+
<script>
|
|
304
|
+
prettyPrint();
|
|
305
|
+
</script>
|
|
306
|
+
<script src="scripts/linenumber.js"></script>
|
|
307
|
+
</body>
|
|
308
|
+
</html>
|