twilio-video 2.27.0 → 2.28.1

package/CHANGELOG.md

@@ -2,6 +2,24 @@ 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)
+===========================
+
+Bug Fixes
+---------
+
+- Fixed a bug where a Chrome iOS 17 Participant's local and remote media (Krisp Noise Cancellation enabled) failed to recover after interacting with a PSTN call in full-screen mode. (VIDEO-13011)
+- Fixed a bug where a Chrome iOS 17 Participant's audio with Krisp Noise Cancellation did not recover after interacting with a system popup. (VIDEO-13012)
+- Fixed a bug where a Chrome iOS 17 Participant's audio with Krisp Noise Cancellation did not recover after invoking Siri. (VIDEO-13013)
+
 2.27.0 (March 21, 2023)
 =======================
 

package/COMMON_ISSUES.md

@@ -33,6 +33,12 @@ before opening a new issue. We recommend regularly upgrading to the latest versi
 
 ### Chrome mobile
 <details>
+<summary>iOS 17: Media issues</summary>
+<p>
+  Please refer to this [GitHub Issue](https://github.com/twilio/twilio-video.js/issues/2023) for details.
+</p>
+</details>
+<details>
 <summary>Android 11: Participants are unable to connect to a room due to ICE gathering failures on certain devices</summary>
 <p>
 
@@ -93,6 +99,12 @@ transform: scaleX(-1)
 
 ### Safari mobile
 <details>
+<summary>iOS 17: Media issues</summary>
+<p>
+  Please refer to this [GitHub Issue](https://github.com/twilio/twilio-video.js/issues/2023) for details.
+</p>
+</details>
+<details>
 <summary>iOS 15: Echo issues on iOS 15 devices after attaching video tracks</summary>
 <p>
 

package/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.27.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:

package/dist/twilio-video.js

@@ -1,4 +1,4 @@
-/*! twilio-video.js 2.27.0
+/*! twilio-video.js 2.28.1
 
 The following license applies to all parts of this software except as
 documented below.
@@ -2627,7 +2627,9 @@ var LocalParticipant = /** @class */ (function (_super) {
  * @event LocalParticipant#trackPublicationFailed
  */
 /**
- * A {@link LocalTrack} was successfully published.
+ * A {@link LocalTrack} that was added using {@link LocalParticipant#publishTrack} was successfully published. This event
+ * is not raised for {@link LocalTrack}s added in {@link ConnectOptions}<code>.tracks</code> or auto-created within
+ * <a href="module-twilio-video.html#.connect__anchor"><code>{@link connect}</code></a>.
  * @param {LocalTrackPublication} publication - The resulting
  *   {@link LocalTrackPublication} for the published {@link LocalTrack}
  * @event LocalParticipant#trackPublished
@@ -3042,6 +3044,8 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 var isIOS = require('../../util/browserdetection').isIOS;
+var detectSilentAudio = require('../../util/detectsilentaudio');
+var isIOSChrome = require('../../webrtc/util').isIOSChrome;
 var AudioTrack = require('./audiotrack');
 var mixinLocalMediaTrack = require('./localmediatrack');
 var LocalMediaAudioTrack = mixinLocalMediaTrack(AudioTrack);
@@ -3224,6 +3228,28 @@ var LocalAudioTrack = /** @class */ (function (_super) {
             _this._maybeRestartOnDefaultDeviceChange();
         });
     };
+    /**
+     * 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
+     */
+    LocalAudioTrack.prototype._setMediaStreamTrack = function (mediaStreamTrack) {
+        var _this = this;
+        var _a = this, log = _a._log, noiseCancellation = _a.noiseCancellation;
+        var promise = _super.prototype._setMediaStreamTrack.call(this, mediaStreamTrack);
+        if (isIOSChrome() && !!noiseCancellation) {
+            log.debug('iOS Chrome detected, checking if the restarted Krisp audio is silent');
+            promise = promise.then(function () { return detectSilentAudio(_this._dummyEl); }).then(function (isSilent) {
+                log.debug("Krisp audio is " + (isSilent ? 'silent, using source audio' : 'not silent'));
+                return isSilent && noiseCancellation.disablePermanently().then(function () {
+                    return _super.prototype._setMediaStreamTrack.call(_this, noiseCancellation.sourceTrack);
+                });
+            });
+        }
+        return promise;
+    };
     /**
      * Disable the {@link LocalAudioTrack}. This is equivalent to muting the audio source.
      * @returns {this}
@@ -3343,7 +3369,7 @@ var LocalAudioTrack = /** @class */ (function (_super) {
  */
 module.exports = LocalAudioTrack;
 
-},{"../../util/browserdetection":123,"./audiotrack":14,"./localmediatrack":24}],21:[function(require,module,exports){
+},{"../../util/browserdetection":123,"../../util/detectsilentaudio":126,"../../webrtc/util":170,"./audiotrack":14,"./localmediatrack":24}],21:[function(require,module,exports){
 'use strict';
 var __extends = (this && this.__extends) || (function () {
     var extendStatics = function (d, b) {
@@ -3593,7 +3619,7 @@ var __extends = (this && this.__extends) || (function () {
 })();
 var getUserMedia = require('../../webrtc').getUserMedia;
 var isIOS = require('../../util/browserdetection').isIOS;
-var _a = require('../../util'), capitalize = _a.capitalize, defer = _a.defer, isUserMediaTrack = _a.isUserMediaTrack, waitForSometime = _a.waitForSometime, waitForEvent = _a.waitForEvent;
+var _a = require('../../util'), capitalize = _a.capitalize, defer = _a.defer, waitForSometime = _a.waitForSometime, waitForEvent = _a.waitForEvent;
 var ILLEGAL_INVOKE = require('../../util/constants').typeErrors.ILLEGAL_INVOKE;
 var detectSilentAudio = require('../../util/detectsilentaudio');
 var detectSilentVideo = require('../../util/detectsilentvideo');
@@ -3622,7 +3648,6 @@ function mixinLocalMediaTrack(AudioOrVideoTrack) {
         function LocalMediaTrack(mediaStreamTrack, options) {
             var _this = this;
             var workaroundWebKitBug1208516 = isIOS()
-                && isUserMediaTrack(mediaStreamTrack)
                 && typeof document === 'object'
                 && typeof document.addEventListener === 'function'
                 && typeof document.visibilityState === 'string';
@@ -3668,6 +3693,9 @@ function mixinLocalMediaTrack(AudioOrVideoTrack) {
                 _isCreatedByCreateLocalTracks: {
                     value: options.isCreatedByCreateLocalTracks
                 },
+                _noiseCancellation: {
+                    value: options.noiseCancellation || null
+                },
                 _trackSender: {
                     value: mediaTrackSender
                 },
@@ -3856,9 +3884,16 @@ function mixinLocalMediaTrack(AudioOrVideoTrack) {
  * @returns {function} Clean up listeners attached by the workaround
  */
 function restartWhenInadvertentlyStopped(localMediaTrack) {
-    var log = localMediaTrack._log, kind = localMediaTrack.kind;
-    var detectSilence = { audio: detectSilentAudio, video: detectSilentVideo }[kind];
-    var el = localMediaTrack._dummyEl, mediaStreamTrack = localMediaTrack.mediaStreamTrack;
+    var log = localMediaTrack._log, kind = localMediaTrack.kind, noiseCancellation = localMediaTrack._noiseCancellation;
+    var detectSilence = {
+        audio: detectSilentAudio,
+        video: detectSilentVideo
+    }[kind];
+    var getSourceMediaStreamTrack = function () { return noiseCancellation
+        ? noiseCancellation.sourceTrack
+        : localMediaTrack.mediaStreamTrack; };
+    var el = localMediaTrack._dummyEl;
+    var mediaStreamTrack = getSourceMediaStreamTrack();
     var trackChangeInProgress = null;
     function checkSilence() {
         // The dummy element is paused, so play it and then detect silence.
@@ -3880,8 +3915,9 @@ function restartWhenInadvertentlyStopped(localMediaTrack) {
         });
     }
     function shouldReacquireTrack() {
-        var _workaroundWebKitBug1208516Cleanup = localMediaTrack._workaroundWebKitBug1208516Cleanup, isStopped = localMediaTrack.isStopped, muted = localMediaTrack.mediaStreamTrack.muted;
+        var _workaroundWebKitBug1208516Cleanup = localMediaTrack._workaroundWebKitBug1208516Cleanup, isStopped = localMediaTrack.isStopped;
         var isInadvertentlyStopped = isStopped && !!_workaroundWebKitBug1208516Cleanup;
+        var muted = getSourceMediaStreamTrack().muted;
         // NOTE(mmalavalli): Restart the LocalMediaTrack if:
         // 1. The app is foregrounded, and
         // 2. A restart is not already in progress, and
@@ -3902,7 +3938,7 @@ function restartWhenInadvertentlyStopped(localMediaTrack) {
                 localMediaTrack._restart().finally(function () {
                     el = localMediaTrack._dummyEl;
                     removeMediaStreamTrackListeners();
-                    mediaStreamTrack = localMediaTrack.mediaStreamTrack;
+                    mediaStreamTrack = getSourceMediaStreamTrack();
                     addMediaStreamTrackListeners();
                     trackChangeInProgress.resolve();
                     trackChangeInProgress = null;
@@ -4146,7 +4182,6 @@ var isIOS = require('../../util/browserdetection').isIOS;
 var detectSilentVideo = require('../../util/detectsilentvideo');
 var mixinLocalMediaTrack = require('./localmediatrack');
 var VideoTrack = require('./videotrack');
-var isUserMediaTrack = require('../../util').isUserMediaTrack;
 var LocalMediaVideoTrack = mixinLocalMediaTrack(VideoTrack);
 /**
  * A {@link LocalVideoTrack} is a {@link VideoTrack} representing video that
@@ -4180,7 +4215,6 @@ var LocalVideoTrack = /** @class */ (function (_super) {
         var _this = this;
         options = Object.assign({
             workaroundSilentLocalVideo: isIOS()
-                && isUserMediaTrack(mediaStreamTrack)
                 && typeof document !== 'undefined'
                 && typeof document.createElement === 'function'
         }, options);
@@ -4494,7 +4528,7 @@ function workaroundSilentLocalVideo(localVideoTrack, doc) {
  */
 module.exports = LocalVideoTrack;
 
-},{"../../util":132,"../../util/browserdetection":123,"../../util/detectsilentvideo":127,"./localmediatrack":24,"./videotrack":43}],27:[function(require,module,exports){
+},{"../../util/browserdetection":123,"../../util/detectsilentvideo":127,"./localmediatrack":24,"./videotrack":43}],27:[function(require,module,exports){
 'use strict';
 var __extends = (this && this.__extends) || (function () {
     var extendStatics = function (d, b) {
@@ -22664,16 +22698,6 @@ function isChromeScreenShareTrack(track) {
     // we will check for label that starts with "screen:D" where D being a digit.
     return util.guessBrowser() === 'chrome' && track.kind === 'video' && 'displaySurface' in track.getSettings();
 }
-/**
- * returns true if given MediaStreamTrack is a user media track
- * @private
- * @param {MediaStreamTrack} track
- * @returns {boolean}
- */
-function isUserMediaTrack(track) {
-    // NOTE(mpatwardhan): tracks obtained from getUserMedia have a deviceId in its settings.
-    return typeof track.getSettings().deviceId === 'string';
-}
 /**
  * Returns a promise that resolve after timeoutMS have passed.
  * @param {number} timeoutMS - time to wait in milliseconds.
@@ -22729,7 +22753,6 @@ exports.trackPublicationClass = trackPublicationClass;
 exports.valueToJSON = valueToJSON;
 exports.withJitter = withJitter;
 exports.isChromeScreenShareTrack = isChromeScreenShareTrack;
-exports.isUserMediaTrack = isUserMediaTrack;
 exports.waitForSometime = waitForSometime;
 exports.waitForEvent = waitForEvent;
 
@@ -30152,7 +30175,7 @@ module.exports={
   "name": "twilio-video",
   "title": "Twilio Video",
   "description": "Twilio Video JavaScript Library",
-  "version": "2.27.0",
+  "version": "2.28.1",
   "homepage": "https://twilio.com",
   "author": "Mark Andrus Roberts <mroberts@twilio.com>",
   "contributors": [
@@ -30174,6 +30197,8 @@ module.exports={
   },
   "devDependencies": {
     "@babel/core": "^7.14.2",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
     "@babel/preset-env": "^7.14.2",
     "@babel/preset-typescript": "^7.13.0",
     "@types/express": "^4.11.0",