speaker-calibration 2.2.212 → 2.2.213

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 (140) hide show
  1. package/.eslintignore +71 -71
  2. package/.eslintrc.json +40 -40
  3. package/.gitignore +81 -81
  4. package/.prettierignore +69 -69
  5. package/.prettierrc +14 -14
  6. package/LICENSE +20 -20
  7. package/README.md +133 -133
  8. package/__mocks__/fileMock.js +1 -1
  9. package/__mocks__/styleMock.js +1 -1
  10. package/babel.config.js +3 -3
  11. package/coverage/clover.xml +71 -71
  12. package/coverage/coverage-final.json +224 -224
  13. package/coverage/lcov-report/PythonServerInterface.js.html +265 -265
  14. package/coverage/lcov-report/base.css +354 -354
  15. package/coverage/lcov-report/block-navigation.js +82 -82
  16. package/coverage/lcov-report/favicon.png +0 -0
  17. package/coverage/lcov-report/index.html +123 -123
  18. package/coverage/lcov-report/prettify.css +101 -101
  19. package/coverage/lcov-report/prettify.js +937 -937
  20. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  21. package/coverage/lcov-report/sorter.js +189 -189
  22. package/coverage/lcov-report/src/index.html +121 -121
  23. package/coverage/lcov-report/src/server/PythonServerInterface.js.html +268 -268
  24. package/coverage/lcov-report/src/server/index.html +123 -123
  25. package/coverage/lcov-report/src/tasks/audioCalibrator.js.html +499 -499
  26. package/coverage/lcov-report/src/tasks/audioRecorder.js.html +412 -412
  27. package/coverage/lcov-report/src/tasks/index.html +143 -143
  28. package/coverage/lcov-report/src/tasks/volume/index.html +123 -123
  29. package/coverage/lcov-report/src/tasks/volume/volume.js.html +409 -409
  30. package/coverage/lcov-report/src/utils.js.html +172 -172
  31. package/coverage/lcov.info +91 -91
  32. package/dist/Procfile +0 -0
  33. package/dist/example/NoSleep.min.js +1 -1
  34. package/dist/example/credentials.json.gpg +0 -0
  35. package/dist/example/fetch-languages-sheets.js +77 -77
  36. package/dist/example/i18n.js +27366 -27366
  37. package/dist/example/index.html +47 -47
  38. package/dist/example/listener.html +79 -79
  39. package/dist/example/server.js +51 -51
  40. package/dist/example/speaker.html +145 -145
  41. package/dist/example/speakerUI.js +273 -273
  42. package/dist/example/styles.css +99 -99
  43. package/dist/listener.js +3459 -0
  44. package/dist/main.js +2420 -207
  45. package/dist/main.js.LICENSE.txt +118 -118
  46. package/dist/mlsGen.js +6814 -6814
  47. package/dist/mlsGen.wasm +0 -0
  48. package/dist/package-lock.json +1018 -1018
  49. package/dist/package.json +18 -18
  50. package/doc/AudioCalibrator.html +417 -417
  51. package/doc/AudioPeer.html +251 -251
  52. package/doc/AudioRecorder.html +195 -195
  53. package/doc/ImpulseResponse.html +215 -215
  54. package/doc/Listener.html +308 -308
  55. package/doc/MlsGenInterface.html +226 -226
  56. package/doc/MyEventEmitter.html +274 -274
  57. package/doc/PythonServerAPI.html +109 -109
  58. package/doc/Speaker-Calibration-UML-Diagram.png +0 -0
  59. package/doc/Speaker.html +276 -276
  60. package/doc/Takes%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +128 -128
  61. package/doc/Takes%20the%20url%20of%20the%20current%20site%0Aand%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +138 -138
  62. package/doc/Takes%20the%20url%20of%20the%20current%20site%20and%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +137 -137
  63. package/doc/Volume.html +88 -88
  64. package/doc/audioCalibrator.js.html +179 -179
  65. package/doc/audioPeer.js.html +175 -175
  66. package/doc/audioRecorder.js.html +163 -163
  67. package/doc/creates%20a%20new%20AudioRecorder%20instance.%20%0ASets%20up%20the%20audio%20context%20and%20file%20reader..html +114 -114
  68. package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
  69. package/doc/fonts/OpenSans-Bold-webfont.svg +1829 -1829
  70. package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
  71. package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  72. package/doc/fonts/OpenSans-BoldItalic-webfont.svg +1829 -1829
  73. package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  74. package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
  75. package/doc/fonts/OpenSans-Italic-webfont.svg +1829 -1829
  76. package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
  77. package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
  78. package/doc/fonts/OpenSans-Light-webfont.svg +1830 -1830
  79. package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
  80. package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  81. package/doc/fonts/OpenSans-LightItalic-webfont.svg +1834 -1834
  82. package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  83. package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
  84. package/doc/fonts/OpenSans-Regular-webfont.svg +1830 -1830
  85. package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
  86. package/doc/global.html +308 -308
  87. package/doc/index.html +58 -58
  88. package/doc/listener.js.html +170 -170
  89. package/doc/mlsGen_mlsGenInterface.js.html +117 -117
  90. package/doc/myEventEmitter.js.html +124 -124
  91. package/doc/peer-connection_audioPeer.js.html +188 -188
  92. package/doc/peer-connection_listener.js.html +311 -311
  93. package/doc/peer-connection_speaker.js.html +381 -381
  94. package/doc/sc-activity-diagram.png +0 -0
  95. package/doc/scripts/linenumber.js +25 -25
  96. package/doc/scripts/prettify/Apache-License-2.0.txt +202 -202
  97. package/doc/scripts/prettify/lang-css.js +24 -24
  98. package/doc/scripts/prettify/prettify.js +640 -640
  99. package/doc/server_PythonServerAPI.js.html +160 -160
  100. package/doc/speaker.js.html +248 -248
  101. package/doc/styles/jsdoc-default.css +371 -371
  102. package/doc/styles/prettify-jsdoc.css +111 -111
  103. package/doc/styles/prettify-tomorrow.css +163 -163
  104. package/doc/tasks_audioCalibrator.js.html +207 -207
  105. package/doc/tasks_audioRecorder.js.html +190 -190
  106. package/doc/tasks_impulse-response_impulseResponse.js.html +442 -442
  107. package/doc/tasks_impulse-response_mlsGen_mlsGenInterface.js.html +175 -175
  108. package/doc/tasks_volume_volume.js.html +185 -185
  109. package/doc/utils.js.html +105 -105
  110. package/jest.config.js +173 -173
  111. package/netlify.toml +26 -26
  112. package/package.json +78 -73
  113. package/src/config/firebase.js +26 -26
  114. package/src/index.html +21 -21
  115. package/{dist/example → src/listener-app}/listener.js +153 -152
  116. package/src/main.js +23 -23
  117. package/src/myEventEmitter.js +83 -83
  118. package/src/peer-connection/audioPeer.js +183 -183
  119. package/src/peer-connection/listener.js +366 -367
  120. package/src/peer-connection/peerErrors.js +25 -25
  121. package/src/peer-connection/speaker.js +739 -738
  122. package/src/powerCheck.js +98 -98
  123. package/src/server/PythonServerAPI.js +869 -869
  124. package/src/tasks/audioCalibrator.js +351 -351
  125. package/src/tasks/audioRecorder.js +315 -315
  126. package/src/tasks/combination/combination.js +3160 -3031
  127. package/src/tasks/combination/mlsGen/mlsGen.cpp +98 -98
  128. package/src/tasks/combination/mlsGen/mlsGen.hpp +303 -303
  129. package/src/tasks/combination/mlsGen/mlsGenInterface.js +131 -131
  130. package/src/tasks/combination/mlsGen/mlsGenTest.cpp +180 -180
  131. package/src/tasks/impulse-response/impulseResponse.js +610 -610
  132. package/src/tasks/impulse-response/mlsGen/mlsGen.cpp +98 -98
  133. package/src/tasks/impulse-response/mlsGen/mlsGen.hpp +303 -303
  134. package/src/tasks/impulse-response/mlsGen/mlsGenInterface.js +131 -131
  135. package/src/tasks/impulse-response/mlsGen/mlsGenTest.cpp +180 -180
  136. package/src/tasks/volume/volume.cpp +2 -2
  137. package/src/tasks/volume/volume.hpp +22 -22
  138. package/src/tasks/volume/volume.js +279 -279
  139. package/src/utils.js +205 -205
  140. package/webpack.config.js +64 -37
