speaker-calibration 2.2.270 → 2.2.272

package/doc/tasks_audioCalibrator.js.html

@@ -1,207 +1,207 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <title>JSDoc: Source: tasks/audioCalibrator.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: tasks/audioCalibrator.js</h1>
-
-      <section>
-        <article>
-          <pre class="prettyprint source linenums"><code>/* eslint-disable no-await-in-loop */
-import AudioRecorder from './audioRecorder';
-import PythonServerAPI from '../server/PythonServerAPI';
-import {sleep, saveToCSV} from '../utils';
-
-/**
- * Provides methods for calibrating the user's speakers
- * @extends AudioRecorder
- */
-class AudioCalibrator extends AudioRecorder {
-  /**
-   *
-   */
-  constructor(numCaptures = 1, numMLSPerCapture = 1) {
-    super();
-    this.numCaptures = numCaptures;
-    this.numMLSPerCapture = numMLSPerCapture;
-    this.pyServerAPI = new PythonServerAPI();
-  }
-
-  /** @private */
-  #isCalibrating = false;
-
-  /** @private */
-  sourceAudioContext;
-
-  /** @protected */
-  numCalibratingRounds;
-
-  /** @protected */
-  numSuccessfulCaptured = 0;
-
-  /** @private */
-  sourceSamplingRate;
-
-  /** @protected */
-  calibrationNodes = [];
-
-  /** @protected */
-  localAudio;
-
-  /**
-   * Called when a call is received.
-   * Creates a local audio DOM element and attaches it to the page.
-   */
-  createLocalAudio = targetElement => {
-    this.localAudio = document.createElement('audio');
-    this.localAudio.setAttribute('id', 'localAudio');
-    targetElement.appendChild(this.localAudio);
-  };
-
-  /**
-   *
-   * @param {MediaStream} stream
-   * @param {Function} playCalibrationAudio - (async) function that plays the calibration audio
-   * @param {*} beforePlay - (async) function that is called before playing the audio
-   * @param {*} beforeRecord - (async) function that is called before recording
-   * @param {*} duringRecord - (async) function that is called while recording
-   * @param {*} afterRecord  - (async) function that is called after recording
-   */
-  calibrationSteps = async (
-    stream,
-    playCalibrationAudio,
-    beforePlay = async () => {},
-    beforeRecord = async () => {},
-    duringRecord = async () => {},
-    afterRecord = async () => {}
-  ) => {
-    this.numSuccessfulCaptured = 0;
-
-    // do something before recording such as awaiting a certain amount of time
-    await beforeRecord();
-
-    // calibration loop
-    while (this.numSuccessfulCaptured &lt; this.numCaptures) {
-      // do something before playing such as using the MLS to fill the buffers
-      await beforePlay();
-
-      // start recording
-      await this.startRecording(stream);
-
-      // play calibration audio
-      playCalibrationAudio();
-
-      // do something during the recording such as sleep n amount of time
-      await duringRecord();
-
-      // when done, stop recording
-      await this.stopRecording();
-
-      // do something after recording such as start processing values
-      await afterRecord();
-
-      // eslint-disable-next-line no-await-in-loop
-      this.calibrationNodes = [];
-      await sleep(3);
-    }
-  };
-
-  /**
-   * Getter for the isCalibrating property.
-   * @public
-   * @returns {Boolean} - True if the audio is being calibrated, false otherwise.
-   */
-  getCalibrationStatus = () => this.#isCalibrating;
-
-  /**
-   * Set the sampling rate to the value received from the listener
-   * @param {*} sinkSamplingRate
-   */
-  setSamplingRates = samplingRate => {
-    this.sinkSamplingRate = samplingRate;
-    this.sourceSamplingRate = samplingRate;
-    this.emit('update', {message: `sampling at ${samplingRate}Hz...`});
-  };
-
-  sampleRatesSet = () => this.sourceSamplingRate &amp;&amp; this.sinkSamplingRate;
-
-  addCalibrationNode = node => {
-    this.calibrationNodes.push(node);
-  };
-
-  makeNewSourceAudioContext = () => {
-    const options = {
-      sampleRate: this.sourceSamplingRate,
-    };
-
-    this.sourceAudioContext = new (window.AudioContext ||
-      window.webkitAudioContext ||
-      window.audioContext)(options);
-
-    return this.sourceAudioContext;
-  };
-
-  /**
-   * Download the result of the calibration roudns
-   */
-  downloadData = () => {
-    const recordings = this.getAllRecordedSignals();
-    const i = recordings.length - 1;
-    saveToCSV(recordings[i], `recordedMLSignal_${i}.csv`);
-  };
-}
-
-export default AudioCalibrator;
-</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: tasks/audioCalibrator.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: tasks/audioCalibrator.js</h1>
+
+      <section>
+        <article>
+          <pre class="prettyprint source linenums"><code>/* eslint-disable no-await-in-loop */
+import AudioRecorder from './audioRecorder';
+import PythonServerAPI from '../server/PythonServerAPI';
+import {sleep, saveToCSV} from '../utils';
+
+/**
+ * Provides methods for calibrating the user's speakers
+ * @extends AudioRecorder
+ */
+class AudioCalibrator extends AudioRecorder {
+  /**
+   *
+   */
+  constructor(numCaptures = 1, numMLSPerCapture = 1) {
+    super();
+    this.numCaptures = numCaptures;
+    this.numMLSPerCapture = numMLSPerCapture;
+    this.pyServerAPI = new PythonServerAPI();
+  }
+
+  /** @private */
+  #isCalibrating = false;
+
+  /** @private */
+  sourceAudioContext;
+
+  /** @protected */
+  numCalibratingRounds;
+
+  /** @protected */
+  numSuccessfulCaptured = 0;
+
+  /** @private */
+  sourceSamplingRate;
+
+  /** @protected */
+  calibrationNodes = [];
+
+  /** @protected */
+  localAudio;
+
+  /**
+   * Called when a call is received.
+   * Creates a local audio DOM element and attaches it to the page.
+   */
+  createLocalAudio = targetElement => {
+    this.localAudio = document.createElement('audio');
+    this.localAudio.setAttribute('id', 'localAudio');
+    targetElement.appendChild(this.localAudio);
+  };
+
+  /**
+   *
+   * @param {MediaStream} stream
+   * @param {Function} playCalibrationAudio - (async) function that plays the calibration audio
+   * @param {*} beforePlay - (async) function that is called before playing the audio
+   * @param {*} beforeRecord - (async) function that is called before recording
+   * @param {*} duringRecord - (async) function that is called while recording
+   * @param {*} afterRecord  - (async) function that is called after recording
+   */
+  calibrationSteps = async (
+    stream,
+    playCalibrationAudio,
+    beforePlay = async () => {},
+    beforeRecord = async () => {},
+    duringRecord = async () => {},
+    afterRecord = async () => {}
+  ) => {
+    this.numSuccessfulCaptured = 0;
+
+    // do something before recording such as awaiting a certain amount of time
+    await beforeRecord();
+
+    // calibration loop
+    while (this.numSuccessfulCaptured &lt; this.numCaptures) {
+      // do something before playing such as using the MLS to fill the buffers
+      await beforePlay();
+
+      // start recording
+      await this.startRecording(stream);
+
+      // play calibration audio
+      playCalibrationAudio();
+
+      // do something during the recording such as sleep n amount of time
+      await duringRecord();
+
+      // when done, stop recording
+      await this.stopRecording();
+
+      // do something after recording such as start processing values
+      await afterRecord();
+
+      // eslint-disable-next-line no-await-in-loop
+      this.calibrationNodes = [];
+      await sleep(3);
+    }
+  };
+
+  /**
+   * Getter for the isCalibrating property.
+   * @public
+   * @returns {Boolean} - True if the audio is being calibrated, false otherwise.
+   */
+  getCalibrationStatus = () => this.#isCalibrating;
+
+  /**
+   * Set the sampling rate to the value received from the listener
+   * @param {*} sinkSamplingRate
+   */
+  setSamplingRates = samplingRate => {
+    this.sinkSamplingRate = samplingRate;
+    this.sourceSamplingRate = samplingRate;
+    this.emit('update', {message: `sampling at ${samplingRate}Hz...`});
+  };
+
+  sampleRatesSet = () => this.sourceSamplingRate &amp;&amp; this.sinkSamplingRate;
+
+  addCalibrationNode = node => {
+    this.calibrationNodes.push(node);
+  };
+
+  makeNewSourceAudioContext = () => {
+    const options = {
+      sampleRate: this.sourceSamplingRate,
+    };
+
+    this.sourceAudioContext = new (window.AudioContext ||
+      window.webkitAudioContext ||
+      window.audioContext)(options);
+
+    return this.sourceAudioContext;
+  };
+
+  /**
+   * Download the result of the calibration roudns
+   */
+  downloadData = () => {
+    const recordings = this.getAllRecordedSignals();
+    const i = recordings.length - 1;
+    saveToCSV(recordings[i], `recordedMLSignal_${i}.csv`);
+  };
+}
+
+export default AudioCalibrator;
+</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>