twilio-video 2.26.0 → 2.26.2

package/CHANGELOG.md

@@ -2,6 +2,34 @@ 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.26.2 (February 21, 2023)
+==========================
+
+Changes
+-------
+
+- Starting from version 110, Chrome will no longer support the iSAC audio codec. The SDK will now log a warning to the console
+  whenever an audio or a video codec that is specified in `ConnectOptions.preferredAudioCodecs` and `ConnectOptions.preferredVideoCodecs`
+  is not supported by the browser. (VIDEO-12494)
+
+Bug Fixes
+---------
+
+- Fixed a bug on Chrome versions 112+ where `Room.getStats()` did not reject the returned Promise when an exception was
+  raised while accessing WebRTC stats that due to a TypeError caused by trying to read from the now-removed `RTCMediaStreamTrackStats`. (VIDEO-12534)
+
+2.26.1 (January 31, 2023)
+=========================
+
+Bug Fixes
+---------
+
+- Fixed a bug that manifests on Chrome versions 112+ where `Room.getStats()` raises an unhandled exception due to a
+  TypeError caused by trying to read from the now-removed `RTCMediaStreamTrackStats`. Instead, the SDK now reads from
+  the `RTCMediaSourceStats`. (VIDEO-12411) 
+- Fixed an error in the type definition for the `attach()` method of `AudioTrack` and `VideoTrack`. (VIDEO-12242)
+- Fixed an error in the type definition for `createLocalAudioTrack()`. (VIDEO-12383)
+
 2.26.0 (December 14, 2022)
 ==========================
 

package/COMMON_ISSUES.md

@@ -200,10 +200,10 @@ transform: scaleX(-1)
 </p>
 </details>
 <details>
-<summary>iOS 15: Audio is lost in a video call after an interruption with a phone call</summary>
+<summary>iOS 16: Local Media Tracks are lost in a video call after an interruption with a phone call</summary>
 <p>
 
