Merge pull request #2028 from twilio/prep-2-28-1

Prep for 2.28.1

CHANGELOG.md

@@ -2,6 +2,14 @@ The Twilio Programmable Video SDKs use [Semantic Versioning](http://www.semver.o
 
 **Version 1.x reached End of Life on September 8th, 2021.** See the changelog entry [here](https://www.twilio.com/changelog/end-of-life-complete-for-unsupported-versions-of-the-programmable-video-sdk). Support for the 1.x version ended on December 4th, 2020.
 
+2.28.1 (October 3, 2023)
+========================
+
+Bug Fixes
+---------
+
+- Previously, a Chrome iOS 17 Participant's local audio (Krisp noise cancellation enabled) did not recover after foregrounding the browser following the playing of a YouTube video (or some other application which requires microphone permissions). We work around this by permanently disabling the Krisp noise cancellation upon foregrounding the browser. (VIDEO-13006)
+
 2.28.0 (September 14, 2023)
 ===========================
 

README.md

@@ -74,7 +74,7 @@ Releases of twilio-video.js are hosted on a CDN, and you can include these
 directly in your web app using a <script> tag.
 
 ```html
-<script src="//sdk.twilio.com/js/video/releases/2.28.0/twilio-video.min.js"></script>
+<script src="//sdk.twilio.com/js/video/releases/2.28.1/twilio-video.min.js"></script>
 ```
 
 Using this method, twilio-video.js will set a browser global:

lib/media/track/localaudiotrack.js

@@ -1,6 +1,8 @@
 'use strict';
 
 const { isIOS } = require('../../util/browserdetection');
+const detectSilentAudio = require('../../util/detectsilentaudio');
+const { isIOSChrome } = require('../../webrtc/util');
 const AudioTrack = require('./audiotrack');
 const mixinLocalMediaTrack = require('./localmediatrack');
 
@@ -162,7 +164,7 @@ class LocalAudioTrack extends LocalMediaAudioTrack {
   /**
    * @private
    */
-  _reacquireTrack(constraints)  {
+  _reacquireTrack(constraints) {
     this._log.debug('_reacquireTrack: ', constraints);
     if (this.noiseCancellation) {
       return this.noiseCancellation.reacquireTrack(() => {
@@ -188,6 +190,30 @@ class LocalAudioTrack extends LocalMediaAudioTrack {
     });
   }
 
+  /**
+   * NOTE(mmalavalli): On iOS 17 Chrome, a LocalAudioTrack with Krisp Noise Cancellation
+   * enabled that is restarted due to foregrounding the browser is silent for as-of-yet
+   * unknown reason. We work around this by discarding the Krisp MediaStreamTrack and using
+   * the source MediaStreamTrack. (VIDEO-13006)
+   * @private
+   */
+  _setMediaStreamTrack(mediaStreamTrack) {
+    const { _log: log, noiseCancellation } = this;
+    let promise = super._setMediaStreamTrack.call(this, mediaStreamTrack);
+
+    if (isIOSChrome() && !!noiseCancellation) {
+      log.debug('iOS Chrome detected, checking if the restarted Krisp audio is silent');
+      promise = promise.then(() => detectSilentAudio(this._dummyEl)).then(isSilent => {
+        log.debug(`Krisp audio is ${isSilent ? 'silent, using source audio' : 'not silent'}`);
+        return isSilent && noiseCancellation.disablePermanently().then(() => {
+          return super._setMediaStreamTrack.call(this, noiseCancellation.sourceTrack);
+        });
+      });
+    }
+
+    return promise;
+  }
+
   /**
    * Disable the {@link LocalAudioTrack}. This is equivalent to muting the audio source.
    * @returns {this}