speaker-calibration 2.2.270 → 2.2.272

package/doc/peer-connection_listener.js.html

@@ -1,311 +1,311 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <title>JSDoc: Source: peer-connection/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: peer-connection/listener.js</h1>
-
-      <section>
-        <article>
-          <pre class="prettyprint source linenums"><code>import AudioPeer from './audioPeer';
-import {UnsupportedDeviceError, MissingSpeakerIdError} from './peerErrors';
-
-/**
- * @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 => {
-    this.displayUpdate('Listener - onPeerOpen');
-    // Workaround for peer.reconnect deleting previous id
-
-    if (id === null) {
-      this.displayUpdate('Received null id from peer open');
-      this.peer.id = this.lastPeerId;
-    } else {
-      this.lastPeerId = this.peer.id;
-    }
-
-    this.join();
-  };
-
-  onPeerConnection = connection => {
-    this.displayUpdate('Listener - onPeerConnection');
-    // Disallow incoming connections
-    connection.on('open', () => {
-      connection.send('Sender does not accept incoming connections');
-      setTimeout(() => {
-        connection.close();
-      }, 500);
-    });
-  };
-
-  onConnData = data => {
-    this.displayUpdate('Listener - onConnData');
-    const hasSpeakerID = Object.prototype.hasOwnProperty.call(data, 'speakerPeerId');
-    if (!hasSpeakerID) {
-      this.displayUpdate('Error in parsing data received! Must set "speakerPeerId" property');
-      throw new MissingSpeakerIdError('Must set "speakerPeerId" property');
-    } else {
-      // this.conn.close();
-      this.displayUpdate(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 = () => {
-    this.displayUpdate('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.displayUpdate('Closing old connection');
-      this.conn.close();
-    }
-
-    // Create connection to destination peer specified by the query param
-    this.displayUpdate(`Creating connection to: ${this.speakerPeerId}`);
-    this.conn = this.peer.connect(this.speakerPeerId, {
-      reliable: true,
-    });
-
-    this.displayUpdate('Created connection');
-
-    this.conn.on('open', async () => {
-      this.displayUpdate('Listener - conn open');
-      // this.sendSamplingRate();
-      await 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');
-    });
-  };
-
-  getMobileOS = () => {
-    const ua = navigator.userAgent;
-    if (/android/i.test(ua)) {
-      return 'Android';
-    }
-    if (
-      /iPad|iPhone|iPod/.test(ua) ||
-      ((navigator?.userAgentData?.platform || navigator?.platform) === 'MacIntel' &amp;&amp;
-        navigator.maxTouchPoints > 1)
-    ) {
-      return 'iOS';
-    }
-    return 'Other';
-  };
-
-  sendSamplingRate = sampleRate => {
-    this.displayUpdate('Listener - sendSamplingRate');
-    this.conn.send({
-      name: 'samplingRate',
-      payload: sampleRate,
-    });
-  };
-
-  applyHQTrackConstraints = async stream => {
-    // Contraint the incoming audio to the sampling rate we want
-    const track = stream.getAudioTracks()[0];
-    const capabilities = track.getCapabilities();
-
-    this.displayUpdate(
-      `Listener Track Capabilities - ${JSON.stringify(capabilities, undefined, 2)}`
-    );
-
-    const constraints = track.getConstraints();
-
-    if (capabilities.echoCancellation) {
-      constraints.echoCancellation = false;
-    }
-
-    if (capabilities.sampleRate) {
-      constraints.sampleRate = 96000;
-    }
-
-    if (capabilities.sampleSize) {
-      constraints.sampleSize = 24;
-    }
-
-    if (capabilities.channelCount) {
-      constraints.channelCount = 1;
-    }
-
-    this.displayUpdate(`Listener Track Constraints - ${JSON.stringify(constraints, undefined, 2)}`);
-
-    // await the promise
-    try {
-      await track.applyConstraints(constraints);
-    } catch (err) {
-      console.error(err);
-      this.displayUpdate(`Error applying constraints to track: ${err}`);
-    }
-
-    const settings = track.getSettings();
-    this.displayUpdate(`Listener Track Settings - ${JSON.stringify(settings, undefined, 2)}`);
-    return settings.sampleRate;
-  };
-
-  getMediaDevicesAudioContraints = () => {
-    const availableConstraints = navigator.mediaDevices.getSupportedConstraints();
-
-    this.displayUpdate(
-      `Listener MediaDevices Available Contraints  - ${JSON.stringify(
-        availableConstraints,
-        undefined,
-        2
-      )}`
-    );
-
-    const contraints = {
-      // ...(availableConstraints.echoCancellation &amp;&amp; availableConstraints.echoCancellation == true
-      //   ? {echoCancellation: {exact: false}}
-      //   : {}),
-      ...(availableConstraints.sampleRate &amp;&amp; availableConstraints.sampleRate == true
-        ? {sampleRate: {ideal: 96000}}
-        : {}),
-      ...(availableConstraints.sampleSize &amp;&amp; availableConstraints.sampleSize == true
-        ? {sampleSize: {ideal: 24}}
-        : {}),
-      ...(availableConstraints.channelCount &amp;&amp; availableConstraints.channelCount == true
-        ? {channelCount: {exact: 1}}
-        : {}),
-    };
-
-    this.displayUpdate(
-      `Listener MediaDevices Contraints - ${JSON.stringify(contraints, undefined, 2)}`
-    );
-
-    return contraints;
-  };
-
-  openAudioStream = async () => {
-    this.displayUpdate('Listener - openAudioStream');
-    const mobileOS = this.getMobileOS();
-    if (process.env.NODE_ENV !== 'development' &amp;&amp; mobileOS !== 'iOS') {
-      const err = new UnsupportedDeviceError(`${mobileOS} is not supported`);
-      this.conn.send({
-        name: err.name,
-        payload: err,
-      });
-      return;
-    }
-
-    navigator.mediaDevices
-      .getUserMedia({
-        audio: this.getMediaDevicesAudioContraints(),
-        video: false,
-      })
-      .then(stream => {
-        this.applyHQTrackConstraints(stream)
-          .then(sampleRate => {
-            this.sendSamplingRate(sampleRate);
-            this.peer.call(this.speakerPeerId, stream); // one-way call
-            this.displayUpdate('Listener - openAudioStream');
-          })
-          .catch(err => {
-            console.log(err);
-            this.displayUpdate(
-              `Listener - Error in applyHQTrackConstraints - ${JSON.stringify(err, undefined, 2)}`
-            );
-          });
-      })
-      .catch(err => {
-        console.error(err);
-        this.displayUpdate(
-          `Listener - Error in getUserMedia - ${JSON.stringify(err, undefined, 2)}`
-        );
-      });
-  };
-}
-
-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="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/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: peer-connection/listener.js</h1>
+
+      <section>
+        <article>
+          <pre class="prettyprint source linenums"><code>import AudioPeer from './audioPeer';
+import {UnsupportedDeviceError, MissingSpeakerIdError} from './peerErrors';
+
+/**
+ * @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 => {
+    this.displayUpdate('Listener - onPeerOpen');
+    // Workaround for peer.reconnect deleting previous id
+
+    if (id === null) {
+      this.displayUpdate('Received null id from peer open');
+      this.peer.id = this.lastPeerId;
+    } else {
+      this.lastPeerId = this.peer.id;
+    }
+
+    this.join();
+  };
+
+  onPeerConnection = connection => {
+    this.displayUpdate('Listener - onPeerConnection');
+    // Disallow incoming connections
+    connection.on('open', () => {
+      connection.send('Sender does not accept incoming connections');
+      setTimeout(() => {
+        connection.close();
+      }, 500);
+    });
+  };
+
+  onConnData = data => {
+    this.displayUpdate('Listener - onConnData');
+    const hasSpeakerID = Object.prototype.hasOwnProperty.call(data, 'speakerPeerId');
+    if (!hasSpeakerID) {
+      this.displayUpdate('Error in parsing data received! Must set "speakerPeerId" property');
+      throw new MissingSpeakerIdError('Must set "speakerPeerId" property');
+    } else {
+      // this.conn.close();
+      this.displayUpdate(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 = () => {
+    this.displayUpdate('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.displayUpdate('Closing old connection');
+      this.conn.close();
+    }
+
+    // Create connection to destination peer specified by the query param
+    this.displayUpdate(`Creating connection to: ${this.speakerPeerId}`);
+    this.conn = this.peer.connect(this.speakerPeerId, {
+      reliable: true,
+    });
+
+    this.displayUpdate('Created connection');
+
+    this.conn.on('open', async () => {
+      this.displayUpdate('Listener - conn open');
+      // this.sendSamplingRate();
+      await 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');
+    });
+  };
+
+  getMobileOS = () => {
+    const ua = navigator.userAgent;
+    if (/android/i.test(ua)) {
+      return 'Android';
+    }
+    if (
+      /iPad|iPhone|iPod/.test(ua) ||
+      ((navigator?.userAgentData?.platform || navigator?.platform) === 'MacIntel' &amp;&amp;
+        navigator.maxTouchPoints > 1)
+    ) {
+      return 'iOS';
+    }
+    return 'Other';
+  };
+
+  sendSamplingRate = sampleRate => {
+    this.displayUpdate('Listener - sendSamplingRate');
+    this.conn.send({
+      name: 'samplingRate',
+      payload: sampleRate,
+    });
+  };
+
+  applyHQTrackConstraints = async stream => {
+    // Contraint the incoming audio to the sampling rate we want
+    const track = stream.getAudioTracks()[0];
+    const capabilities = track.getCapabilities();
+
+    this.displayUpdate(
+      `Listener Track Capabilities - ${JSON.stringify(capabilities, undefined, 2)}`
+    );
+
+    const constraints = track.getConstraints();
+
+    if (capabilities.echoCancellation) {
+      constraints.echoCancellation = false;
+    }
+
+    if (capabilities.sampleRate) {
+      constraints.sampleRate = 96000;
+    }
+
+    if (capabilities.sampleSize) {
+      constraints.sampleSize = 24;
+    }
+
+    if (capabilities.channelCount) {
+      constraints.channelCount = 1;
+    }
+
+    this.displayUpdate(`Listener Track Constraints - ${JSON.stringify(constraints, undefined, 2)}`);
+
+    // await the promise
+    try {
+      await track.applyConstraints(constraints);
+    } catch (err) {
+      console.error(err);
+      this.displayUpdate(`Error applying constraints to track: ${err}`);
+    }
+
+    const settings = track.getSettings();
+    this.displayUpdate(`Listener Track Settings - ${JSON.stringify(settings, undefined, 2)}`);
+    return settings.sampleRate;
+  };
+
+  getMediaDevicesAudioContraints = () => {
+    const availableConstraints = navigator.mediaDevices.getSupportedConstraints();
+
+    this.displayUpdate(
+      `Listener MediaDevices Available Contraints  - ${JSON.stringify(
+        availableConstraints,
+        undefined,
+        2
+      )}`
+    );
+
+    const contraints = {
+      // ...(availableConstraints.echoCancellation &amp;&amp; availableConstraints.echoCancellation == true
+      //   ? {echoCancellation: {exact: false}}
+      //   : {}),
+      ...(availableConstraints.sampleRate &amp;&amp; availableConstraints.sampleRate == true
+        ? {sampleRate: {ideal: 96000}}
+        : {}),
+      ...(availableConstraints.sampleSize &amp;&amp; availableConstraints.sampleSize == true
+        ? {sampleSize: {ideal: 24}}
+        : {}),
+      ...(availableConstraints.channelCount &amp;&amp; availableConstraints.channelCount == true
+        ? {channelCount: {exact: 1}}
+        : {}),
+    };
+
+    this.displayUpdate(
+      `Listener MediaDevices Contraints - ${JSON.stringify(contraints, undefined, 2)}`
+    );
+
+    return contraints;
+  };
+
+  openAudioStream = async () => {
+    this.displayUpdate('Listener - openAudioStream');
+    const mobileOS = this.getMobileOS();
+    if (process.env.NODE_ENV !== 'development' &amp;&amp; mobileOS !== 'iOS') {
+      const err = new UnsupportedDeviceError(`${mobileOS} is not supported`);
+      this.conn.send({
+        name: err.name,
+        payload: err,
+      });
+      return;
+    }
+
+    navigator.mediaDevices
+      .getUserMedia({
+        audio: this.getMediaDevicesAudioContraints(),
+        video: false,
+      })
+      .then(stream => {
+        this.applyHQTrackConstraints(stream)
+          .then(sampleRate => {
+            this.sendSamplingRate(sampleRate);
+            this.peer.call(this.speakerPeerId, stream); // one-way call
+            this.displayUpdate('Listener - openAudioStream');
+          })
+          .catch(err => {
+            console.log(err);
+            this.displayUpdate(
+              `Listener - Error in applyHQTrackConstraints - ${JSON.stringify(err, undefined, 2)}`
+            );
+          });
+      })
+      .catch(err => {
+        console.error(err);
+        this.displayUpdate(
+          `Listener - Error in getUserMedia - ${JSON.stringify(err, undefined, 2)}`
+        );
+      });
+  };
+}
+
+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="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>