-   Due to a regression on Safari on iOS 15, an incoming call causes local and sometimes remote media playback to stop. You can find more details in this [WebKit bug](https://bugs.webkit.org/show_bug.cgi?id=230537).
+   Due to a bug on Safari on iOS 16, an incoming call causes local and sometimes remote media playback to stop after the **second** incoming call. You can find more details in this [WebKit bug](https://bugs.webkit.org/show_bug.cgi?id=240651). As a workaround, you can call the [Room.refreshInactiveMedia](https://sdk.twilio.com/js/video/releases/2.26.0/docs/Room.html#refreshInactiveMedia__anchor) method in your application in order to restart the muted local media tracks and resume playback of the paused remote media tracks.
 </p>
 </details>
 <details>
@@ -348,7 +348,7 @@ trouble with twilio-video.js, ensure these are not running.
 <summary>setSinkId method is not implemented in all browsers</summary>
 <p>
 
-   The `audioElement.setSinkId()` method, which is used to change the audio output device for a given HTML audio element, is only implemented in Desktop Chrome and Desktop Edge. Therefore, it is not possible for users to change their audio output device in other browsers. Users will have to use their operating system settings to change their audio output device instead. 
+   The `audioElement.setSinkId()` method, which is used to change the audio output device for a given HTML audio element, is only implemented in Desktop Chrome and Desktop Edge. Therefore, it is not possible for users to change their audio output device in other browsers. Users will have to use their operating system settings to change their audio output device instead.
 
    More information about this method (including browser compatibility) is available [here](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/setSinkId).
 </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.26.0/twilio-video.min.js"></script>
+<script src="//sdk.twilio.com/js/video/releases/2.26.2/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.26.0
+/*! twilio-video.js 2.26.2
 
 The following license applies to all parts of this software except as
 documented below.
@@ -86,7 +86,7 @@ module.exports = createCancelableRoomPromise;
 },{"./util/cancelablepromise":124}],2:[function(require,module,exports){
 'use strict';
 var MediaStreamTrack = require('./webrtc').MediaStreamTrack;
-var _a = require('./webrtc/util'), guessBrowser = _a.guessBrowser, guessBrowserVersion = _a.guessBrowserVersion;
+var _a = require('./webrtc/util'), guessBrowser = _a.guessBrowser, guessBrowserVersion = _a.guessBrowserVersion, isCodecSupported = _a.isCodecSupported;
 var createCancelableRoomPromise = require('./cancelableroompromise');
 var EncodingParametersImpl = require('./encodingparameters');
 var LocalParticipant = require('./localparticipant');
@@ -407,6 +407,11 @@ function connect(token, options) {
         video: options.preferredVideoCodecs.map(normalizeCodecSettings)
     };
     var networkQualityConfiguration = new NetworkQualityConfigurationImpl(isNonArrayObject(options.networkQuality) ? options.networkQuality : {});
+    // Log warnings for any unsupported preferred codecs.
+    ['audio', 'video'].forEach(function (kind) { return preferredCodecs[kind].forEach(function (_a) {
+        var codec = _a.codec;
+        return isCodecSupported(codec, kind).then(function (isSupported) { return !isSupported && log.warn("The preferred " + kind + " codec \"" + codec + "\" will be ignored as it is not supported by the browser."); });
+    }); });
     // Create a CancelableRoomPromise<Room> that resolves after these steps:
     // 1 - Get the LocalTracks.
     // 2 - Create the LocalParticipant using options.tracks.
@@ -20258,6 +20263,9 @@ var WS_CLOSE_NETWORK_CHANGED = 3004;
 var WS_CLOSE_BUSY_WAIT = 3005;
 var WS_CLOSE_SERVER_BUSY = 3006;
 var WS_CLOSE_OPEN_TIMEOUT = 3007;
+// NOTE(joma): If you want to use close code 3008, please increment
+// the close code in test/integration/spec/docker/reconnection.js
+// line number 492.
 var toplevel = globalThis;
 var WebSocket = toplevel.WebSocket ? toplevel.WebSocket : require('ws');
 var CloseReason = {
@@ -26526,9 +26534,7 @@ function _getStats(peerConnection, options) {
     ], function (_a) {
         var _b = __read(_a, 3), tracks = _b[0], statsArrayName = _b[1], isRemote = _b[2];
         return tracks.map(function (track) {
-            return getTrackStats(peerConnection, track, Object.assign({
-                isRemote: isRemote
-            }, options)).then(function (trackStatsArray) {
+            return getTrackStats(peerConnection, track, Object.assign({ isRemote: isRemote }, options)).then(function (trackStatsArray) {
                 trackStatsArray.forEach(function (trackStats) {
                     trackStats.trackId = track.id;
                     statsResponse[statsArrayName].push(trackStats);
@@ -26760,14 +26766,14 @@ function getTracks(peerConnection, kind, localOrRemote) {
 function getTrackStats(peerConnection, track, options) {
     if (options === void 0) { options = {}; }
     if (typeof options.testForChrome !== 'undefined' || isChrome) {
-        return chromeOrSafariGetTrackStats(peerConnection, track);
+        return chromeOrSafariGetTrackStats(peerConnection, track, options);
     }
     if (typeof options.testForFirefox !== 'undefined' || isFirefox) {
-        return firefoxGetTrackStats(peerConnection, track, options.isRemote);
+        return firefoxGetTrackStats(peerConnection, track, options);
     }
     if (typeof options.testForSafari !== 'undefined' || isSafari) {
         if (typeof options.testForSafari !== 'undefined' || getSdpFormat() === 'unified') {
-            return chromeOrSafariGetTrackStats(peerConnection, track);
+            return chromeOrSafariGetTrackStats(peerConnection, track, options);
         }
         // NOTE(syerrapragada): getStats() is not supported on
         // Safari versions where plan-b is the SDP format
@@ -26783,33 +26789,31 @@ function getTrackStats(peerConnection, track, options) {
  * Get the standardized statistics for a particular MediaStreamTrack in Chrome or Safari.
  * @param {RTCPeerConnection} peerConnection
  * @param {MediaStreamTrack} track
+ * @param {object} options - Used for testing
  * @returns {Promise.<Array<StandardizedTrackStatsReport>>}
  */
-function chromeOrSafariGetTrackStats(peerConnection, track) {
-    return new Promise(function (resolve, reject) {
-        if (chromeMajorVersion && chromeMajorVersion < 67) {
+function chromeOrSafariGetTrackStats(peerConnection, track, options) {
+    if (chromeMajorVersion && chromeMajorVersion < 67) {
+        return new Promise(function (resolve, reject) {
             peerConnection.getStats(function (response) {
                 resolve([standardizeChromeLegacyStats(response, track)]);
             }, null, reject);
-            return;
-        }
-        peerConnection.getStats(track).then(function (response) {
-            resolve(standardizeChromeOrSafariStats(response));
-        }, reject);
+        });
+    }
+    return peerConnection.getStats(track).then(function (response) {
+        return standardizeChromeOrSafariStats(response, options);
     });
 }
 /**
  * Get the standardized statistics for a particular MediaStreamTrack in Firefox.
  * @param {RTCPeerConnection} peerConnection
  * @param {MediaStreamTrack} track
- * @param {boolean} isRemote
+ * @param {object} options
  * @returns {Promise.<Array<StandardizedTrackStatsReport>>}
  */
-function firefoxGetTrackStats(peerConnection, track, isRemote) {
-    return new Promise(function (resolve, reject) {
-        peerConnection.getStats(track).then(function (response) {
-            resolve([standardizeFirefoxStats(response, isRemote)]);
-        }, reject);
+function firefoxGetTrackStats(peerConnection, track, options) {
+    return peerConnection.getStats(track).then(function (response) {
+        return [standardizeFirefoxStats(response, options)];
     });
 }
 /**
@@ -26884,9 +26888,14 @@ function standardizeChromeLegacyStats(response, track) {
 /**
  * Standardize the MediaStreamTrack's statistics in Chrome or Safari.
  * @param {RTCStatsResponse} response
+ * @param {object} options - Used for testing
  * @returns {Array<StandardizedTrackStatsReport>}
  */
-function standardizeChromeOrSafariStats(response) {
+function standardizeChromeOrSafariStats(response, _a) {
+    var _b = _a.simulateExceptionWhileStandardizingStats, simulateExceptionWhileStandardizingStats = _b === void 0 ? false : _b;
+    if (simulateExceptionWhileStandardizingStats) {
+        throw new Error('Error while gathering stats');
+    }
     var inbound = null;
     // NOTE(mpatwardhan): We should expect more than one "outbound-rtp" stats for a
     // VP8 simulcast MediaStreamTrack.
@@ -26922,7 +26931,7 @@ function standardizeChromeOrSafariStats(response) {
                 break;
         }
     });
-    var isRemote = track && track.remoteSource;
+    var isRemote = track ? track.remoteSource : !localMedia;
     var mainSources = isRemote ? [inbound] : outbound;
     var stats = [];
     var remoteSource = isRemote ? remoteOutbound : remoteInbound; // remote rtp stats
@@ -26967,7 +26976,7 @@ function standardizeChromeOrSafariStats(response) {
             }
             else {
                 standardizedStats.frameWidthSent = frameWidth;
-                standardizedStats.frameWidthInput = track.frameWidth;
+                standardizedStats.frameWidthInput = track ? track.frameWidth : localMedia.width;
             }
         }
         var frameHeight = getStatValue('frameHeight');
@@ -26977,7 +26986,7 @@ function standardizeChromeOrSafariStats(response) {
             }
             else {
                 standardizedStats.frameHeightSent = frameHeight;
-                standardizedStats.frameHeightInput = track.frameHeight;
+                standardizedStats.frameHeightInput = track ? track.frameHeight : localMedia.height;
             }
         }
         var framesPerSecond = getStatValue('framesPerSecond');
@@ -27053,17 +27062,21 @@ function standardizeChromeOrSafariStats(response) {
 /**
  * Standardize the MediaStreamTrack's statistics in Firefox.
  * @param {RTCStatsReport} response
- * @param {boolean} isRemote
+ * @param {object} options - Used for testing
  * @returns {StandardizedTrackStatsReport}
  */
-function standardizeFirefoxStats(response, isRemote) {
+function standardizeFirefoxStats(response, _a) {
+    if (response === void 0) { response = new Map(); }
+    var isRemote = _a.isRemote, _b = _a.simulateExceptionWhileStandardizingStats, simulateExceptionWhileStandardizingStats = _b === void 0 ? false : _b;
+    if (simulateExceptionWhileStandardizingStats) {
+        throw new Error('Error while gathering stats');
+    }
     // NOTE(mroberts): If getStats is called on a closed RTCPeerConnection,
     // Firefox returns undefined instead of an RTCStatsReport. We workaround this
     // here. See the following bug for more details:
     //
     //   https://bugzilla.mozilla.org/show_bug.cgi?id=1377225
     //
-    if (response === void 0) { response = new Map(); }
     var inbound = null;
     var outbound = null;
     // NOTE(mmalavalli): Starting from Firefox 63, RTC{Inbound, Outbound}RTPStreamStats.isRemote
@@ -29092,18 +29105,79 @@ function support() {
         && typeof navigator.mediaDevices.getUserMedia === 'function'
         && typeof RTCPeerConnection === 'function';
 }
+/**
+ * Create a Set of supported codecs for a certain kind of media.
+ * @param {'audio'|'video'} kind
+ * @returns {Promise<Set<AudioCodec|VideoCodec>>}
+ */
+function createSupportedCodecsSet(kind) {
+    if (typeof RTCRtpSender !== 'undefined'
+        && typeof RTCRtpSender.getCapabilities === 'function') {
+        return Promise.resolve(new Set(RTCRtpSender
+            .getCapabilities(kind)
+            .codecs
+            .map(function (_a) {
+            var mimeType = _a.mimeType;
+            return mimeType.split('/')[1].toLowerCase();
+        })));
+    }
+    if (typeof RTCPeerConnection === 'undefined'
+        || typeof RTCPeerConnection.prototype === 'undefined'
+        || typeof RTCPeerConnection.prototype.addTransceiver !== 'function'
+        || typeof RTCPeerConnection.prototype.close !== 'function'
+        || typeof RTCPeerConnection.prototype.createOffer !== 'function') {
+        return Promise.resolve(new Set());
+    }
+    var pc = new RTCPeerConnection();
+    pc.addTransceiver(kind);
+    return pc.createOffer().then(function (_a) {
+        var sdp = _a.sdp;
+        pc.close();
+        return new Set((sdp.match(/^a=rtpmap:.+$/gm) || [])
+            .map(function (line) { return line.match(/^a=rtpmap:.+ ([^/]+)/)[1].toLowerCase(); }));
+    }, function () {
+        pc.close();
+        return new Set();
+    });
+}
+// NOTE(mmalavalli): Cache the supported audio and video codecs here.
+var supportedCodecs = new Map();
+/**
+ * Check whether a given codec for a certain kind of media is supported.
+ * @param {AudioCodec|VideoCodec} codec
+ * @param {'audio'|'video'} kind
+ * @returns {Promise<boolean>}
+ */
+function isCodecSupported(codec, kind) {
+    var codecs = supportedCodecs.get(kind);
+    if (codecs) {
+        return Promise.resolve(codecs.has(codec.toLowerCase()));
+    }
+    return createSupportedCodecsSet(kind).then(function (codecs) {
+        supportedCodecs.set(kind, codecs);
+        return codecs.has(codec.toLowerCase());
+    });
+}
+/**
+ * Clear cached supported codecs (unit tests only).
+ */
+function clearCachedSupportedCodecs() {
+    supportedCodecs.clear();
+}
 /**
  * @typedef {object} Deferred
  * @property {Promise} promise
  * @property {function} reject
  * @property {function} resolve
  */
+exports.clearCachedSupportedCodecs = clearCachedSupportedCodecs;
 exports.defer = defer;
 exports.delegateMethods = delegateMethods;
 exports.difference = difference;
 exports.flatMap = flatMap;
 exports.guessBrowser = guessBrowser;
 exports.guessBrowserVersion = guessBrowserVersion;
+exports.isCodecSupported = isCodecSupported;
 exports.isIOSChrome = isIOSChrome;
 exports.interceptEvent = interceptEvent;
 exports.legacyPromise = legacyPromise;
@@ -30009,7 +30083,7 @@ module.exports={
   "name": "twilio-video",
   "title": "Twilio Video",
   "description": "Twilio Video JavaScript Library",
-  "version": "2.26.0",
+  "version": "2.26.2",
   "homepage": "https://twilio.com",
   "author": "Mark Andrus Roberts <mroberts@twilio.com>",
   "contributors": [