npm - speaker-calibration - Versions diffs - 2.2.256 → 2.2.258 - Mend

speaker-calibration 2.2.256 → 2.2.258

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 (123) hide show

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 +29038 -29654
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 +9 -9
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/dist/phonePeer.js +3 -3
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/PhonePeer.js +499 -499
package/src/listener-app/listener.js +380 -380
package/src/main.js +22 -22
package/src/myEventEmitter.js +83 -83
package/src/peer-connection/audioPeer.js +100 -100
package/src/peer-connection/listener.js +298 -298
package/src/peer-connection/peerErrors.js +25 -25
package/src/peer-connection/speaker.js +983 -983
package/src/powerCheck.js +110 -110
package/src/server/PythonServerAPI.js +1001 -1001
package/src/tasks/combination/combination.js +3935 -3918
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 +215 -205
package/webpack.config.js +65 -65
package/.github/workflows/update-phrases.yml +0 -37
package/makefile +0 -74

package/doc/peer-connection_speaker.js.html CHANGED Viewed

@@ -1,381 +1,381 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <title>JSDoc: Source: peer-connection/speaker.js</title>
-    <script src="scripts/prettify/prettify.js"></script>
-    <script src="scripts/prettify/lang-css.js"></script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css" />
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css" />
-  </head>
-  <body>
-    <div id="main">
-      <h1 class="page-title">Source: peer-connection/speaker.js</h1>
-      <section>
-        <article>
-          <pre class="prettyprint source linenums"><code>import QRCode from 'qrcode';
-import AudioPeer from './audioPeer';
-import {sleep} from '../utils';
-import {
-  UnsupportedDeviceError,
-  MissingSpeakerIdError,
-  CalibrationTimedOutError,
-} from './peerErrors';
-/**
- * @class Handles the speaker's side of the connection. Responsible for initiating the connection,
- * rendering the QRCode, and answering the call.
- * @extends AudioPeer
- */
-class Speaker extends AudioPeer {
-  /**
-   * Takes the url of the current site and a target element where html elements will be appended.
-   * @param {initParameters} params - see type definition for initParameters
-   * @param {AudioCalibrator} Calibrator - An instance of the AudioCalibrator class, should not use AudioCalibrator directly, instead use an extended class available in /tasks/
-   */
-  constructor(params, CalibratorInstance) {
-    super(params);
-    this.siteUrl += '/listener?';
-    this.ac = CalibratorInstance;
-    this.result = null;
-    /* Set up callbacks that handle any events related to our peer object. */
-    this.peer.on('open', this.#onPeerOpen);
-    this.peer.on('connection', this.#onPeerConnection);
-    this.peer.on('close', this.#onPeerClose);
-    this.peer.on('disconnected', this.#onPeerDisconnected);
-    this.peer.on('error', this.#onPeerError);
-  }
-  /**
-   * Async factory method that creates the Speaker object, and returns a promise that resolves to the result of the calibration.
-   * @param {*} params - The parameters to be passed to the peer object.
-   * @param {*} Calibrator - The class that defines the calibration process
-   * @param {Number} timeOut - The amount of time to wait before timing out the connection (in milliseconds)
-   * @public
-   */
-  static startCalibration = async (params, CalibratorInstance, timeOut = 180000) => {
-    window.speaker = new Speaker(params, CalibratorInstance);
-    const {speaker} = window;
-    // wrap the calibration process in a promise so we can await it
-    return new Promise((resolve, reject) => {
-      // when a call is received
-      speaker.peer.on('call', async call => {
-        // Answer the call (one way)
-        call.answer();
-        speaker.#removeUIElems();
-        speaker.#showSpinner();
-        speaker.ac.createLocalAudio(document.getElementById(speaker.targetElement));
-        // when we start receiving audio
-        call.on('stream', async stream => {
-          window.localStream = stream;
-          window.localAudio.srcObject = stream;
-          window.localAudio.autoplay = false;
-          // if the sinkSamplingRate is not set sleep
-          while (!speaker.ac.sampleRatesSet()) {
-            console.log('SinkSamplingRate is undefined, sleeping');
-            await sleep(1);
-          }
-          // resolve when we have a result
-          speaker.result = await speaker.ac.startCalibration(stream);
-          speaker.#removeUIElems();
-          resolve(speaker.result);
-        });
-        // if we do not receive a result within the timeout, reject
-        setTimeout(() => {
-          reject(
-            new CalibrationTimedOutError(
-              `Calibration failed to produce a result after ${
-                timeOut / 1000
-              } seconds. Please try again.`
-            )
-          );
-        }, timeOut);
-      });
-    });
-  };
-  static testIIR = async (params, CalibratorInstance, IIR, timeOut = 180000) => {
-    window.speaker = new Speaker(params, CalibratorInstance);
-    const {speaker} = window;
-    // wrap the calibration process in a promise so we can await it
-    return new Promise((resolve, reject) => {
-      // when a call is received
-      speaker.peer.on('call', async call => {
-        // Answer the call (one way)
-        call.answer();
-        speaker.#removeUIElems();
-        speaker.#showSpinner();
-        speaker.ac.createLocalAudio(document.getElementById(speaker.targetElement));
-        // when we start receiving audio
-        call.on('stream', async stream => {
-          window.localStream = stream;
-          window.localAudio.srcObject = stream;
-          window.localAudio.autoplay = false;
-          // if the sinkSamplingRate is not set sleep
-          while (!speaker.ac.sampleRatesSet()) {
-            console.log('SinkSamplingRate is undefined, sleeping');
-            await sleep(1);
-          }
-          // resolve when we have a result
-          speaker.result = await speaker.ac.playMLSwithIIR(stream, IIR);
-          speaker.#removeUIElems();
-          resolve(speaker.result);
-        });
-        // if we do not receive a result within the timeout, reject
-        setTimeout(() => {
-          reject(
-            new CalibrationTimedOutError(
-              `Calibration failed to produce a result after ${
-                timeOut / 1000
-              } seconds. Please try again.`
-            )
-          );
-        }, timeOut);
-      });
-    });
-  };
-  /**
-   * Called after the peer conncection has been opened.
-   * Generates a QR code for the connection and displays it.
-   * @private
-   */
-  #showQRCode = () => {
-    // Get query string, the URL parameters to specify a Listener
-    const queryStringParameters = {
-      speakerPeerId: this.peer.id,
-    };
-    const queryString = this.queryStringFromObject(queryStringParameters);
-    const uri = this.siteUrl + queryString;
-    // Display QR code for the participant to scan
-    const qrCanvas = document.createElement('canvas');
-    qrCanvas.setAttribute('id', 'qrCanvas');
-    console.log(uri);
-    QRCode.toCanvas(qrCanvas, uri, error => {
-      if (error) console.error(error);
-    });
-    // If specified HTML Id is available, show QR code there
-    if (document.getElementById(this.targetElement)) {
-      if (document.getElementById(this.targetElement)) {
-        if (process.env.NODE_ENV === 'development') {
-          const linkTag = document.createElement('a');
-          linkTag.setAttribute('href', uri);
-          linkTag.innerHTML = "Click here to connect to the speaker's microphone";
-          linkTag.target = '_blank';
-          document.getElementById(this.targetElement).appendChild(linkTag);
-        }
-      }
-      document.getElementById(this.targetElement).appendChild(qrCanvas);
-    } else {
-      // or just print it to console
-      console.log('TEST: Peer reachable at: ', uri);
-    }
-  };
-  #showSpinner = () => {
-    const spinner = document.createElement('div');
-    spinner.className = 'spinner-border ml-auto';
-    spinner.role = 'status';
-    spinner.ariaHidden = 'true';
-    document.getElementById(this.targetElement).appendChild(spinner);
-  };
-  #removeUIElems = () => {
-    const parent = document.getElementById(this.targetElement);
-    while (parent.firstChild) {
-      parent.firstChild.remove();
-    }
-  };
-  /**
-   * Called when the peer connection is opened.
-   * Saves the peer id and calls the QR code generator.
-   * @param {object} peerId - The peer id of the peer connection
-   * @private
-   */
-  #onPeerOpen = id => {
-    // Workaround for peer.reconnect deleting previous id
-    if (id === null) {
-      console.error('Received null id from peer open');
-      this.peer.id = this.lastPeerId;
-    } else {
-      this.lastPeerId = this.peer.id;
-    }
-    if (id !== this.peer.id) {
-      console.warn('DEBUG Check you assumption that id === this.peer.id');
-    }
-    this.#showQRCode();
-  };
-  /**
-   * Called when the peer connection is established.
-   * Enforces a single connection.
-   * @param {*} connection - The connection object
-   * @private
-   */
-  #onPeerConnection = connection => {
-    // Allow only a single connection
-    if (this.conn &amp;&amp; this.conn.open) {
-      connection.on('open', () => {
-        connection.send('Already connected to another client');
-        setTimeout(() => {
-          connection.close();
-        }, 500);
-      });
-      return;
-    }
-    this.conn = connection;
-    console.log('Connected to: ', this.conn.peer);
-    this.#ready();
-  };
-  /**
-   * Called when the peer connection is closed.
-   * @private
-   */
-  #onPeerClose = () => {
-    this.conn = null;
-    console.log('Connection destroyed');
-  };
-  /**
-   * Called when the peer connection is disconnected.
-   * Attempts to reconnect.
-   * @private
-   */
-  #onPeerDisconnected = () => {
-    console.log('Connection lost. Please reconnect');
-    // Workaround for peer.reconnect deleting previous id
-    this.peer.id = this.lastPeerId;
-    // eslint-disable-next-line no-underscore-dangle
-    this.peer._lastServerId = this.lastPeerId;
-    this.peer.reconnect();
-  };
-  /**
-   * Called when the peer connection encounters an error.
-   * @param {*} error
-   * @private
-   */
-  #onPeerError = error => {
-    // TODO: check if this function is needed or not
-    console.error(error);
-  };
-  /**
-   * Called when data is received from the peer connection.
-   * @param {*} data
-   * @private
-   */
-  #onIncomingData = data => {
-    // enforce object type
-    if (
-      !Object.prototype.hasOwnProperty.call(data, 'name') ||
-      !Object.prototype.hasOwnProperty.call(data, 'payload')
-    ) {
-      console.error('Received malformed data: ', data);
-      return;
-    }
-    switch (data.name) {
-      case 'samplingRate':
-        this.ac.setSamplingRates(data.payload);
-        break;
-      case UnsupportedDeviceError.name:
-      case MissingSpeakerIdError.name:
-        throw data.payload;
-        break;
-      default:
-        break;
-    }
-  };
-  /**
-   * Called when the peer connection is #ready.
-   * @private
-   */
-  #ready = () => {
-    // Perform callback with data
-    this.conn.on('data', this.#onIncomingData);
-    this.conn.on('close', () => {
-      console.log('Connection reset&lt;br>Awaiting connection...');
-      this.conn = null;
-    });
-  };
-  /**
-   * Debug method for downloading the recorded audio
-   * @public
-   */
-  downloadData = () => {
-    this.ac.downloadData();
-  };
-}
-/*
-Referenced links:
-https://stackoverflow.com/questions/28016664/when-you-pass-this-as-an-argument/28016676#28016676
-https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes
-https://stackoverflow.com/questions/879152/how-do-i-make-javascript-beep [3]
-*/
-export default Speaker;
-</code></pre>
-        </article>
-      </section>
-    </div>
-    <nav>
-      <h2><a href="index.html">Home</a></h2>
-      <h3>Classes</h3>
-      <ul>
-        <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
-        <li><a href="AudioPeer.html">AudioPeer</a></li>
-        <li><a href="AudioRecorder.html">AudioRecorder</a></li>
-        <li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
-        <li><a href="Listener.html">Listener</a></li>
-        <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
-        <li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
-        <li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
-        <li><a href="Speaker.html">Speaker</a></li>
-        <li><a href="Volume.html">Volume</a></li>
-      </ul>
-      <h3>Global</h3>
-      <ul>
-        <li><a href="global.html#csvToArray">csvToArray</a></li>
-        <li><a href="global.html#saveToCSV">saveToCSV</a></li>
-        <li><a href="global.html#sleep">sleep</a></li>
-      </ul>
-    </nav>
-    <br class="clear" />
-    <footer>
-      Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
-      Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
-    </footer>
-    <script>
-      prettyPrint();
-    </script>
-    <script src="scripts/linenumber.js"></script>
-  </body>
-</html>
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JSDoc: Source: peer-connection/speaker.js</title>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css" />
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css" />
+  </head>
+  <body>
+    <div id="main">
+      <h1 class="page-title">Source: peer-connection/speaker.js</h1>
+      <section>
+        <article>
+          <pre class="prettyprint source linenums"><code>import QRCode from 'qrcode';
+import AudioPeer from './audioPeer';
+import {sleep} from '../utils';
+import {
+  UnsupportedDeviceError,
+  MissingSpeakerIdError,
+  CalibrationTimedOutError,
+} from './peerErrors';
+/**
+ * @class Handles the speaker's side of the connection. Responsible for initiating the connection,
+ * rendering the QRCode, and answering the call.
+ * @extends AudioPeer
+ */
+class Speaker extends AudioPeer {
+  /**
+   * Takes the url of the current site and a target element where html elements will be appended.
+   * @param {initParameters} params - see type definition for initParameters
+   * @param {AudioCalibrator} Calibrator - An instance of the AudioCalibrator class, should not use AudioCalibrator directly, instead use an extended class available in /tasks/
+   */
+  constructor(params, CalibratorInstance) {
+    super(params);
+    this.siteUrl += '/listener?';
+    this.ac = CalibratorInstance;
+    this.result = null;
+    /* Set up callbacks that handle any events related to our peer object. */
+    this.peer.on('open', this.#onPeerOpen);
+    this.peer.on('connection', this.#onPeerConnection);
+    this.peer.on('close', this.#onPeerClose);
+    this.peer.on('disconnected', this.#onPeerDisconnected);
+    this.peer.on('error', this.#onPeerError);
+  }
+  /**
+   * Async factory method that creates the Speaker object, and returns a promise that resolves to the result of the calibration.
+   * @param {*} params - The parameters to be passed to the peer object.
+   * @param {*} Calibrator - The class that defines the calibration process
+   * @param {Number} timeOut - The amount of time to wait before timing out the connection (in milliseconds)
+   * @public
+   */
+  static startCalibration = async (params, CalibratorInstance, timeOut = 180000) => {
+    window.speaker = new Speaker(params, CalibratorInstance);
+    const {speaker} = window;
+    // wrap the calibration process in a promise so we can await it
+    return new Promise((resolve, reject) => {
+      // when a call is received
+      speaker.peer.on('call', async call => {
+        // Answer the call (one way)
+        call.answer();
+        speaker.#removeUIElems();
+        speaker.#showSpinner();
+        speaker.ac.createLocalAudio(document.getElementById(speaker.targetElement));
+        // when we start receiving audio
+        call.on('stream', async stream => {
+          window.localStream = stream;
+          window.localAudio.srcObject = stream;
+          window.localAudio.autoplay = false;
+          // if the sinkSamplingRate is not set sleep
+          while (!speaker.ac.sampleRatesSet()) {
+            console.log('SinkSamplingRate is undefined, sleeping');
+            await sleep(1);
+          }
+          // resolve when we have a result
+          speaker.result = await speaker.ac.startCalibration(stream);
+          speaker.#removeUIElems();
+          resolve(speaker.result);
+        });
+        // if we do not receive a result within the timeout, reject
+        setTimeout(() => {
+          reject(
+            new CalibrationTimedOutError(
+              `Calibration failed to produce a result after ${
+                timeOut / 1000
+              } seconds. Please try again.`
+            )
+          );
+        }, timeOut);
+      });
+    });
+  };
+  static testIIR = async (params, CalibratorInstance, IIR, timeOut = 180000) => {
+    window.speaker = new Speaker(params, CalibratorInstance);
+    const {speaker} = window;
+    // wrap the calibration process in a promise so we can await it
+    return new Promise((resolve, reject) => {
+      // when a call is received
+      speaker.peer.on('call', async call => {
+        // Answer the call (one way)
+        call.answer();
+        speaker.#removeUIElems();
+        speaker.#showSpinner();
+        speaker.ac.createLocalAudio(document.getElementById(speaker.targetElement));
+        // when we start receiving audio
+        call.on('stream', async stream => {
+          window.localStream = stream;
+          window.localAudio.srcObject = stream;
+          window.localAudio.autoplay = false;
+          // if the sinkSamplingRate is not set sleep
+          while (!speaker.ac.sampleRatesSet()) {
+            console.log('SinkSamplingRate is undefined, sleeping');
+            await sleep(1);
+          }
+          // resolve when we have a result
+          speaker.result = await speaker.ac.playMLSwithIIR(stream, IIR);
+          speaker.#removeUIElems();
+          resolve(speaker.result);
+        });
+        // if we do not receive a result within the timeout, reject
+        setTimeout(() => {
+          reject(
+            new CalibrationTimedOutError(
+              `Calibration failed to produce a result after ${
+                timeOut / 1000
+              } seconds. Please try again.`
+            )
+          );
+        }, timeOut);
+      });
+    });
+  };
+  /**
+   * Called after the peer conncection has been opened.
+   * Generates a QR code for the connection and displays it.
+   * @private
+   */
+  #showQRCode = () => {
+    // Get query string, the URL parameters to specify a Listener
+    const queryStringParameters = {
+      speakerPeerId: this.peer.id,
+    };
+    const queryString = this.queryStringFromObject(queryStringParameters);
+    const uri = this.siteUrl + queryString;
+    // Display QR code for the participant to scan
+    const qrCanvas = document.createElement('canvas');
+    qrCanvas.setAttribute('id', 'qrCanvas');
+    console.log(uri);
+    QRCode.toCanvas(qrCanvas, uri, error => {
+      if (error) console.error(error);
+    });
+    // If specified HTML Id is available, show QR code there
+    if (document.getElementById(this.targetElement)) {
+      if (document.getElementById(this.targetElement)) {
+        if (process.env.NODE_ENV === 'development') {
+          const linkTag = document.createElement('a');
+          linkTag.setAttribute('href', uri);
+          linkTag.innerHTML = "Click here to connect to the speaker's microphone";
+          linkTag.target = '_blank';
+          document.getElementById(this.targetElement).appendChild(linkTag);
+        }
+      }
+      document.getElementById(this.targetElement).appendChild(qrCanvas);
+    } else {
+      // or just print it to console
+      console.log('TEST: Peer reachable at: ', uri);
+    }
+  };
+  #showSpinner = () => {
+    const spinner = document.createElement('div');
+    spinner.className = 'spinner-border ml-auto';
+    spinner.role = 'status';
+    spinner.ariaHidden = 'true';
+    document.getElementById(this.targetElement).appendChild(spinner);
+  };
+  #removeUIElems = () => {
+    const parent = document.getElementById(this.targetElement);
+    while (parent.firstChild) {
+      parent.firstChild.remove();
+    }
+  };
+  /**
+   * Called when the peer connection is opened.
+   * Saves the peer id and calls the QR code generator.
+   * @param {object} peerId - The peer id of the peer connection
+   * @private
+   */
+  #onPeerOpen = id => {
+    // Workaround for peer.reconnect deleting previous id
+    if (id === null) {
+      console.error('Received null id from peer open');
+      this.peer.id = this.lastPeerId;
+    } else {
+      this.lastPeerId = this.peer.id;
+    }
+    if (id !== this.peer.id) {
+      console.warn('DEBUG Check you assumption that id === this.peer.id');
+    }
+    this.#showQRCode();
+  };
+  /**
+   * Called when the peer connection is established.
+   * Enforces a single connection.
+   * @param {*} connection - The connection object
+   * @private
+   */
+  #onPeerConnection = connection => {
+    // Allow only a single connection
+    if (this.conn &amp;&amp; this.conn.open) {
+      connection.on('open', () => {
+        connection.send('Already connected to another client');
+        setTimeout(() => {
+          connection.close();
+        }, 500);
+      });
+      return;
+    }
+    this.conn = connection;
+    console.log('Connected to: ', this.conn.peer);
+    this.#ready();
+  };
+  /**
+   * Called when the peer connection is closed.
+   * @private
+   */
+  #onPeerClose = () => {
+    this.conn = null;
+    console.log('Connection destroyed');
+  };
+  /**
+   * Called when the peer connection is disconnected.
+   * Attempts to reconnect.
+   * @private
+   */
+  #onPeerDisconnected = () => {
+    console.log('Connection lost. Please reconnect');
+    // Workaround for peer.reconnect deleting previous id
+    this.peer.id = this.lastPeerId;
+    // eslint-disable-next-line no-underscore-dangle
+    this.peer._lastServerId = this.lastPeerId;
+    this.peer.reconnect();
+  };
+  /**
+   * Called when the peer connection encounters an error.
+   * @param {*} error
+   * @private
+   */
+  #onPeerError = error => {
+    // TODO: check if this function is needed or not
+    console.error(error);
+  };
+  /**
+   * Called when data is received from the peer connection.
+   * @param {*} data
+   * @private
+   */
+  #onIncomingData = data => {
+    // enforce object type
+    if (
+      !Object.prototype.hasOwnProperty.call(data, 'name') ||
+      !Object.prototype.hasOwnProperty.call(data, 'payload')
+    ) {
+      console.error('Received malformed data: ', data);
+      return;
+    }
+    switch (data.name) {
+      case 'samplingRate':
+        this.ac.setSamplingRates(data.payload);
+        break;
+      case UnsupportedDeviceError.name:
+      case MissingSpeakerIdError.name:
+        throw data.payload;
+        break;
+      default:
+        break;
+    }
+  };
+  /**
+   * Called when the peer connection is #ready.
+   * @private
+   */
+  #ready = () => {
+    // Perform callback with data
+    this.conn.on('data', this.#onIncomingData);
+    this.conn.on('close', () => {
+      console.log('Connection reset&lt;br>Awaiting connection...');
+      this.conn = null;
+    });
+  };
+  /**
+   * Debug method for downloading the recorded audio
+   * @public
+   */
+  downloadData = () => {
+    this.ac.downloadData();
+  };
+}
+/*
+Referenced links:
+https://stackoverflow.com/questions/28016664/when-you-pass-this-as-an-argument/28016676#28016676
+https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes
+https://stackoverflow.com/questions/879152/how-do-i-make-javascript-beep [3]
+*/
+export default Speaker;
+</code></pre>
+        </article>
+      </section>
+    </div>
+    <nav>
+      <h2><a href="index.html">Home</a></h2>
+      <h3>Classes</h3>
+      <ul>
+        <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
+        <li><a href="AudioPeer.html">AudioPeer</a></li>
+        <li><a href="AudioRecorder.html">AudioRecorder</a></li>
+        <li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
+        <li><a href="Listener.html">Listener</a></li>
+        <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
+        <li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
+        <li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
+        <li><a href="Speaker.html">Speaker</a></li>
+        <li><a href="Volume.html">Volume</a></li>
+      </ul>
+      <h3>Global</h3>
+      <ul>
+        <li><a href="global.html#csvToArray">csvToArray</a></li>
+        <li><a href="global.html#saveToCSV">saveToCSV</a></li>
+        <li><a href="global.html#sleep">sleep</a></li>
+      </ul>
+    </nav>
+    <br class="clear" />
+    <footer>
+      Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
+      Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
+    </footer>
+    <script>
+      prettyPrint();
+    </script>
+    <script src="scripts/linenumber.js"></script>
+  </body>
+</html>