npm - speaker-calibration - Versions diffs - 2.0.0 → 2.1.1 - Mend

speaker-calibration 2.0.0 → 2.1.1

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

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 +913 -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 +155 -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 +174 -0
package/src/utils.js +55 -0
package/webpack.config.js +37 -0
package/README +0 -3

package/doc/fonts/OpenSans-Regular-webfont.woff ADDED Viewed

Binary file

package/doc/global.html ADDED Viewed

@@ -0,0 +1,308 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JSDoc: Global</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">Global</h1>
+      <section>
+        <header>
+          <h2></h2>
+        </header>
+        <article>
+          <div class="container-overview">
+            <dl class="details"></dl>
+          </div>
+          <h3 class="subsection-title">Methods</h3>
+          <h4 class="name" id="csvToArray">
+            <span class="type-signature"></span>csvToArray<span class="signature"
+              >(csvString, delimiter)</span
+            ><span class="type-signature"></span>
+          </h4>
+          <div class="description">Utility function to create a buffer from a CSV file</div>
+          <h5>Parameters:</h5>
+          <table class="params">
+            <thead>
+              <tr>
+                <th>Name</th>
+                <th>Type</th>
+                <th>Default</th>
+                <th class="last">Description</th>
+              </tr>
+            </thead>
+            <tbody>
+              <tr>
+                <td class="name"><code>csvString</code></td>
+                <td class="type">
+                  <span class="param-type">*</span>
+                </td>
+                <td class="default"></td>
+                <td class="description last"></td>
+              </tr>
+              <tr>
+                <td class="name"><code>delimiter</code></td>
+                <td class="type">
+                  <span class="param-type">*</span>
+                </td>
+                <td class="default">,</td>
+                <td class="description last"></td>
+              </tr>
+            </tbody>
+          </table>
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line37">line 37</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+          <h5>Returns:</h5>
+          <h4 class="name" id="saveToCSV">
+            <span class="type-signature"></span>saveToCSV<span class="signature"
+              >(data, filename)</span
+            ><span class="type-signature"></span>
+          </h4>
+          <div class="description">
+            Uiltity function to create and save a CSV file from a buffer
+          </div>
+          <h5>Parameters:</h5>
+          <table class="params">
+            <thead>
+              <tr>
+                <th>Name</th>
+                <th>Type</th>
+                <th>Default</th>
+                <th class="last">Description</th>
+              </tr>
+            </thead>
+            <tbody>
+              <tr>
+                <td class="name"><code>data</code></td>
+                <td class="type">
+                  <span class="param-type">*</span>
+                </td>
+                <td class="default"></td>
+                <td class="description last"></td>
+              </tr>
+              <tr>
+                <td class="name"><code>filename</code></td>
+                <td class="type">
+                  <span class="param-type">*</span>
+                </td>
+                <td class="default">recordedMLSignal.csv</td>
+                <td class="description last"></td>
+              </tr>
+            </tbody>
+          </table>
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line16">line 16</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+          <h4 class="name" id="sleep">
+            <span class="type-signature"></span>sleep<span class="signature">(seconds)</span
+            ><span class="type-signature"> &rarr; {Promise}</span>
+          </h4>
+          <div class="description">Utlity function to pause execution for a given time</div>
+          <h5>Parameters:</h5>
+          <table class="params">
+            <thead>
+              <tr>
+                <th>Name</th>
+                <th>Type</th>
+                <th class="last">Description</th>
+              </tr>
+            </thead>
+            <tbody>
+              <tr>
+                <td class="name"><code>seconds</code></td>
+                <td class="type">
+                  <span class="param-type">number</span>
+                </td>
+                <td class="description last"></td>
+              </tr>
+            </tbody>
+          </table>
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="utils.js.html">utils.js</a>, <a href="utils.js.html#line6">line 6</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+          <h5>Returns:</h5>
+          <dl>
+            <dt>Type</dt>
+            <dd>
+              <span class="param-type">Promise</span>
+            </dd>
+          </dl>
+          <h3 class="subsection-title">Type Definitions</h3>
+          <h4 class="name" id="initParameters">initParameters</h4>
+          <h5>Type:</h5>
+          <ul>
+            <li>
+              <span class="param-type">object</span>
+            </li>
+          </ul>
+          <h5 class="subsection-title">Properties:</h5>
+          <table class="props">
+            <thead>
+              <tr>
+                <th>Name</th>
+                <th>Type</th>
+                <th class="last">Description</th>
+              </tr>
+            </thead>
+            <tbody>
+              <tr>
+                <td class="name"><code>targetElementId</code></td>
+                <td class="type">
+                  <span class="param-type">string</span>
+                </td>
+                <td class="description last">target element where new elements will be appended</td>
+              </tr>
+              <tr>
+                <td class="name"><code>siteUrl:</code></td>
+                <td class="type">
+                  <span class="param-type">string</span>
+                </td>
+                <td class="description last">the url of the current site</td>
+              </tr>
+            </tbody>
+          </table>
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="peer-connection_audioPeer.js.html">peer-connection/audioPeer.js</a>,
+                  <a href="peer-connection_audioPeer.js.html#line7">line 7</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+        </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>

