speaker-calibration 2.0.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintignore +72 -0
- package/.eslintrc.json +40 -0
- package/.gitignore +78 -0
- package/.prettierignore +70 -0
- package/.prettierrc +15 -0
- package/LICENSE +20 -20
- package/README.md +133 -133
- package/__mocks__/fileMock.js +1 -0
- package/__mocks__/styleMock.js +1 -0
- package/babel.config.js +3 -0
- package/coverage/clover.xml +71 -0
- package/coverage/coverage-final.json +224 -0
- package/coverage/lcov-report/PythonServerInterface.js.html +265 -0
- package/coverage/lcov-report/base.css +354 -0
- package/coverage/lcov-report/block-navigation.js +82 -0
- package/coverage/lcov-report/favicon.png +0 -0
- package/coverage/lcov-report/index.html +123 -0
- package/coverage/lcov-report/prettify.css +101 -0
- package/coverage/lcov-report/prettify.js +937 -0
- package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
- package/coverage/lcov-report/sorter.js +189 -0
- package/coverage/lcov-report/src/index.html +121 -0
- package/coverage/lcov-report/src/server/PythonServerInterface.js.html +268 -0
- package/coverage/lcov-report/src/server/index.html +123 -0
- package/coverage/lcov-report/src/tasks/audioCalibrator.js.html +499 -0
- package/coverage/lcov-report/src/tasks/audioRecorder.js.html +412 -0
- package/coverage/lcov-report/src/tasks/index.html +143 -0
- package/coverage/lcov-report/src/tasks/volume/index.html +123 -0
- package/coverage/lcov-report/src/tasks/volume/volume.js.html +409 -0
- package/coverage/lcov-report/src/utils.js.html +172 -0
- package/coverage/lcov.info +91 -0
- package/dist/example/Queen-Bohemian_Rhapsody.wav +0 -0
- package/dist/example/Queen-Bohemian_Rhapsody_g_filtered.wav +0 -0
- package/dist/example/index.html +47 -0
- package/dist/example/listener.html +89 -0
- package/dist/example/server.js +49 -0
- package/dist/example/speaker.html +126 -0
- package/dist/example/speakerUI.js +217 -0
- package/dist/example/styles.css +40 -0
- package/dist/main.js +1 -1
- package/dist/mlsGen.js +6814 -6814
- package/dist/mlsGen.wasm +0 -0
- package/doc/AudioCalibrator.html +417 -0
- package/doc/AudioPeer.html +251 -0
- package/doc/AudioRecorder.html +195 -0
- package/doc/ImpulseResponse.html +215 -0
- package/doc/Listener.html +308 -0
- package/doc/MlsGenInterface.html +226 -0
- package/doc/MyEventEmitter.html +274 -0
- package/doc/PythonServerAPI.html +109 -0
- package/doc/Speaker-Calibration-UML-Diagram.png +0 -0
- package/doc/Speaker.html +276 -0
- package/doc/Takes%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +128 -0
- package/doc/Takes%20the%20url%20of%20the%20current%20site%0Aand%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +138 -0
- package/doc/Takes%20the%20url%20of%20the%20current%20site%20and%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +137 -0
- package/doc/Volume.html +88 -0
- package/doc/audioCalibrator.js.html +179 -0
- package/doc/audioPeer.js.html +175 -0
- package/doc/audioRecorder.js.html +163 -0
- package/doc/creates%20a%20new%20AudioRecorder%20instance.%20%0ASets%20up%20the%20audio%20context%20and%20file%20reader..html +114 -0
- package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
- package/doc/fonts/OpenSans-Bold-webfont.svg +1830 -0
- package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
- package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
- package/doc/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
- package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
- package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
- package/doc/fonts/OpenSans-Italic-webfont.svg +1830 -0
- package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
- package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
- package/doc/fonts/OpenSans-Light-webfont.svg +1831 -0
- package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
- package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
- package/doc/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
- package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
- package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
- package/doc/fonts/OpenSans-Regular-webfont.svg +1831 -0
- package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
- package/doc/global.html +308 -0
- package/doc/index.html +58 -0
- package/doc/listener.js.html +170 -0
- package/doc/mlsGen_mlsGenInterface.js.html +117 -0
- package/doc/myEventEmitter.js.html +124 -0
- package/doc/peer-connection_audioPeer.js.html +188 -0
- package/doc/peer-connection_listener.js.html +311 -0
- package/doc/peer-connection_speaker.js.html +381 -0
- package/doc/sc-activity-diagram.png +0 -0
- package/doc/scripts/linenumber.js +25 -0
- package/doc/scripts/prettify/Apache-License-2.0.txt +202 -0
- package/doc/scripts/prettify/lang-css.js +24 -0
- package/doc/scripts/prettify/prettify.js +640 -0
- package/doc/server_PythonServerAPI.js.html +160 -0
- package/doc/speaker.js.html +248 -0
- package/doc/styles/jsdoc-default.css +371 -0
- package/doc/styles/prettify-jsdoc.css +111 -0
- package/doc/styles/prettify-tomorrow.css +163 -0
- package/doc/tasks_audioCalibrator.js.html +207 -0
- package/doc/tasks_audioRecorder.js.html +190 -0
- package/doc/tasks_impulse-response_impulseResponse.js.html +442 -0
- package/doc/tasks_impulse-response_mlsGen_mlsGenInterface.js.html +175 -0
- package/doc/tasks_volume_volume.js.html +185 -0
- package/doc/utils.js.html +105 -0
- package/jest.config.js +173 -0
- package/netlify.toml +27 -0
- package/package.json +67 -66
- package/src/index.html +21 -0
- package/src/main.js +21 -0
- package/src/myEventEmitter.js +83 -0
- package/src/peer-connection/audioPeer.js +151 -0
- package/src/peer-connection/listener.js +251 -0
- package/src/peer-connection/peerErrors.js +25 -0
- package/src/peer-connection/speaker.js +346 -0
- package/src/server/PythonServerAPI.js +117 -0
- package/src/tasks/audioCalibrator.js +218 -0
- package/src/tasks/audioRecorder.js +148 -0
- package/src/tasks/impulse-response/impulseResponse.js +436 -0
- package/src/tasks/impulse-response/mlsGen/mlsGen.cpp +99 -0
- package/src/tasks/impulse-response/mlsGen/mlsGen.hpp +304 -0
- package/src/tasks/impulse-response/mlsGen/mlsGenInterface.js +131 -0
- package/src/tasks/impulse-response/mlsGen/mlsGenTest.cpp +181 -0
- package/src/tasks/volume/volume.cpp +3 -0
- package/src/tasks/volume/volume.hpp +23 -0
- package/src/tasks/volume/volume.js +157 -0
- package/src/utils.js +55 -0
- package/webpack.config.js +37 -0
- package/README +0 -3
|
@@ -0,0 +1,274 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8" />
|
|
5
|
+
<title>JSDoc: Class: MyEventEmitter</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: MyEventEmitter</h1>
|
|
19
|
+
|
|
20
|
+
<section>
|
|
21
|
+
<header>
|
|
22
|
+
<h2>
|
|
23
|
+
<span class="attribs"><span class="type-signature"></span></span>MyEventEmitter<span
|
|
24
|
+
class="signature"
|
|
25
|
+
>()</span
|
|
26
|
+
><span class="type-signature"></span>
|
|
27
|
+
</h2>
|
|
28
|
+
|
|
29
|
+
<div class="class-description">
|
|
30
|
+
A simple event emitter class. Objects that inheret this class or implement it can then
|
|
31
|
+
bubble events up to the UI similar to existings event emitter such as 'onChange' or
|
|
32
|
+
'onClick'
|
|
33
|
+
</div>
|
|
34
|
+
</header>
|
|
35
|
+
|
|
36
|
+
<article>
|
|
37
|
+
<div class="container-overview">
|
|
38
|
+
<h2>Constructor</h2>
|
|
39
|
+
|
|
40
|
+
<h4 class="name" id="MyEventEmitter">
|
|
41
|
+
<span class="type-signature"></span>new MyEventEmitter<span class="signature">()</span
|
|
42
|
+
><span class="type-signature"></span>
|
|
43
|
+
</h4>
|
|
44
|
+
|
|
45
|
+
<div class="description">
|
|
46
|
+
Default constructor, intializes an empty object to store events
|
|
47
|
+
</div>
|
|
48
|
+
|
|
49
|
+
<dl class="details">
|
|
50
|
+
<dt class="tag-source">Source:</dt>
|
|
51
|
+
<dd class="tag-source">
|
|
52
|
+
<ul class="dummy">
|
|
53
|
+
<li>
|
|
54
|
+
<a href="myEventEmitter.js.html">myEventEmitter.js</a>,
|
|
55
|
+
<a href="myEventEmitter.js.html#line5">line 5</a>
|
|
56
|
+
</li>
|
|
57
|
+
</ul>
|
|
58
|
+
</dd>
|
|
59
|
+
</dl>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<h3 class="subsection-title">Methods</h3>
|
|
63
|
+
|
|
64
|
+
<h4 class="name" id="emit">
|
|
65
|
+
<span class="type-signature"></span>emit<span class="signature">(name, data)</span
|
|
66
|
+
><span class="type-signature"></span>
|
|
67
|
+
</h4>
|
|
68
|
+
|
|
69
|
+
<div class="description">
|
|
70
|
+
The internal API for this class. Gets called with an event name and a data object. Any
|
|
71
|
+
callbacks that have been set to listen to the matching event are dispatched.
|
|
72
|
+
</div>
|
|
73
|
+
|
|
74
|
+
<h5>Parameters:</h5>
|
|
75
|
+
|
|
76
|
+
<table class="params">
|
|
77
|
+
<thead>
|
|
78
|
+
<tr>
|
|
79
|
+
<th>Name</th>
|
|
80
|
+
|
|
81
|
+
<th>Type</th>
|
|
82
|
+
|
|
83
|
+
<th class="last">Description</th>
|
|
84
|
+
</tr>
|
|
85
|
+
</thead>
|
|
86
|
+
|
|
87
|
+
<tbody>
|
|
88
|
+
<tr>
|
|
89
|
+
<td class="name"><code>name</code></td>
|
|
90
|
+
|
|
91
|
+
<td class="type">
|
|
92
|
+
<span class="param-type">*</span>
|
|
93
|
+
</td>
|
|
94
|
+
|
|
95
|
+
<td class="description last"></td>
|
|
96
|
+
</tr>
|
|
97
|
+
|
|
98
|
+
<tr>
|
|
99
|
+
<td class="name"><code>data</code></td>
|
|
100
|
+
|
|
101
|
+
<td class="type">
|
|
102
|
+
<span class="param-type">*</span>
|
|
103
|
+
</td>
|
|
104
|
+
|
|
105
|
+
<td class="description last"></td>
|
|
106
|
+
</tr>
|
|
107
|
+
</tbody>
|
|
108
|
+
</table>
|
|
109
|
+
|
|
110
|
+
<dl class="details">
|
|
111
|
+
<dt class="tag-source">Source:</dt>
|
|
112
|
+
<dd class="tag-source">
|
|
113
|
+
<ul class="dummy">
|
|
114
|
+
<li>
|
|
115
|
+
<a href="myEventEmitter.js.html">myEventEmitter.js</a>,
|
|
116
|
+
<a href="myEventEmitter.js.html#line49">line 49</a>
|
|
117
|
+
</li>
|
|
118
|
+
</ul>
|
|
119
|
+
</dd>
|
|
120
|
+
</dl>
|
|
121
|
+
|
|
122
|
+
<h4 class="name" id="on">
|
|
123
|
+
<span class="type-signature"></span>on<span class="signature">(name, listener)</span
|
|
124
|
+
><span class="type-signature"></span>
|
|
125
|
+
</h4>
|
|
126
|
+
|
|
127
|
+
<div class="description">
|
|
128
|
+
The external API for this class. Gets called with an event name and a callback function
|
|
129
|
+
that is fired when the event is emitted.
|
|
130
|
+
</div>
|
|
131
|
+
|
|
132
|
+
<h5>Parameters:</h5>
|
|
133
|
+
|
|
134
|
+
<table class="params">
|
|
135
|
+
<thead>
|
|
136
|
+
<tr>
|
|
137
|
+
<th>Name</th>
|
|
138
|
+
|
|
139
|
+
<th>Type</th>
|
|
140
|
+
|
|
141
|
+
<th class="last">Description</th>
|
|
142
|
+
</tr>
|
|
143
|
+
</thead>
|
|
144
|
+
|
|
145
|
+
<tbody>
|
|
146
|
+
<tr>
|
|
147
|
+
<td class="name"><code>name</code></td>
|
|
148
|
+
|
|
149
|
+
<td class="type">
|
|
150
|
+
<span class="param-type">*</span>
|
|
151
|
+
</td>
|
|
152
|
+
|
|
153
|
+
<td class="description last"></td>
|
|
154
|
+
</tr>
|
|
155
|
+
|
|
156
|
+
<tr>
|
|
157
|
+
<td class="name"><code>listener</code></td>
|
|
158
|
+
|
|
159
|
+
<td class="type">
|
|
160
|
+
<span class="param-type">*</span>
|
|
161
|
+
</td>
|
|
162
|
+
|
|
163
|
+
<td class="description last"></td>
|
|
164
|
+
</tr>
|
|
165
|
+
</tbody>
|
|
166
|
+
</table>
|
|
167
|
+
|
|
168
|
+
<dl class="details">
|
|
169
|
+
<dt class="tag-source">Source:</dt>
|
|
170
|
+
<dd class="tag-source">
|
|
171
|
+
<ul class="dummy">
|
|
172
|
+
<li>
|
|
173
|
+
<a href="myEventEmitter.js.html">myEventEmitter.js</a>,
|
|
174
|
+
<a href="myEventEmitter.js.html#line20">line 20</a>
|
|
175
|
+
</li>
|
|
176
|
+
</ul>
|
|
177
|
+
</dd>
|
|
178
|
+
</dl>
|
|
179
|
+
|
|
180
|
+
<h4 class="name" id="removeListener">
|
|
181
|
+
<span class="type-signature"></span>removeListener<span class="signature"
|
|
182
|
+
>(name, listenerToRemove)</span
|
|
183
|
+
><span class="type-signature"></span>
|
|
184
|
+
</h4>
|
|
185
|
+
|
|
186
|
+
<div class="description">Function to remove a listener that was previously set</div>
|
|
187
|
+
|
|
188
|
+
<h5>Parameters:</h5>
|
|
189
|
+
|
|
190
|
+
<table class="params">
|
|
191
|
+
<thead>
|
|
192
|
+
<tr>
|
|
193
|
+
<th>Name</th>
|
|
194
|
+
|
|
195
|
+
<th>Type</th>
|
|
196
|
+
|
|
197
|
+
<th class="last">Description</th>
|
|
198
|
+
</tr>
|
|
199
|
+
</thead>
|
|
200
|
+
|
|
201
|
+
<tbody>
|
|
202
|
+
<tr>
|
|
203
|
+
<td class="name"><code>name</code></td>
|
|
204
|
+
|
|
205
|
+
<td class="type">
|
|
206
|
+
<span class="param-type">*</span>
|
|
207
|
+
</td>
|
|
208
|
+
|
|
209
|
+
<td class="description last"></td>
|
|
210
|
+
</tr>
|
|
211
|
+
|
|
212
|
+
<tr>
|
|
213
|
+
<td class="name"><code>listenerToRemove</code></td>
|
|
214
|
+
|
|
215
|
+
<td class="type">
|
|
216
|
+
<span class="param-type">*</span>
|
|
217
|
+
</td>
|
|
218
|
+
|
|
219
|
+
<td class="description last"></td>
|
|
220
|
+
</tr>
|
|
221
|
+
</tbody>
|
|
222
|
+
</table>
|
|
223
|
+
|
|
224
|
+
<dl class="details">
|
|
225
|
+
<dt class="tag-source">Source:</dt>
|
|
226
|
+
<dd class="tag-source">
|
|
227
|
+
<ul class="dummy">
|
|
228
|
+
<li>
|
|
229
|
+
<a href="myEventEmitter.js.html">myEventEmitter.js</a>,
|
|
230
|
+
<a href="myEventEmitter.js.html#line33">line 33</a>
|
|
231
|
+
</li>
|
|
232
|
+
</ul>
|
|
233
|
+
</dd>
|
|
234
|
+
</dl>
|
|
235
|
+
</article>
|
|
236
|
+
</section>
|
|
237
|
+
</div>
|
|
238
|
+
|
|
239
|
+
<nav>
|
|
240
|
+
<h2><a href="index.html">Home</a></h2>
|
|
241
|
+
<h3>Classes</h3>
|
|
242
|
+
<ul>
|
|
243
|
+
<li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
|
|
244
|
+
<li><a href="AudioPeer.html">AudioPeer</a></li>
|
|
245
|
+
<li><a href="AudioRecorder.html">AudioRecorder</a></li>
|
|
246
|
+
<li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
|
|
247
|
+
<li><a href="Listener.html">Listener</a></li>
|
|
248
|
+
<li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
|
|
249
|
+
<li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
|
|
250
|
+
<li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
|
|
251
|
+
<li><a href="Speaker.html">Speaker</a></li>
|
|
252
|
+
<li><a href="Volume.html">Volume</a></li>
|
|
253
|
+
</ul>
|
|
254
|
+
<h3>Global</h3>
|
|
255
|
+
<ul>
|
|
256
|
+
<li><a href="global.html#csvToArray">csvToArray</a></li>
|
|
257
|
+
<li><a href="global.html#saveToCSV">saveToCSV</a></li>
|
|
258
|
+
<li><a href="global.html#sleep">sleep</a></li>
|
|
259
|
+
</ul>
|
|
260
|
+
</nav>
|
|
261
|
+
|
|
262
|
+
<br class="clear" />
|
|
263
|
+
|
|
264
|
+
<footer>
|
|
265
|
+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
|
|
266
|
+
Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
|
|
267
|
+
</footer>
|
|
268
|
+
|
|
269
|
+
<script>
|
|
270
|
+
prettyPrint();
|
|
271
|
+
</script>
|
|
272
|
+
<script src="scripts/linenumber.js"></script>
|
|
273
|
+
</body>
|
|
274
|
+
</html>
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8" />
|
|
5
|
+
<title>JSDoc: Class: PythonServerAPI</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: PythonServerAPI</h1>
|
|
19
|
+
|
|
20
|
+
<section>
|
|
21
|
+
<header>
|
|
22
|
+
<h2>
|
|
23
|
+
<span class="attribs"><span class="type-signature"></span></span>PythonServerAPI<span
|
|
24
|
+
class="signature"
|
|
25
|
+
>()</span
|
|
26
|
+
><span class="type-signature"></span>
|
|
27
|
+
</h2>
|
|
28
|
+
</header>
|
|
29
|
+
|
|
30
|
+
<article>
|
|
31
|
+
<div class="container-overview">
|
|
32
|
+
<h4 class="name" id="PythonServerAPI">
|
|
33
|
+
<span class="type-signature"></span>new PythonServerAPI<span class="signature"
|
|
34
|
+
>()</span
|
|
35
|
+
><span class="type-signature"></span>
|
|
36
|
+
</h4>
|
|
37
|
+
|
|
38
|
+
<dl class="details">
|
|
39
|
+
<dt class="tag-source">Source:</dt>
|
|
40
|
+
<dd class="tag-source">
|
|
41
|
+
<ul class="dummy">
|
|
42
|
+
<li>
|
|
43
|
+
<a href="server_PythonServerAPI.js.html">server/PythonServerAPI.js</a>,
|
|
44
|
+
<a href="server_PythonServerAPI.js.html#line5">line 5</a>
|
|
45
|
+
</li>
|
|
46
|
+
</ul>
|
|
47
|
+
</dd>
|
|
48
|
+
</dl>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
<h3 class="subsection-title">Members</h3>
|
|
52
|
+
|
|
53
|
+
<h4 class="name" id="getImpulseResponse">
|
|
54
|
+
<span class="type-signature"></span>getImpulseResponse<span
|
|
55
|
+
class="type-signature"
|
|
56
|
+
></span>
|
|
57
|
+
</h4>
|
|
58
|
+
|
|
59
|
+
<dl class="details">
|
|
60
|
+
<dt class="tag-source">Source:</dt>
|
|
61
|
+
<dd class="tag-source">
|
|
62
|
+
<ul class="dummy">
|
|
63
|
+
<li>
|
|
64
|
+
<a href="server_PythonServerAPI.js.html">server/PythonServerAPI.js</a>,
|
|
65
|
+
<a href="server_PythonServerAPI.js.html#line16">line 16</a>
|
|
66
|
+
</li>
|
|
67
|
+
</ul>
|
|
68
|
+
</dd>
|
|
69
|
+
</dl>
|
|
70
|
+
</article>
|
|
71
|
+
</section>
|
|
72
|
+
</div>
|
|
73
|
+
|
|
74
|
+
<nav>
|
|
75
|
+
<h2><a href="index.html">Home</a></h2>
|
|
76
|
+
<h3>Classes</h3>
|
|
77
|
+
<ul>
|
|
78
|
+
<li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
|
|
79
|
+
<li><a href="AudioPeer.html">AudioPeer</a></li>
|
|
80
|
+
<li><a href="AudioRecorder.html">AudioRecorder</a></li>
|
|
81
|
+
<li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
|
|
82
|
+
<li><a href="Listener.html">Listener</a></li>
|
|
83
|
+
<li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
|
|
84
|
+
<li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
|
|
85
|
+
<li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
|
|
86
|
+
<li><a href="Speaker.html">Speaker</a></li>
|
|
87
|
+
<li><a href="Volume.html">Volume</a></li>
|
|
88
|
+
</ul>
|
|
89
|
+
<h3>Global</h3>
|
|
90
|
+
<ul>
|
|
91
|
+
<li><a href="global.html#csvToArray">csvToArray</a></li>
|
|
92
|
+
<li><a href="global.html#saveToCSV">saveToCSV</a></li>
|
|
93
|
+
<li><a href="global.html#sleep">sleep</a></li>
|
|
94
|
+
</ul>
|
|
95
|
+
</nav>
|
|
96
|
+
|
|
97
|
+
<br class="clear" />
|
|
98
|
+
|
|
99
|
+
<footer>
|
|
100
|
+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
|
|
101
|
+
Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
|
|
102
|
+
</footer>
|
|
103
|
+
|
|
104
|
+
<script>
|
|
105
|
+
prettyPrint();
|
|
106
|
+
</script>
|
|
107
|
+
<script src="scripts/linenumber.js"></script>
|
|
108
|
+
</body>
|
|
109
|
+
</html>
|
|
Binary file
|
package/doc/Speaker.html
ADDED
|
@@ -0,0 +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>
|