ep_webrtc 1.1.0 → 2.0.2

package/README.md

@@ -74,20 +74,6 @@ Supported values for `"disabled"`:
 * `"soft"`: Initially disabled by default.
 * `"hard"`: Unavailable (it cannot be enabled).
 
-The camera's record resolution can be configured by setting `videoConstraints`
-to any [video
-constraints](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#parameters)
-value acceptable to client browsers. It has the following default value:
-
-```json
-  "ep_webrtc": {
-    "videoConstraints": {
-      "width": {"ideal": 160},
-      "height": {"ideal": 120}
-    }
-  }
-```
-
 ### Custom Activate Button
 
 The misnamed `listenClass` setting allows you to specify a CSS selector for an
@@ -199,10 +185,51 @@ Example:
   },
 ```
 
+### Microphone Settings
+
+The microphone can be configured by setting `audio.constraints` to any [audio
+constraints](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#parameters)
+value acceptable to client browsers. It has the following default value:
+
+```json
+  "ep_webrtc": {
+    "audio": {
+      "constraints": {
+        "autoGainControl": {"ideal": true},
+        "echoCancellation": {"ideal": true},
+        "noiseSuppression": {"ideal": true}
+      }
+    }
+  },
+```
+
+For a full list of available constraints, see [the
+standard](https://www.w3.org/TR/2022/CRD-mediacapture-streams-20220307/#constrainable-properties).
+
 ### Video Sizes
 
-To set a custom small and/or large size in pixels, for the video displays, set
-one or both of the following in your `settings.json`:
+The camera's record resolution can be configured by setting `video.constraints`
+to any [video
+constraints](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#parameters)
+value acceptable to client browsers. It has the following default value:
+
+```json
+  "ep_webrtc": {
+    "video": {
+      "constraints": {
+        "width": {"ideal": 160},
+        "height": {"ideal": 120}
+      }
+    }
+  },
+```
+
+For a full list of available constraints, see [the
+standard](https://www.w3.org/TR/2022/CRD-mediacapture-streams-20220307/#constrainable-properties).
+
+Changing the record resolution does not change the size of the displayed video
+widgets. To change the video widget size, set `video.sizes.small` and/or
+`video.sizes.large`:
 
 ```json
   "ep_webrtc": {
@@ -212,12 +239,9 @@ one or both of the following in your `settings.json`:
         "large": 400
       }
     }