@@ -1,417 +1,417 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8" />
5
- <title>JSDoc: Class: AudioCalibrator</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: AudioCalibrator</h1>
19
-
20
- <section>
21
- <header>
22
- <h2>
23
- <span class="attribs"><span class="type-signature"></span></span>AudioCalibrator<span
24
- class="signature"
25
- >()</span
26
- ><span class="type-signature"></span>
27
- </h2>
28
-
29
- <div class="class-description">Provides methods for calibrating the user's speakers</div>
30
- </header>
31
-
32
- <article>
33
- <div class="container-overview">
34
- <h2>Constructor</h2>
35
-
36
- <h4 class="name" id="AudioCalibrator">
37
- <span class="type-signature"></span>new AudioCalibrator<span class="signature"
38
- >()</span
39
- ><span class="type-signature"></span>
40
- </h4>
41
-
42
- <dl class="details">
43
- <dt class="tag-source">Source:</dt>
44
- <dd class="tag-source">
45
- <ul class="dummy">
46
- <li>
47
- <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
48
- <a href="tasks_audioCalibrator.js.html#line10">line 10</a>
49
- </li>
50
- </ul>
51
- </dd>
52
- </dl>
53
- </div>
54
-
55
- <h3 class="subsection-title">Extends</h3>
56
-
57
- <ul>
58
- <li><a href="AudioRecorder.html">AudioRecorder</a></li>
59
- </ul>
60
-
61
- <h3 class="subsection-title">Members</h3>
62
-
63
- <h4 class="name" id="calibrationNodes">
64
- <span class="type-signature">(protected) </span>calibrationNodes<span
65
- class="type-signature"
66
- ></span>
67
- </h4>
68
-
69
- <dl class="details">
70
- <dt class="tag-source">Source:</dt>
71
- <dd class="tag-source">
72
- <ul class="dummy">
73
- <li>
74
- <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
75
- <a href="tasks_audioCalibrator.js.html#line37">line 37</a>
76
- </li>
77
- </ul>
78
- </dd>
79
- </dl>
80
-
81
- <h4 class="name" id="calibrationSteps">
82
- <span class="type-signature"></span>calibrationSteps<span class="type-signature"></span>
83
- </h4>
84
-
85
- <dl class="details">
86
- <dt class="tag-source">Source:</dt>
87
- <dd class="tag-source">
88
- <ul class="dummy">
89
- <li>
90
- <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
91
- <a href="tasks_audioCalibrator.js.html#line61">line 61</a>
92
- </li>
93
- </ul>
94
- </dd>
95
- </dl>
96
-
97
- <h4 class="name" id="createLocalAudio">
98
- <span class="type-signature"></span>createLocalAudio<span class="type-signature"></span>
99
- </h4>
100
-
101
- <div class="description">
102
- Called when a call is received. Creates a local audio DOM element and attaches it to the
103
- page.
104
- </div>
105
-
106
- <dl class="details">
107
- <dt class="tag-source">Source:</dt>
108
- <dd class="tag-source">
109
- <ul class="dummy">
110
- <li>
111
- <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
112
- <a href="tasks_audioCalibrator.js.html#line46">line 46</a>
113
- </li>
114
- </ul>
115
- </dd>
116
- </dl>
117
-
118
- <h4 class="name" id="downloadData">
119
- <span class="type-signature"></span>downloadData<span class="type-signature"></span>
120
- </h4>
121
-
122
- <div class="description">Download the result of the calibration roudns</div>
123
-
124
- <dl class="details">
125
- <dt class="tag-source">Source:</dt>
126
- <dd class="tag-source">
127
- <ul class="dummy">
128
- <li>
129
- <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
130
- <a href="tasks_audioCalibrator.js.html#line138">line 138</a>
131
- </li>
132
- </ul>
133
- </dd>
134
- </dl>
135
-
136
- <h4 class="name" id="getAllRecordedSignals">
137
- <span class="type-signature"></span>getAllRecordedSignals<span
138
- class="type-signature"
139
- ></span>
140
- </h4>
141
-
142
- <div class="description">Public method to get all the recorded audio signals</div>
143
-
144
- <dl class="details">
145
- <dt class="tag-overrides">Overrides:</dt>
146
- <dd class="tag-overrides">
147
- <ul class="dummy">
148
- <li>
149
- <a href="AudioRecorder.html#getAllRecordedSignals"
150
- >AudioRecorder#getAllRecordedSignals</a
151
- >
152
- </li>
153
- </ul>
154
- </dd>
155
-
156
- <dt class="tag-source">Source:</dt>
157
- <dd class="tag-source">
158
- <ul class="dummy">
159
- <li>
160
- <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
161
- <a href="tasks_audioRecorder.js.html#line115">line 115</a>
162
- </li>
163
- </ul>
164
- </dd>
165
- </dl>
166
-
167
- <h4 class="name" id="getCalibrationStatus">
168
- <span class="type-signature"></span>getCalibrationStatus<span
169
- class="type-signature"
170
- ></span>
171
- </h4>
172
-
173
- <div class="description">Getter for the isCalibrating property.</div>
174
-
175
- <dl class="details">
176
- <dt class="tag-source">Source:</dt>
177
- <dd class="tag-source">
178
- <ul class="dummy">
179
- <li>
180
- <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
181
- <a href="tasks_audioCalibrator.js.html#line105">line 105</a>
182
- </li>
183
- </ul>
184
- </dd>
185
- </dl>
186
-
187
- <h4 class="name" id="getLastRecordedSignal">
188
- <span class="type-signature"></span>getLastRecordedSignal<span
189
- class="type-signature"
190
- ></span>
191
- </h4>
192
-
193
- <div class="description">Public method to get the last recorded audio signal</div>
194
-
195
- <dl class="details">
196
- <dt class="tag-overrides">Overrides:</dt>
197
- <dd class="tag-overrides">
198
- <ul class="dummy">
199
- <li>
200
- <a href="AudioRecorder.html#getLastRecordedSignal"
201
- >AudioRecorder#getLastRecordedSignal</a
202
- >
203
- </li>
204
- </ul>
205
- </dd>
206
-
207
- <dt class="tag-source">Source:</dt>
208
- <dd class="tag-source">
209
- <ul class="dummy">
210
- <li>
211
- <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
212
- <a href="tasks_audioRecorder.js.html#line109">line 109</a>
213
- </li>
214
- </ul>
215
- </dd>
216
- </dl>
217
-
218
- <h4 class="name" id="localAudio">
219
- <span class="type-signature">(protected) </span>localAudio<span
220
- class="type-signature"
221
- ></span>
222
- </h4>
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="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
230
- <a href="tasks_audioCalibrator.js.html#line40">line 40</a>
231
- </li>
232
- </ul>
233
- </dd>
234
- </dl>
235
-
236
- <h4 class="name" id="numCalibratingRounds">
237
- <span class="type-signature">(protected) </span>numCalibratingRounds<span
238
- class="type-signature"
239
- ></span>
240
- </h4>
241
-
242
- <dl class="details">
243
- <dt class="tag-source">Source:</dt>
244
- <dd class="tag-source">
245
- <ul class="dummy">
246
- <li>
247
- <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
248
- <a href="tasks_audioCalibrator.js.html#line28">line 28</a>
249
- </li>
250
- </ul>
251
- </dd>
252
- </dl>
253
-
254
- <h4 class="name" id="numSuccessfulCaptured">
255
- <span class="type-signature">(protected) </span>numSuccessfulCaptured<span
256
- class="type-signature"
257
- ></span>
258
- </h4>
259
-
260
- <dl class="details">
261
- <dt class="tag-source">Source:</dt>
262
- <dd class="tag-source">
263
- <ul class="dummy">
264
- <li>
265
- <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
266
- <a href="tasks_audioCalibrator.js.html#line31">line 31</a>
267
- </li>
268
- </ul>
269
- </dd>
270
- </dl>
271
-
272
- <h4 class="name" id="setSamplingRates">
273
- <span class="type-signature"></span>setSamplingRates<span class="type-signature"></span>
274
- </h4>
275
-
276
- <div class="description">
277
- Set the sampling rate to the value received from the listener
278
- </div>
279
-
280
- <dl class="details">
281
- <dt class="tag-source">Source:</dt>
282
- <dd class="tag-source">
283
- <ul class="dummy">
284
- <li>
285
- <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
286
- <a href="tasks_audioCalibrator.js.html#line111">line 111</a>
287
- </li>
288
- </ul>
289
- </dd>
290
- </dl>
291
-
292
- <h4 class="name" id="setSinkSamplingRate">
293
- <span class="type-signature"></span>setSinkSamplingRate<span
294
- class="type-signature"
295
- ></span>
296
- </h4>
297
-
298
- <div class="description">
299
- Public method to set the sampling rate used by the capture device
300
- </div>
301
-
302
- <dl class="details">
303
- <dt class="tag-overrides">Overrides:</dt>
304
- <dd class="tag-overrides">
305
- <ul class="dummy">
306
- <li>
307
- <a href="AudioRecorder.html#setSinkSamplingRate"
308
- >AudioRecorder#setSinkSamplingRate</a
309
- >
310
- </li>
311
- </ul>
312
- </dd>
313
-
314
- <dt class="tag-source">Source:</dt>
315
- <dd class="tag-source">
316
- <ul class="dummy">
317
- <li>
318
- <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
319
- <a href="tasks_audioRecorder.js.html#line121">line 121</a>
320
- </li>
321
- </ul>
322
- </dd>
323
- </dl>
324
-
325
- <h4 class="name" id="startRecording">
326
- <span class="type-signature"></span>startRecording<span class="type-signature"></span>
327
- </h4>
328
-
329
- <div class="description">Public method to start the recording process.</div>
330
-
331
- <dl class="details">
332
- <dt class="tag-overrides">Overrides:</dt>
333
- <dd class="tag-overrides">
334
- <ul class="dummy">
335
- <li>
336
- <a href="AudioRecorder.html#startRecording">AudioRecorder#startRecording</a>
337
- </li>
338
- </ul>
339
- </dd>
340
-
341
- <dt class="tag-source">Source:</dt>
342
- <dd class="tag-source">
343
- <ul class="dummy">
344
- <li>
345
- <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
346
- <a href="tasks_audioRecorder.js.html#line73">line 73</a>
347
- </li>
348
- </ul>
349
- </dd>
350
- </dl>
351
-
352
- <h4 class="name" id="stopRecording">
353
- <span class="type-signature"></span>stopRecording<span class="type-signature"></span>
354
- </h4>
355
-
356
- <div class="description">Method to stop the recording process.</div>
357
-
358
- <dl class="details">
359
- <dt class="tag-overrides">Overrides:</dt>
360
- <dd class="tag-overrides">
361
- <ul class="dummy">
362
- <li>
363
- <a href="AudioRecorder.html#stopRecording">AudioRecorder#stopRecording</a>
364
- </li>
365
- </ul>
366
- </dd>
367
-
368
- <dt class="tag-source">Source:</dt>
369
- <dd class="tag-source">
370
- <ul class="dummy">
371
- <li>
372
- <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
373
- <a href="tasks_audioRecorder.js.html#line88">line 88</a>
374
- </li>
375
- </ul>
376
- </dd>
377
- </dl>
378
- </article>
379
- </section>
380
- </div>
381
-
382
- <nav>
383
- <h2><a href="index.html">Home</a></h2>
384
- <h3>Classes</h3>
385
- <ul>
386
- <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
387
- <li><a href="AudioPeer.html">AudioPeer</a></li>
388
- <li><a href="AudioRecorder.html">AudioRecorder</a></li>
389
- <li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
390
- <li><a href="Listener.html">Listener</a></li>
391
- <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
392
- <li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
393
- <li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
394
- <li><a href="Speaker.html">Speaker</a></li>
395
- <li><a href="Volume.html">Volume</a></li>
396
- </ul>
397
- <h3>Global</h3>
398
- <ul>
399
- <li><a href="global.html#csvToArray">csvToArray</a></li>
400
- <li><a href="global.html#saveToCSV">saveToCSV</a></li>
401
- <li><a href="global.html#sleep">sleep</a></li>
402
- </ul>
403
- </nav>
404
-
405
- <br class="clear" />
406
-
407
- <footer>
408
- Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
409
- Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
410
- </footer>
411
-
412
- <script>
413
- prettyPrint();
414
- </script>
415
- <script src="scripts/linenumber.js"></script>
416
- </body>
417
- </html>
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <title>JSDoc: Class: AudioCalibrator</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: AudioCalibrator</h1>
19
+
20
+ <section>
21
+ <header>
22
+ <h2>
23
+ <span class="attribs"><span class="type-signature"></span></span>AudioCalibrator<span
24
+ class="signature"
25
+ >()</span
26
+ ><span class="type-signature"></span>
27
+ </h2>
28
+
29
+ <div class="class-description">Provides methods for calibrating the user's speakers</div>
30
+ </header>
31
+
32
+ <article>
33
+ <div class="container-overview">
34
+ <h2>Constructor</h2>
35
+
36
+ <h4 class="name" id="AudioCalibrator">
37
+ <span class="type-signature"></span>new AudioCalibrator<span class="signature"
38
+ >()</span
39
+ ><span class="type-signature"></span>
40
+ </h4>
41
+
42
+ <dl class="details">
43
+ <dt class="tag-source">Source:</dt>
44
+ <dd class="tag-source">
45
+ <ul class="dummy">
46
+ <li>
47
+ <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
48
+ <a href="tasks_audioCalibrator.js.html#line10">line 10</a>
49
+ </li>
50
+ </ul>
51
+ </dd>
52
+ </dl>
53
+ </div>
54
+
55
+ <h3 class="subsection-title">Extends</h3>
56
+
57
+ <ul>
58
+ <li><a href="AudioRecorder.html">AudioRecorder</a></li>
59
+ </ul>
60
+
61
+ <h3 class="subsection-title">Members</h3>
62
+
63
+ <h4 class="name" id="calibrationNodes">
64
+ <span class="type-signature">(protected) </span>calibrationNodes<span
65
+ class="type-signature"
66
+ ></span>
67
+ </h4>
68
+
69
+ <dl class="details">
70
+ <dt class="tag-source">Source:</dt>
71
+ <dd class="tag-source">
72
+ <ul class="dummy">
73
+ <li>
74
+ <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
75
+ <a href="tasks_audioCalibrator.js.html#line37">line 37</a>
76
+ </li>
77
+ </ul>
78
+ </dd>
79
+ </dl>
80
+
81
+ <h4 class="name" id="calibrationSteps">
82
+ <span class="type-signature"></span>calibrationSteps<span class="type-signature"></span>
83
+ </h4>
84
+
85
+ <dl class="details">
86
+ <dt class="tag-source">Source:</dt>
87
+ <dd class="tag-source">
88
+ <ul class="dummy">
89
+ <li>
90
+ <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
91
+ <a href="tasks_audioCalibrator.js.html#line61">line 61</a>
92
+ </li>
93
+ </ul>
94
+ </dd>
95
+ </dl>
96
+
97
+ <h4 class="name" id="createLocalAudio">
98
+ <span class="type-signature"></span>createLocalAudio<span class="type-signature"></span>
99
+ </h4>
100
+
101
+ <div class="description">
102
+ Called when a call is received. Creates a local audio DOM element and attaches it to the
103
+ page.
104
+ </div>
105
+
106
+ <dl class="details">
107
+ <dt class="tag-source">Source:</dt>
108
+ <dd class="tag-source">
109
+ <ul class="dummy">
110
+ <li>
111
+ <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
112
+ <a href="tasks_audioCalibrator.js.html#line46">line 46</a>
113
+ </li>
114
+ </ul>
115
+ </dd>
116
+ </dl>
117
+
118
+ <h4 class="name" id="downloadData">
119
+ <span class="type-signature"></span>downloadData<span class="type-signature"></span>
120
+ </h4>
121
+
122
+ <div class="description">Download the result of the calibration roudns</div>
123
+
124
+ <dl class="details">
125
+ <dt class="tag-source">Source:</dt>
126
+ <dd class="tag-source">
127
+ <ul class="dummy">
128
+ <li>
129
+ <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
130
+ <a href="tasks_audioCalibrator.js.html#line138">line 138</a>
131
+ </li>
132
+ </ul>
133
+ </dd>
134
+ </dl>
135
+
136
+ <h4 class="name" id="getAllRecordedSignals">
137
+ <span class="type-signature"></span>getAllRecordedSignals<span
138
+ class="type-signature"
139
+ ></span>
140
+ </h4>
141
+
142
+ <div class="description">Public method to get all the recorded audio signals</div>
143
+
144
+ <dl class="details">
145
+ <dt class="tag-overrides">Overrides:</dt>
146
+ <dd class="tag-overrides">
147
+ <ul class="dummy">
148
+ <li>
149
+ <a href="AudioRecorder.html#getAllRecordedSignals"
150
+ >AudioRecorder#getAllRecordedSignals</a
151
+ >
152
+ </li>
153
+ </ul>
154
+ </dd>
155
+
156
+ <dt class="tag-source">Source:</dt>
157
+ <dd class="tag-source">
158
+ <ul class="dummy">
159
+ <li>
160
+ <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
161
+ <a href="tasks_audioRecorder.js.html#line115">line 115</a>
162
+ </li>
163
+ </ul>
164
+ </dd>
165
+ </dl>
166
+
167
+ <h4 class="name" id="getCalibrationStatus">
168
+ <span class="type-signature"></span>getCalibrationStatus<span
169
+ class="type-signature"
170
+ ></span>
171
+ </h4>
172
+
173
+ <div class="description">Getter for the isCalibrating property.</div>
174
+
175
+ <dl class="details">
176
+ <dt class="tag-source">Source:</dt>
177
+ <dd class="tag-source">
178
+ <ul class="dummy">
179
+ <li>
180
+ <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
181
+ <a href="tasks_audioCalibrator.js.html#line105">line 105</a>
182
+ </li>
183
+ </ul>
184
+ </dd>
185
+ </dl>
186
+
187
+ <h4 class="name" id="getLastRecordedSignal">
188
+ <span class="type-signature"></span>getLastRecordedSignal<span
189
+ class="type-signature"
190
+ ></span>
191
+ </h4>
192
+
193
+ <div class="description">Public method to get the last recorded audio signal</div>
194
+
195
+ <dl class="details">
196
+ <dt class="tag-overrides">Overrides:</dt>
197
+ <dd class="tag-overrides">
198
+ <ul class="dummy">
199
+ <li>
200
+ <a href="AudioRecorder.html#getLastRecordedSignal"
201
+ >AudioRecorder#getLastRecordedSignal</a
202
+ >
203
+ </li>
204
+ </ul>
205
+ </dd>
206
+
207
+ <dt class="tag-source">Source:</dt>
208
+ <dd class="tag-source">
209
+ <ul class="dummy">
210
+ <li>
211
+ <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
212
+ <a href="tasks_audioRecorder.js.html#line109">line 109</a>
213
+ </li>
214
+ </ul>
215
+ </dd>
216
+ </dl>
217
+
218
+ <h4 class="name" id="localAudio">
219
+ <span class="type-signature">(protected) </span>localAudio<span
220
+ class="type-signature"
221
+ ></span>
222
+ </h4>
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="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
230
+ <a href="tasks_audioCalibrator.js.html#line40">line 40</a>
231
+ </li>
232
+ </ul>
233
+ </dd>
234
+ </dl>
235
+
236
+ <h4 class="name" id="numCalibratingRounds">
237
+ <span class="type-signature">(protected) </span>numCalibratingRounds<span
238
+ class="type-signature"
239
+ ></span>
240
+ </h4>
241
+
242
+ <dl class="details">
243
+ <dt class="tag-source">Source:</dt>
244
+ <dd class="tag-source">
245
+ <ul class="dummy">
246
+ <li>
247
+ <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
248
+ <a href="tasks_audioCalibrator.js.html#line28">line 28</a>
249
+ </li>
250
+ </ul>
251
+ </dd>
252
+ </dl>
253
+
254
+ <h4 class="name" id="numSuccessfulCaptured">
255
+ <span class="type-signature">(protected) </span>numSuccessfulCaptured<span
256
+ class="type-signature"
257
+ ></span>
258
+ </h4>
259
+
260
+ <dl class="details">
261
+ <dt class="tag-source">Source:</dt>
262
+ <dd class="tag-source">
263
+ <ul class="dummy">
264
+ <li>
265
+ <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
266
+ <a href="tasks_audioCalibrator.js.html#line31">line 31</a>
267
+ </li>
268
+ </ul>
269
+ </dd>
270
+ </dl>
271
+
272
+ <h4 class="name" id="setSamplingRates">
273
+ <span class="type-signature"></span>setSamplingRates<span class="type-signature"></span>
274
+ </h4>
275
+
276
+ <div class="description">
277
+ Set the sampling rate to the value received from the listener
278
+ </div>
279
+
280
+ <dl class="details">
281
+ <dt class="tag-source">Source:</dt>
282
+ <dd class="tag-source">
283
+ <ul class="dummy">
284
+ <li>
285
+ <a href="tasks_audioCalibrator.js.html">tasks/audioCalibrator.js</a>,
286
+ <a href="tasks_audioCalibrator.js.html#line111">line 111</a>
287
+ </li>
288
+ </ul>
289
+ </dd>
290
+ </dl>
291
+
292
+ <h4 class="name" id="setSinkSamplingRate">
293
+ <span class="type-signature"></span>setSinkSamplingRate<span
294
+ class="type-signature"
295
+ ></span>
296
+ </h4>
297
+
298
+ <div class="description">
299
+ Public method to set the sampling rate used by the capture device
300
+ </div>
301
+
302
+ <dl class="details">
303
+ <dt class="tag-overrides">Overrides:</dt>
304
+ <dd class="tag-overrides">
305
+ <ul class="dummy">
306
+ <li>
307
+ <a href="AudioRecorder.html#setSinkSamplingRate"
308
+ >AudioRecorder#setSinkSamplingRate</a
309
+ >
310
+ </li>
311
+ </ul>
312
+ </dd>
313
+
314
+ <dt class="tag-source">Source:</dt>
315
+ <dd class="tag-source">
316
+ <ul class="dummy">
317
+ <li>
318
+ <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
319
+ <a href="tasks_audioRecorder.js.html#line121">line 121</a>
320
+ </li>
321
+ </ul>
322
+ </dd>
323
+ </dl>
324
+
325
+ <h4 class="name" id="startRecording">
326
+ <span class="type-signature"></span>startRecording<span class="type-signature"></span>
327
+ </h4>
328
+
329
+ <div class="description">Public method to start the recording process.</div>
330
+
331
+ <dl class="details">
332
+ <dt class="tag-overrides">Overrides:</dt>
333
+ <dd class="tag-overrides">
334
+ <ul class="dummy">
335
+ <li>
336
+ <a href="AudioRecorder.html#startRecording">AudioRecorder#startRecording</a>
337
+ </li>
338
+ </ul>
339
+ </dd>
340
+
341
+ <dt class="tag-source">Source:</dt>
342
+ <dd class="tag-source">
343
+ <ul class="dummy">
344
+ <li>
345
+ <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
346
+ <a href="tasks_audioRecorder.js.html#line73">line 73</a>
347
+ </li>
348
+ </ul>
349
+ </dd>
350
+ </dl>
351
+
352
+ <h4 class="name" id="stopRecording">
353
+ <span class="type-signature"></span>stopRecording<span class="type-signature"></span>
354
+ </h4>
355
+
356
+ <div class="description">Method to stop the recording process.</div>
357
+
358
+ <dl class="details">
359
+ <dt class="tag-overrides">Overrides:</dt>
360
+ <dd class="tag-overrides">
361
+ <ul class="dummy">
362
+ <li>
363
+ <a href="AudioRecorder.html#stopRecording">AudioRecorder#stopRecording</a>
364
+ </li>
365
+ </ul>
366
+ </dd>
367
+
368
+ <dt class="tag-source">Source:</dt>
369
+ <dd class="tag-source">
370
+ <ul class="dummy">
371
+ <li>
372
+ <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
373
+ <a href="tasks_audioRecorder.js.html#line88">line 88</a>
374
+ </li>
375
+ </ul>
376
+ </dd>
377
+ </dl>
378
+ </article>
379
+ </section>
380
+ </div>
381
+
382
+ <nav>
383
+ <h2><a href="index.html">Home</a></h2>
384
+ <h3>Classes</h3>
385
+ <ul>
386
+ <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
387
+ <li><a href="AudioPeer.html">AudioPeer</a></li>
388
+ <li><a href="AudioRecorder.html">AudioRecorder</a></li>
389
+ <li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
390
+ <li><a href="Listener.html">Listener</a></li>
391
+ <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
392
+ <li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
393
+ <li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
394
+ <li><a href="Speaker.html">Speaker</a></li>
395
+ <li><a href="Volume.html">Volume</a></li>
396
+ </ul>
397
+ <h3>Global</h3>
398
+ <ul>
399
+ <li><a href="global.html#csvToArray">csvToArray</a></li>
400
+ <li><a href="global.html#saveToCSV">saveToCSV</a></li>
401
+ <li><a href="global.html#sleep">sleep</a></li>
402
+ </ul>
403
+ </nav>
404
+
405
+ <br class="clear" />
406
+
407
+ <footer>
408
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
409
+ Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
410
+ </footer>
411
+
412
+ <script>
413
+ prettyPrint();
414
+ </script>
415
+ <script src="scripts/linenumber.js"></script>
416
+ </body>
417
+ </html>