package/doc/index.html ADDED Viewed

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JSDoc: Home</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">Home</h1>
+      <h3></h3>
+    </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>

package/doc/listener.js.html ADDED Viewed

@@ -0,0 +1,170 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JSDoc: Source: listener.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: listener.js</h1>
+      <section>
+        <article>
+          <pre class="prettyprint source linenums"><code>import './listener.css';
+import AudioPeer from './audioPeer';
+/**
+ * @class Handles the listener's side of the connection. Responsible for getting access to user's microphone,
+ * and initiating a call to the Speaker.
+ * @extends AudioPeer
+ */
+class Listener extends AudioPeer {
+  /**
+   * Takes a target element where html elements will be appended.
+   * @param {initParameters} params - see type definition for initParameters
+   */
+  constructor(params) {
+    super(params);
+    this.startTime = Date.now();
+    this.receiverPeerId = null;
+    const urlParameters = this.parseURLSearchParams();
+    this.speakerPeerId = urlParameters.speakerPeerId;
+    this.peer.on('open', this.onPeerOpen);
+    this.peer.on('connection', this.onPeerConnection);
+    this.peer.on('disconnected', this.onPeerDisconnected);
+    this.peer.on('close', this.onPeerClose);
+    this.peer.on('error', this.onPeerError);
+  }
+  onPeerOpen = id => {
+    console.log('Listener - onPeerOpen');
+    // Workaround for peer.reconnect deleting previous id
+    if (id === null) {
+      console.log('Received null id from peer open');
+      this.peer.id = this.lastPeerId;
+    } else {
+      this.lastPeerId = this.peer.id;
+    }
+    this.join();
+  };
+  onPeerConnection = connection => {
+    console.log('Listener - onPeerConnection');
+    // Disallow incoming connections
+    connection.on('open', () => {
+      connection.send('Sender does not accept incoming connections');
+      setTimeout(() => {
+        connection.close();
+      }, 500);
+    });
+  };
+  onConnData = data => {
+    console.log('Listener - onConnData');
+    // Keypad has received data, namely instructions to update the keypad
+    // TODO generalize to a list of properies
+    const hasSpeakerID = Object.prototype.hasOwnProperty.call(data, 'speakerPeerId');
+    if (!hasSpeakerID) {
+      console.error('Error in parsing data received! Must set "speakerPeerId" properties');
+    } else {
+      // this.conn.close();
+      console.log(this.speakerPeerId);
+      this.speakerPeerId = data.speakerPeerId;
+      const newParams = {
+        speakerPeerId: this.speakerPeerId,
+      };
+      /*
+      FUTURE does this limit usable environments?
+      ie does this work if internet is lost after initial page load?
+      */
+      window.location.search = this.queryStringFromObject(newParams); // Redirect to correctly constructed keypad page
+    }
+  };
+  join = () => {
+    console.log('Listener - join');
+    /**
+     * Create the connection between the two Peers.
+     *
+     * Sets up callbacks that handle any events related to the
+     * connection and data received on it.
+     */
+    // Close old connection
+    if (this.conn) {
+      this.conn.close();
+    }
+    // Create connection to destination peer specified by the query param
+    this.conn = this.peer.connect(this.speakerPeerId, {
+      reliable: true,
+    });
+    this.conn.on('open', () => {
+      // console.log("TODO Implement real on connection fn");
+      this.openAudioStream();
+    });
+    // Handle incoming data (messages only since this is the signal sender)
+    this.conn.on('data', this.onConnData);
+    this.conn.on('close', () => {
+      console.log('Connection closed');
+    });
+  };
+  openAudioStream = async () => {
+    navigator.mediaDevices
+      .getUserMedia({video: false, audio: true})
+      .then(stream => {
+        this.peer.call(this.speakerPeerId, stream); // one-way call
+        console.log('Listener - openAudioStream');
+      })
+      .catch(err => {
+        console.log(`u got an error:${err}`);
+      });
+  };
+}
+export default Listener;
+</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="Listener.html">Listener</a></li>
+        <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
+        <li><a href="Speaker.html">Speaker</a></li>
+      </ul>
+      <h3><a href="global.html">Global</a></h3>
+    </nav>
+    <br class="clear" />
+    <footer>
+      Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue
+      Mar 01 2022 12:39:42 GMT-0500 (Eastern Standard Time)
+    </footer>
+    <script>
+      prettyPrint();
+    </script>
+    <script src="scripts/linenumber.js"></script>
+  </body>
+</html>

