speaker-calibration 2.2.220 → 2.2.221
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/.gitignore +81 -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 -28914
- package/dist/example/index.html +47 -47
- package/dist/example/listener.html +81 -79
- 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 +4 -4
- 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/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 -344
- 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 +812 -810
- 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 -3167
- 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/.github/workflows/update-phrases.yml +0 -37
- package/makefile +0 -74
package/doc/Speaker.html
CHANGED
|
@@ -1,276 +1,276 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8" />
|
|
5
|
-
<title>JSDoc: Class: Speaker</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: Speaker</h1>
|
|
19
|
-
|
|
20
|
-
<section>
|
|
21
|
-
<header>
|
|
22
|
-
<h2>
|
|
23
|
-
<span class="attribs"><span class="type-signature"></span></span>Speaker<span
|
|
24
|
-
class="signature"
|
|
25
|
-
>(params, Calibrator)</span
|
|
26
|
-
><span class="type-signature"></span>
|
|
27
|
-
</h2>
|
|
28
|
-
|
|
29
|
-
<div class="class-description">
|
|
30
|
-
Handles the speaker's side of the connection. Responsible for initiating the connection,
|
|
31
|
-
rendering the QRCode, and answering the call.
|
|
32
|
-
</div>
|
|
33
|
-
</header>
|
|
34
|
-
|
|
35
|
-
<article>
|
|
36
|
-
<div class="container-overview">
|
|
37
|
-
<h2>Constructor</h2>
|
|
38
|
-
|
|
39
|
-
<h4 class="name" id="Speaker">
|
|
40
|
-
<span class="type-signature"></span>new Speaker<span class="signature"
|
|
41
|
-
>(params, Calibrator)</span
|
|
42
|
-
><span class="type-signature"></span>
|
|
43
|
-
</h4>
|
|
44
|
-
|
|
45
|
-
<div class="description">
|
|
46
|
-
Takes the url of the current site and a target element where html elements will be
|
|
47
|
-
appended.
|
|
48
|
-
</div>
|
|
49
|
-
|
|
50
|
-
<h5>Parameters:</h5>
|
|
51
|
-
|
|
52
|
-
<table class="params">
|
|
53
|
-
<thead>
|
|
54
|
-
<tr>
|
|
55
|
-
<th>Name</th>
|
|
56
|
-
|
|
57
|
-
<th>Type</th>
|
|
58
|
-
|
|
59
|
-
<th class="last">Description</th>
|
|
60
|
-
</tr>
|
|
61
|
-
</thead>
|
|
62
|
-
|
|
63
|
-
<tbody>
|
|
64
|
-
<tr>
|
|
65
|
-
<td class="name"><code>params</code></td>
|
|
66
|
-
|
|
67
|
-
<td class="type">
|
|
68
|
-
<span class="param-type"
|
|
69
|
-
><a href="global.html#initParameters">initParameters</a></span
|
|
70
|
-
>
|
|
71
|
-
</td>
|
|
72
|
-
|
|
73
|
-
<td class="description last">see type definition for initParameters</td>
|
|
74
|
-
</tr>
|
|
75
|
-
|
|
76
|
-
<tr>
|
|
77
|
-
<td class="name"><code>Calibrator</code></td>
|
|
78
|
-
|
|
79
|
-
<td class="type">
|
|
80
|
-
<span class="param-type"
|
|
81
|
-
><a href="AudioCalibrator.html">AudioCalibrator</a></span
|
|
82
|
-
>
|
|
83
|
-
</td>
|
|
84
|
-
|
|
85
|
-
<td class="description last">
|
|
86
|
-
An instance of the AudioCalibrator class, should not use AudioCalibrator
|
|
87
|
-
directly, instead use an extended class available in /tasks/
|
|
88
|
-
</td>
|
|
89
|
-
</tr>
|
|
90
|
-
</tbody>
|
|
91
|
-
</table>
|
|
92
|
-
|
|
93
|
-
<dl class="details">
|
|
94
|
-
<dt class="tag-source">Source:</dt>
|
|
95
|
-
<dd class="tag-source">
|
|
96
|
-
<ul class="dummy">
|
|
97
|
-
<li>
|
|
98
|
-
<a href="peer-connection_speaker.js.html">peer-connection/speaker.js</a>,
|
|
99
|
-
<a href="peer-connection_speaker.js.html#line15">line 15</a>
|
|
100
|
-
</li>
|
|
101
|
-
</ul>
|
|
102
|
-
</dd>
|
|
103
|
-
</dl>
|
|
104
|
-
</div>
|
|
105
|
-
|
|
106
|
-
<h3 class="subsection-title">Extends</h3>
|
|
107
|
-
|
|
108
|
-
<ul>
|
|
109
|
-
<li><a href="AudioPeer.html">AudioPeer</a></li>
|
|
110
|
-
</ul>
|
|
111
|
-
|
|
112
|
-
<h3 class="subsection-title">Members</h3>
|
|
113
|
-
|
|
114
|
-
<h4 class="name" id="displayUpdate">
|
|
115
|
-
<span class="type-signature"></span>displayUpdate<span class="type-signature"></span>
|
|
116
|
-
</h4>
|
|
117
|
-
|
|
118
|
-
<div class="description">Helper method to display information to DOM element</div>
|
|
119
|
-
|
|
120
|
-
<dl class="details">
|
|
121
|
-
<dt class="tag-overrides">Overrides:</dt>
|
|
122
|
-
<dd class="tag-overrides">
|
|
123
|
-
<ul class="dummy">
|
|
124
|
-
<li>
|
|
125
|
-
<a href="AudioPeer.html#displayUpdate">AudioPeer#displayUpdate</a>
|
|
126
|
-
</li>
|
|
127
|
-
</ul>
|
|
128
|
-
</dd>
|
|
129
|
-
|
|
130
|
-
<dt class="tag-source">Source:</dt>
|
|
131
|
-
<dd class="tag-source">
|
|
132
|
-
<ul class="dummy">
|
|
133
|
-
<li>
|
|
134
|
-
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
135
|
-
<a href="peer-connection_audioPeer.js.html#line59">line 59</a>
|
|
136
|
-
</li>
|
|
137
|
-
</ul>
|
|
138
|
-
</dd>
|
|
139
|
-
</dl>
|
|
140
|
-
|
|
141
|
-
<h4 class="name" id="downloadData">
|
|
142
|
-
<span class="type-signature"></span>downloadData<span class="type-signature"></span>
|
|
143
|
-
</h4>
|
|
144
|
-
|
|
145
|
-
<div class="description">Debug method for downloading the recorded audio</div>
|
|
146
|
-
|
|
147
|
-
<dl class="details">
|
|
148
|
-
<dt class="tag-source">Source:</dt>
|
|
149
|
-
<dd class="tag-source">
|
|
150
|
-
<ul class="dummy">
|
|
151
|
-
<li>
|
|
152
|
-
<a href="peer-connection_speaker.js.html">peer-connection/speaker.js</a>,
|
|
153
|
-
<a href="peer-connection_speaker.js.html#line307">line 307</a>
|
|
154
|
-
</li>
|
|
155
|
-
</ul>
|
|
156
|
-
</dd>
|
|
157
|
-
</dl>
|
|
158
|
-
|
|
159
|
-
<h4 class="name" id="parseURLSearchParams">
|
|
160
|
-
<span class="type-signature"></span>parseURLSearchParams<span
|
|
161
|
-
class="type-signature"
|
|
162
|
-
></span>
|
|
163
|
-
</h4>
|
|
164
|
-
|
|
165
|
-
<div class="description">Helper method that converts url paramters to an object</div>
|
|
166
|
-
|
|
167
|
-
<dl class="details">
|
|
168
|
-
<dt class="tag-overrides">Overrides:</dt>
|
|
169
|
-
<dd class="tag-overrides">
|
|
170
|
-
<ul class="dummy">
|
|
171
|
-
<li>
|
|
172
|
-
<a href="AudioPeer.html#parseURLSearchParams">AudioPeer#parseURLSearchParams</a>
|
|
173
|
-
</li>
|
|
174
|
-
</ul>
|
|
175
|
-
</dd>
|
|
176
|
-
|
|
177
|
-
<dt class="tag-source">Source:</dt>
|
|
178
|
-
<dd class="tag-source">
|
|
179
|
-
<ul class="dummy">
|
|
180
|
-
<li>
|
|
181
|
-
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
182
|
-
<a href="peer-connection_audioPeer.js.html#line108">line 108</a>
|
|
183
|
-
</li>
|
|
184
|
-
</ul>
|
|
185
|
-
</dd>
|
|
186
|
-
</dl>
|
|
187
|
-
|
|
188
|
-
<h4 class="name" id="queryStringFromObject">
|
|
189
|
-
<span class="type-signature"></span>queryStringFromObject<span
|
|
190
|
-
class="type-signature"
|
|
191
|
-
></span>
|
|
192
|
-
</h4>
|
|
193
|
-
|
|
194
|
-
<div class="description">Helper method that converts an object to a query string</div>
|
|
195
|
-
|
|
196
|
-
<dl class="details">
|
|
197
|
-
<dt class="tag-overrides">Overrides:</dt>
|
|
198
|
-
<dd class="tag-overrides">
|
|
199
|
-
<ul class="dummy">
|
|
200
|
-
<li>
|
|
201
|
-
<a href="AudioPeer.html#queryStringFromObject">AudioPeer#queryStringFromObject</a>
|
|
202
|
-
</li>
|
|
203
|
-
</ul>
|
|
204
|
-
</dd>
|
|
205
|
-
|
|
206
|
-
<dt class="tag-source">Source:</dt>
|
|
207
|
-
<dd class="tag-source">
|
|
208
|
-
<ul class="dummy">
|
|
209
|
-
<li>
|
|
210
|
-
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
211
|
-
<a href="peer-connection_audioPeer.js.html#line118">line 118</a>
|
|
212
|
-
</li>
|
|
213
|
-
</ul>
|
|
214
|
-
</dd>
|
|
215
|
-
</dl>
|
|
216
|
-
|
|
217
|
-
<h4 class="name" id="startCalibration">
|
|
218
|
-
<span class="type-signature"></span>startCalibration<span class="type-signature"></span>
|
|
219
|
-
</h4>
|
|
220
|
-
|
|
221
|
-
<div class="description">
|
|
222
|
-
Async factory method that creates the Speaker object, and returns a promise that
|
|
223
|
-
resolves to the result of the calibration.
|
|
224
|
-
</div>
|
|
225
|
-
|
|
226
|
-
<dl class="details">
|
|
227
|
-
<dt class="tag-source">Source:</dt>
|
|
228
|
-
<dd class="tag-source">
|
|
229
|
-
<ul class="dummy">
|
|
230
|
-
<li>
|
|
231
|
-
<a href="peer-connection_speaker.js.html">peer-connection/speaker.js</a>,
|
|
232
|
-
<a href="peer-connection_speaker.js.html#line43">line 43</a>
|
|
233
|
-
</li>
|
|
234
|
-
</ul>
|
|
235
|
-
</dd>
|
|
236
|
-
</dl>
|
|
237
|
-
</article>
|
|
238
|
-
</section>
|
|
239
|
-
</div>
|
|
240
|
-
|
|
241
|
-
<nav>
|
|
242
|
-
<h2><a href="index.html">Home</a></h2>
|
|
243
|
-
<h3>Classes</h3>
|
|
244
|
-
<ul>
|
|
245
|
-
<li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
|
|
246
|
-
<li><a href="AudioPeer.html">AudioPeer</a></li>
|
|
247
|
-
<li><a href="AudioRecorder.html">AudioRecorder</a></li>
|
|
248
|
-
<li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
|
|
249
|
-
<li><a href="Listener.html">Listener</a></li>
|
|
250
|
-
<li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
|
|
251
|
-
<li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
|
|
252
|
-
<li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
|
|
253
|
-
<li><a href="Speaker.html">Speaker</a></li>
|
|
254
|
-
<li><a href="Volume.html">Volume</a></li>
|
|
255
|
-
</ul>
|
|
256
|
-
<h3>Global</h3>
|
|
257
|
-
<ul>
|
|
258
|
-
<li><a href="global.html#csvToArray">csvToArray</a></li>
|
|
259
|
-
<li><a href="global.html#saveToCSV">saveToCSV</a></li>
|
|
260
|
-
<li><a href="global.html#sleep">sleep</a></li>
|
|
261
|
-
</ul>
|
|
262
|
-
</nav>
|
|
263
|
-
|
|
264
|
-
<br class="clear" />
|
|
265
|
-
|
|
266
|
-
<footer>
|
|
267
|
-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
|
|
268
|
-
Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
|
|
269
|
-
</footer>
|
|
270
|
-
|
|
271
|
-
<script>
|
|
272
|
-
prettyPrint();
|
|
273
|
-
</script>
|
|
274
|
-
<script src="scripts/linenumber.js"></script>
|
|
275
|
-
</body>
|
|
276
|
-
</html>
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8" />
|
|
5
|
+
<title>JSDoc: Class: Speaker</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: Speaker</h1>
|
|
19
|
+
|
|
20
|
+
<section>
|
|
21
|
+
<header>
|
|
22
|
+
<h2>
|
|
23
|
+
<span class="attribs"><span class="type-signature"></span></span>Speaker<span
|
|
24
|
+
class="signature"
|
|
25
|
+
>(params, Calibrator)</span
|
|
26
|
+
><span class="type-signature"></span>
|
|
27
|
+
</h2>
|
|
28
|
+
|
|
29
|
+
<div class="class-description">
|
|
30
|
+
Handles the speaker's side of the connection. Responsible for initiating the connection,
|
|
31
|
+
rendering the QRCode, and answering the call.
|
|
32
|
+
</div>
|
|
33
|
+
</header>
|
|
34
|
+
|
|
35
|
+
<article>
|
|
36
|
+
<div class="container-overview">
|
|
37
|
+
<h2>Constructor</h2>
|
|
38
|
+
|
|
39
|
+
<h4 class="name" id="Speaker">
|
|
40
|
+
<span class="type-signature"></span>new Speaker<span class="signature"
|
|
41
|
+
>(params, Calibrator)</span
|
|
42
|
+
><span class="type-signature"></span>
|
|
43
|
+
</h4>
|
|
44
|
+
|
|
45
|
+
<div class="description">
|
|
46
|
+
Takes the url of the current site and a target element where html elements will be
|
|
47
|
+
appended.
|
|
48
|
+
</div>
|
|
49
|
+
|
|
50
|
+
<h5>Parameters:</h5>
|
|
51
|
+
|
|
52
|
+
<table class="params">
|
|
53
|
+
<thead>
|
|
54
|
+
<tr>
|
|
55
|
+
<th>Name</th>
|
|
56
|
+
|
|
57
|
+
<th>Type</th>
|
|
58
|
+
|
|
59
|
+
<th class="last">Description</th>
|
|
60
|
+
</tr>
|
|
61
|
+
</thead>
|
|
62
|
+
|
|
63
|
+
<tbody>
|
|
64
|
+
<tr>
|
|
65
|
+
<td class="name"><code>params</code></td>
|
|
66
|
+
|
|
67
|
+
<td class="type">
|
|
68
|
+
<span class="param-type"
|
|
69
|
+
><a href="global.html#initParameters">initParameters</a></span
|
|
70
|
+
>
|
|
71
|
+
</td>
|
|
72
|
+
|
|
73
|
+
<td class="description last">see type definition for initParameters</td>
|
|
74
|
+
</tr>
|
|
75
|
+
|
|
76
|
+
<tr>
|
|
77
|
+
<td class="name"><code>Calibrator</code></td>
|
|
78
|
+
|
|
79
|
+
<td class="type">
|
|
80
|
+
<span class="param-type"
|
|
81
|
+
><a href="AudioCalibrator.html">AudioCalibrator</a></span
|
|
82
|
+
>
|
|
83
|
+
</td>
|
|
84
|
+
|
|
85
|
+
<td class="description last">
|
|
86
|
+
An instance of the AudioCalibrator class, should not use AudioCalibrator
|
|
87
|
+
directly, instead use an extended class available in /tasks/
|
|
88
|
+
</td>
|
|
89
|
+
</tr>
|
|
90
|
+
</tbody>
|
|
91
|
+
</table>
|
|
92
|
+
|
|
93
|
+
<dl class="details">
|
|
94
|
+
<dt class="tag-source">Source:</dt>
|
|
95
|
+
<dd class="tag-source">
|
|
96
|
+
<ul class="dummy">
|
|
97
|
+
<li>
|
|
98
|
+
<a href="peer-connection_speaker.js.html">peer-connection/speaker.js</a>,
|
|
99
|
+
<a href="peer-connection_speaker.js.html#line15">line 15</a>
|
|
100
|
+
</li>
|
|
101
|
+
</ul>
|
|
102
|
+
</dd>
|
|
103
|
+
</dl>
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
<h3 class="subsection-title">Extends</h3>
|
|
107
|
+
|
|
108
|
+
<ul>
|
|
109
|
+
<li><a href="AudioPeer.html">AudioPeer</a></li>
|
|
110
|
+
</ul>
|
|
111
|
+
|
|
112
|
+
<h3 class="subsection-title">Members</h3>
|
|
113
|
+
|
|
114
|
+
<h4 class="name" id="displayUpdate">
|
|
115
|
+
<span class="type-signature"></span>displayUpdate<span class="type-signature"></span>
|
|
116
|
+
</h4>
|
|
117
|
+
|
|
118
|
+
<div class="description">Helper method to display information to DOM element</div>
|
|
119
|
+
|
|
120
|
+
<dl class="details">
|
|
121
|
+
<dt class="tag-overrides">Overrides:</dt>
|
|
122
|
+
<dd class="tag-overrides">
|
|
123
|
+
<ul class="dummy">
|
|
124
|
+
<li>
|
|
125
|
+
<a href="AudioPeer.html#displayUpdate">AudioPeer#displayUpdate</a>
|
|
126
|
+
</li>
|
|
127
|
+
</ul>
|
|
128
|
+
</dd>
|
|
129
|
+
|
|
130
|
+
<dt class="tag-source">Source:</dt>
|
|
131
|
+
<dd class="tag-source">
|
|
132
|
+
<ul class="dummy">
|
|
133
|
+
<li>
|
|
134
|
+
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
135
|
+
<a href="peer-connection_audioPeer.js.html#line59">line 59</a>
|
|
136
|
+
</li>
|
|
137
|
+
</ul>
|
|
138
|
+
</dd>
|
|
139
|
+
</dl>
|
|
140
|
+
|
|
141
|
+
<h4 class="name" id="downloadData">
|
|
142
|
+
<span class="type-signature"></span>downloadData<span class="type-signature"></span>
|
|
143
|
+
</h4>
|
|
144
|
+
|
|
145
|
+
<div class="description">Debug method for downloading the recorded audio</div>
|
|
146
|
+
|
|
147
|
+
<dl class="details">
|
|
148
|
+
<dt class="tag-source">Source:</dt>
|
|
149
|
+
<dd class="tag-source">
|
|
150
|
+
<ul class="dummy">
|
|
151
|
+
<li>
|
|
152
|
+
<a href="peer-connection_speaker.js.html">peer-connection/speaker.js</a>,
|
|
153
|
+
<a href="peer-connection_speaker.js.html#line307">line 307</a>
|
|
154
|
+
</li>
|
|
155
|
+
</ul>
|
|
156
|
+
</dd>
|
|
157
|
+
</dl>
|
|
158
|
+
|
|
159
|
+
<h4 class="name" id="parseURLSearchParams">
|
|
160
|
+
<span class="type-signature"></span>parseURLSearchParams<span
|
|
161
|
+
class="type-signature"
|
|
162
|
+
></span>
|
|
163
|
+
</h4>
|
|
164
|
+
|
|
165
|
+
<div class="description">Helper method that converts url paramters to an object</div>
|
|
166
|
+
|
|
167
|
+
<dl class="details">
|
|
168
|
+
<dt class="tag-overrides">Overrides:</dt>
|
|
169
|
+
<dd class="tag-overrides">
|
|
170
|
+
<ul class="dummy">
|
|
171
|
+
<li>
|
|
172
|
+
<a href="AudioPeer.html#parseURLSearchParams">AudioPeer#parseURLSearchParams</a>
|
|
173
|
+
</li>
|
|
174
|
+
</ul>
|
|
175
|
+
</dd>
|
|
176
|
+
|
|
177
|
+
<dt class="tag-source">Source:</dt>
|
|
178
|
+
<dd class="tag-source">
|
|
179
|
+
<ul class="dummy">
|
|
180
|
+
<li>
|
|
181
|
+
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
182
|
+
<a href="peer-connection_audioPeer.js.html#line108">line 108</a>
|
|
183
|
+
</li>
|
|
184
|
+
</ul>
|
|
185
|
+
</dd>
|
|
186
|
+
</dl>
|
|
187
|
+
|
|
188
|
+
<h4 class="name" id="queryStringFromObject">
|
|
189
|
+
<span class="type-signature"></span>queryStringFromObject<span
|
|
190
|
+
class="type-signature"
|
|
191
|
+
></span>
|
|
192
|
+
</h4>
|
|
193
|
+
|
|
194
|
+
<div class="description">Helper method that converts an object to a query string</div>
|
|
195
|
+
|
|
196
|
+
<dl class="details">
|
|
197
|
+
<dt class="tag-overrides">Overrides:</dt>
|
|
198
|
+
<dd class="tag-overrides">
|
|
199
|
+
<ul class="dummy">
|
|
200
|
+
<li>
|
|
201
|
+
<a href="AudioPeer.html#queryStringFromObject">AudioPeer#queryStringFromObject</a>
|
|
202
|
+
</li>
|
|
203
|
+
</ul>
|
|
204
|
+
</dd>
|
|
205
|
+
|
|
206
|
+
<dt class="tag-source">Source:</dt>
|
|
207
|
+
<dd class="tag-source">
|
|
208
|
+
<ul class="dummy">
|
|
209
|
+
<li>
|
|
210
|
+
<a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
|
|
211
|
+
<a href="peer-connection_audioPeer.js.html#line118">line 118</a>
|
|
212
|
+
</li>
|
|
213
|
+
</ul>
|
|
214
|
+
</dd>
|
|
215
|
+
</dl>
|
|
216
|
+
|
|
217
|
+
<h4 class="name" id="startCalibration">
|
|
218
|
+
<span class="type-signature"></span>startCalibration<span class="type-signature"></span>
|
|
219
|
+
</h4>
|
|
220
|
+
|
|
221
|
+
<div class="description">
|
|
222
|
+
Async factory method that creates the Speaker object, and returns a promise that
|
|
223
|
+
resolves to the result of the calibration.
|
|
224
|
+
</div>
|
|
225
|
+
|
|
226
|
+
<dl class="details">
|
|
227
|
+
<dt class="tag-source">Source:</dt>
|
|
228
|
+
<dd class="tag-source">
|
|
229
|
+
<ul class="dummy">
|
|
230
|
+
<li>
|
|
231
|
+
<a href="peer-connection_speaker.js.html">peer-connection/speaker.js</a>,
|
|
232
|
+
<a href="peer-connection_speaker.js.html#line43">line 43</a>
|
|
233
|
+
</li>
|
|
234
|
+
</ul>
|
|
235
|
+
</dd>
|
|
236
|
+
</dl>
|
|
237
|
+
</article>
|
|
238
|
+
</section>
|
|
239
|
+
</div>
|
|
240
|
+
|
|
241
|
+
<nav>
|
|
242
|
+
<h2><a href="index.html">Home</a></h2>
|
|
243
|
+
<h3>Classes</h3>
|
|
244
|
+
<ul>
|
|
245
|
+
<li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
|
|
246
|
+
<li><a href="AudioPeer.html">AudioPeer</a></li>
|
|
247
|
+
<li><a href="AudioRecorder.html">AudioRecorder</a></li>
|
|
248
|
+
<li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
|
|
249
|
+
<li><a href="Listener.html">Listener</a></li>
|
|
250
|
+
<li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
|
|
251
|
+
<li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
|
|
252
|
+
<li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
|
|
253
|
+
<li><a href="Speaker.html">Speaker</a></li>
|
|
254
|
+
<li><a href="Volume.html">Volume</a></li>
|
|
255
|
+
</ul>
|
|
256
|
+
<h3>Global</h3>
|
|
257
|
+
<ul>
|
|
258
|
+
<li><a href="global.html#csvToArray">csvToArray</a></li>
|
|
259
|
+
<li><a href="global.html#saveToCSV">saveToCSV</a></li>
|
|
260
|
+
<li><a href="global.html#sleep">sleep</a></li>
|
|
261
|
+
</ul>
|
|
262
|
+
</nav>
|
|
263
|
+
|
|
264
|
+
<br class="clear" />
|
|
265
|
+
|
|
266
|
+
<footer>
|
|
267
|
+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
|
|
268
|
+
Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
|
|
269
|
+
</footer>
|
|
270
|
+
|
|
271
|
+
<script>
|
|
272
|
+
prettyPrint();
|
|
273
|
+
</script>
|
|
274
|
+
<script src="scripts/linenumber.js"></script>
|
|
275
|
+
</body>
|
|
276
|
+
</html>
|