-  }
+  },
 ```
 
-This only controls the size of the video display widget. To set the camera's
-record resolution, see the `videoConstraints` setting.
-
 ## Metrics
 
 You can see metrics for various errors that users have when attempting to

package/index.js

@@ -20,6 +20,7 @@ const crypto = require('crypto');
 const eejs = require('ep_etherpad-lite/node/eejs/');
 const sessioninfos = require('ep_etherpad-lite/node/handler/PadMessageHandler').sessioninfos;
 const stats = require('ep_etherpad-lite/node/stats');
+const util = require('util');
 
 let logger = {};
 for (const level of ['debug', 'info', 'warn', 'error']) {
@@ -30,16 +31,21 @@ const defaultSettings = {
   // The defaults here are overridden by the values in the `ep_webrtc` object from `settings.json`.
   enabled: true,
   audio: {
+    constraints: {
+      autoGainControl: {ideal: true},
+      echoCancellation: {ideal: true},
+      noiseSuppression: {ideal: true},
+    },
     disabled: 'none',
   },
   video: {
+    constraints: {
+      width: {ideal: 160},
+      height: {ideal: 120},
+    },
     disabled: 'none',
     sizes: {large: 260, small: 160},
   },
-  videoConstraints: {
-    width: {ideal: 160},
-    height: {ideal: 120},
-  },
   iceServers: [{urls: ['stun:stun.l.google.com:19302']}],
   listenClass: null,
   moreInfoUrl: {},
@@ -225,7 +231,7 @@ exports.eejsBlock_styles = (hookName, context) => {
 exports.loadSettings = async (hookName, {settings: {ep_webrtc: s = {}}}) => {
   settings = _.mergeWith({}, defaultSettings, s, (objV, srcV, key, obj, src) => {
     if (Array.isArray(srcV)) return _.cloneDeep(srcV); // Don't merge arrays, replace them.
-    if (src === s && key === 'videoConstraints') return _.cloneDeep(srcV);
+    if (src === s.video && key === 'constraints') return _.cloneDeep(srcV);
   });
   settings.configError = (() => {
     for (const k of ['audio', 'video']) {
@@ -237,8 +243,8 @@ exports.loadSettings = async (hookName, {settings: {ep_webrtc: s = {}}}) => {
     }
     return false;
   })();
-  logger.info('configured:', {
+  logger.info('configured:', util.inspect({
     ...settings,
     iceServers: settings.iceServers.map((s) => s.credential ? {...s, credential: '*****'} : s),
-  });
+  }, {depth: Infinity}));
 };

package/package.json

@@ -5,7 +5,7 @@
     "url": "git@github.com:ether/ep_webrtc.git",
     "type": "git"
   },
-  "version": "1.1.0",
+  "version": "2.0.2",
   "description": "WebRTC based audio/video chat to Etherpad",
   "author": "John McLear <john@mclear.co.uk>",
   "contributors": [],

package/static/js/adapter.js

@@ -2405,7 +2405,7 @@ function shimCreateOfferLegacy(window) {
           }
         }
       } else if (offerOptions.offerToReceiveAudio === true && !audioTransceiver) {
-        this.addTransceiver('audio');
+        this.addTransceiver('audio', { direction: 'recvonly' });
       }
 
       if (typeof offerOptions.offerToReceiveVideo !== 'undefined') {
@@ -2430,7 +2430,7 @@ function shimCreateOfferLegacy(window) {
           }
         }
       } else if (offerOptions.offerToReceiveVideo === true && !videoTransceiver) {
-        this.addTransceiver('video');
+        this.addTransceiver('video', { direction: 'recvonly' });
       }
     }
     return origCreateOffer.apply(this, arguments);

package/static/js/index.js

@@ -18,7 +18,7 @@
 require('./adapter');
 const padcookie = require('ep_etherpad-lite/static/js/pad_cookie').padcookie;
 
-const enableDebugLogging = false;
+let enableDebugLogging = false;
 const debug = (...args) => { if (enableDebugLogging) console.debug('ep_webrtc:', ...args); };
 
 const EventTargetPolyfill = (() => {
@@ -220,6 +220,7 @@ class PeerState extends EventTargetPolyfill {
       return;
     }
     this._debug('creating RTCPeerConnection with config', this._pcConfig);
+    this._debug('peer IDs:', peerIds);
     this._setRemoteStream(null);
     this._ids.from.instance = ++nextInstanceId;
     this._ids.to = peerIds;
@@ -341,7 +342,7 @@ class PeerState extends EventTargetPolyfill {
   }
 
   async receiveMessage(msg) {
-    if (this._closed) return debug('Ignoring message because PeerState is closed');
+    if (this._closed) return this._debug('Ignoring message because PeerState is closed');
     const {ids, candidate, description, hangup} = msg;
     if (hangup != null) {
       this.close(true);
@@ -464,6 +465,9 @@ exports.rtc = new class {
     this._trackLocks = {audio: new Mutex(), video: new Mutex()};
   }
 
+  get enableDebugLogging() { return enableDebugLogging; }
+  set enableDebugLogging(val) { enableDebugLogging = !!val; }
+
   // API HOOKS
 
   async postAceInit(hookName, {pad}) {
@@ -668,8 +672,8 @@ exports.rtc = new class {
         if (!addAudioTrack && !addVideoTrack) return new MediaStream();
         debug(`requesting permission to access ${devices.join(' and ')}`);
         const stream = await window.navigator.mediaDevices.getUserMedia({
-          audio: addAudioTrack,
-          video: addVideoTrack && this._settings.videoConstraints,
+          audio: addAudioTrack && this._settings.audio.constraints,
+          video: addVideoTrack && this._settings.video.constraints,
         });
         debug('successfully accessed device(s)');
         return stream;