package/doc/mlsGen_mlsGenInterface.js.html ADDED Viewed

@@ -0,0 +1,117 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JSDoc: Source: mlsGen/mlsGenInterface.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: mlsGen/mlsGenInterface.js</h1>
+      <section>
+        <article>
+          <pre
+            class="prettyprint source linenums"
+          ><code>// eslint-disable-next-line import/extensions
+const createMLSGenModule = require('../../dist/mlsGen.js');
+/**
+ * MLSGenInterface provides a class for interfacing with the MLSGen WASM module.
+ */
+class MlsGenInterface {
+  /** @private */
+  #N = 18;
+  /** @private */
+  // eslint-disable-next-line no-bitwise
+  #P = (1 &lt;&lt; 18) - 1;
+  /** @private */
+  #MLSGen;
+  /** @private */
+  #WASMInstance;
+  /**
+   * Creates an instance of MlsGenInterface.
+   * Makes a call to the WASM glue code to load the WASM module.
+   */
+  constructor() {
+    // load the WASM module and save the instance.
+    createMLSGenModule().then((instance) => {
+      this.#WASMInstance = instance;
+      this.#MLSGen = new instance.MLSGen(this.N);
+      console.log(this.#MLSGen);
+    });
+  }
+  /*
+  TODO: Figure out the best way to interact with this module.
+        1. Return the MLS signal (as an array), appears problematic with the pointer bindings
+        2. Pass a buffer to the function to be filled with the MLS, I did this before but need
+           to go back and look at how it was done. Currently throwing an error.
+        3. Circumvent this all together by calling the webAudio API in the CPP code directly.
+  */
+  getMls = () => {
+  /**
+   * Calculate the Maximum Length Sequence (MLS) with period P = 2^N - 1
+   * using the MLSGen WASM module.
+   * @param {Number} N
+   */
+    // Get function.
+    const { HEAPU8 } = this.#WASMInstance;
+    // Create the arrays.
+    // eslint-disable-next-line no-bitwise
+    const offset = 0;
+    const result = new Uint8Array(HEAPU8.buffer, offset, this.#P);
+    // Call the function.
+    this.#MLSGen.getMls(result.byteOffset, this.#N, this.#P);
+    console.log(result);
+  }
+}
+export default MlsGenInterface;
+</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="Listener.html">Listener</a></li>
+        <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
+        <li><a href="Speaker.html">Speaker</a></li>
+      </ul>
+      <h3><a href="global.html">Global</a></h3>
+    </nav>
+    <br class="clear" />
+    <footer>
+      Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue
+      Mar 01 2022 12:39:42 GMT-0500 (Eastern Standard Time)
+    </footer>
+    <script>
+      prettyPrint();
+    </script>
+    <script src="scripts/linenumber.js"></script>
+  </body>
+</html>