twilio-video 2.16.0 → 2.18.1

package/CHANGELOG.md

@@ -1,9 +1,52 @@
 The Twilio Programmable Video SDKs use [Semantic Versioning](http://www.semver.org/). Twilio supports version N-1 for 12 months after the first GA release of version N. We recommend you upgrade to the latest version as soon as possible to avoid any breaking changes. Version 2.x is the lastest Video JavaScript SDK.
 
-**Version 1.x will End of Life on September 8th, 2021.** Check [this guide](https://www.twilio.com/docs/video/migrating-1x-2x) to plan your migration to the latest 2.x version. Support for the 1.x version ended on December 4th, 2020.
+**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.18.1 (October 29, 2021)
+=========================
+
+Changes
+-------
+
+- Added some metrics to track the usage of the **Preflight API Public Beta** (`runPreflight`). There are no changes to the public APIs in this release. (VIDEO-6891)
+
+2.18.0 (October 13, 2021)
+=========================
+
+New Features
+------------
+
+- When a LocalParticipant tries to publish a LocalVideoTrack in an [Audio Only Group Room](https://www.twilio.com/docs/video/api/rooms-resource#example-4-create-an-audio-only-group-room),
+  it will fail with a [RoomTrackKindNotSupportedError](https://sdk.twilio.com/js/video/releases/2.18.0/docs/RoomTrackKindNotSupportedError.html). (VIDEO-7242)
+
+Known Issue
+------------
+
+In Firefox, although the publishing of a LocalVideoTrack in an Audio Only Group Room fails,
+the **RoomTrackKindNotSupportedError** is not raised. We are actively working on fixing this issue.
+
+2.17.1 (September 21, 2021)
+===========================
+Bug Fixes
+---------
+
+- Fixed a regression in `2.17.0` which caused Chrome screen share tracks to be encoded at lower dimensions. (VIDEO-7000)
+
+2.17.0 (September 14, 2021)
+===========================
+New Features
+------------
+
+- twilio-video.js now supports Chrome on iOS versions 14.3 and above. (VIDEO-5723)
+
+Bug Fixes
+---------
+
+- Fixed a bug where the VideoTracks of Safari Participants with VP8 simulcast enabled sometimes had low frame rates. (VIDEO-6263)
+- Fixed a bug where the screen share track got restarted as a camera track if it was ended when the application was foreground. (VIDEO-3977)
 
 2.16.0 (August 11, 2021)
-====================
+========================
 **New Features**
 -----------------------
 
@@ -27,7 +70,6 @@ preflightTest.on('progress', (progress: string) => {
 
 preflightTest.on('failed', (error: Error) => {
   console.error('preflight error:', error);
-  deferred.reject && deferred.reject(error);
 });
 
 preflightTest.on('completed', (report: PreflightTestReport) => {
@@ -40,7 +82,7 @@ preflightTest.on('completed', (report: PreflightTestReport) => {
 The [PreflightTestReport](https://sdk.twilio.com/js/video/releases/2.16.0/docs/global.html#PreflightTestReport) generated by `preflightTest` on `completed` provides statistics that can be useful in cases where there is a poor connection. Some of the useful statistics in the report are as follows:
 
 - Packet loss, round trip time, and jitter observed on the connection
-- Network timing measurements on the `progess` events, such as time to connect or to receive media.
+- Network timing measurements on the `progress` events, such as time to connect or to receive media.
 - Ice candidates and selected ice candidate pairs
 
 `preflightTest` emits a `failed` event to indicate test failures. You can use the [PreflightProgress](https://sdk.stage.twilio.com/js/video/releases/2.16.0/docs/global.html#PreflightProgress) events to better understand where the test failed and refer to
@@ -152,6 +194,7 @@ Bug Fixes
 
 New Features
 ------------
+
 This release contains a significant update to the Bandwidth Profile API. It allows for more efficient use of bandwidth and CPU in multi-party applications. In addition it provides developers with more dynamic control over which video tracks are delivered to the client and the preferred video resolution of the tracks. These capabilities are provided via the Client Track Switch Off Control and Content Preferences settings.
 
 Existing Bandwidth Profile settings will continue to function as before, however we recommend developers update their Bandwidth Profile settings to make use of these new capabilities at their earliest convenience.

package/COMMON_ISSUES.md

@@ -9,23 +9,50 @@ before opening a new issue. We recommend regularly upgrading to the latest versi
 <details>
 <summary>Chrome memory leak might cause degraded experience in group rooms</summary>
 <p>
-  
+
    Chrome has a memory leak, which is most apparent in long running Group Rooms with 30+ Participants with most of them share media. For details, go [here](https://github.com/twilio/twilio-video.js/issues/1449).
 </p>
 </details>
 
+<details>
+<summary>With opus dtx enabled, sometimes background noise is heard on muted AudioTracks</summary>
+<p>
+
+   twilio-video.js enables DTX (discontinuous transmission) by default for opus. Webrtc has an issue which sometimes causes background noise to be heard on muted track when DTX is enabled, For details, see [here](https://bugs.chromium.org/p/webrtc/issues/detail?id=13051).
+   To workaround this issue, you can disable the dtx with:
+  ```js
+  const { connect } = require('twilio-video');
+
+  // Disable DTX for Opus.
+  connect('token', {
+    preferredAudioCodecs: [{ codec: 'opus', dtx: false }]
+  });
+  ```
+
+</p>
+</details>
+
+
+
 ### Chrome mobile
 <details>
+<summary>Chrome on iOS 15.1 crashes when publishing or muting a VideoTrack that is using an H264 codec</summary>
+<p>
+
+   This issue happens due to a regression on iOS 15.1 where using an H264 codec causes the browser to crash when joining a room or when muting the VideoTrack. Please use VP8 as a workaround for now. See more details [here](https://github.com/twilio/twilio-video.js/issues/1611).
+</p>
+</details>
+<details>
 <summary>Android Chrome on Pixel 3 receives corrupted video frames with codec VP8</summary>
 <p>
-  
-   This is an issue in the hardware VP8 encoder on the Pixel 3 devices. See [WebRTC ticket](https://bugs.chromium.org/p/webrtc/issues/detail?id=11337). To work around this issue, please set H264 as the preferred video codec on Pixel 3. ([Example](https://github.com/twilio/video-quickstart-android/issues/470#issuecomment-623042880)). 
-</p>  
+
+   This is an issue in the hardware VP8 encoder on the Pixel 3 devices. See [WebRTC ticket](https://bugs.chromium.org/p/webrtc/issues/detail?id=11337). To work around this issue, please set H264 as the preferred video codec on Pixel 3. ([Example](https://github.com/twilio/video-quickstart-android/issues/470#issuecomment-623042880)).
+</p>
 </details>
 <details>
 <summary>Android Chrome 81+ Participants fail to subscribe to H264 VideoTracks in Group Rooms</summary>
 <p>
-  
+
    This happens primarily due to this [Chromium Bug](https://bugs.chromium.org/p/chromium/issues/detail?id=1074421).
    We have added a workaround to the SDK in version 2.4.0. For earlier versions of the SDK,
    please apply the workaround discussed in this [GitHub Issue](https://github.com/twilio/twilio-video.js/issues/966#issuecomment-619212184).
@@ -33,18 +60,36 @@ before opening a new issue. We recommend regularly upgrading to the latest versi
 </details>
 
 ### Safari desktop
+<details>
+<summary>Safari 15.1 crashes when muting a VideoTrack that is using an H264 codec</summary>
+<p>
+
+   This issue happens due to a regression on Safari 15.1 where muting a VideoTrack that is using an H264 codec causes the browser to crash. Please use VP8 as a workaround for now. See more details [here](https://github.com/twilio/twilio-video.js/issues/1611).
+</p>
+</details>
+
+<details>
+<summary>Failures to publish tracks on Safari 15</summary>
+<p>
+
+   If your applications uses [Webrtc-adapter](https://github.com/webrtcHacks/adapter) as a dependency, please note that older versions of webrtc-adapter have a bug which leads to an error ("Client is unable to apply a remote media description - Attempted to assign to readonly property…") on Safari 15.
+
+   To fix this issue, please update your adapter.js version to the newer one (^7.7.1) with the [fix](https://github.com/webrtcHacks/adapter/commit/de0348c756b7bda11a700bf7ea9e9393cab16421)
+</p>
+</details>
+
 <details>
 <summary>Echo issues in Safari when using external microphone</summary>
 <p>
-  
+
    This is an echo cancellation bug in Safari's implementation of WebRTC. For more details, go [here](https://bugs.webkit.org/show_bug.cgi?id=213723).
-   and [here](https://github.com/twilio/twilio-video.js/issues/1433) 
-</p>  
+   and [here](https://github.com/twilio/twilio-video.js/issues/1433)
+</p>
 </details>
 <details>
 <summary>Angular applications missing audio and/or video tracks</summary>
 <p>
-  
+
    There is a misinteraction between one of Angular's libraries, Zone.js, and
    Safari's RTCPeerConnection APIs. For more information, see [here](https://github.com/angular/zone.js/issues/883)
    for the issue filed against Zone.js and [here](https://bugs.webkit.org/show_bug.cgi?id=175802)
@@ -55,49 +100,71 @@ before opening a new issue. We recommend regularly upgrading to the latest versi
 ```html
 <script src="node_modules/zone.js/dist/zone.js"></script>
 <script src="node_modules/zone.js/dist/webapis-rtc-peer-connection.js"></script>
-``` 
-</p>  
+```
+</p>
 </details>
 <details>
 <summary>After unpublishing a Track, Safari 12.1 Participants cannot publish Track(s) of the same kind</summary>
 <p>
-  
+
    Because of this Safari 12.1 [bug](https://bugs.webkit.org/show_bug.cgi?id=195489),
-   once a Participant unpublishes a MediaTrack of any kind (audio or video), it will not be able to publish another MediaTrack of the same kind.        DataTracks are not affected. We have escalated this bug to the Safari Team and are keeping track of related developments. 
-</p>  
+   once a Participant unpublishes a MediaTrack of any kind (audio or video), it will not be able to publish another MediaTrack of the same kind.        DataTracks are not affected. We have escalated this bug to the Safari Team and are keeping track of related developments.
+</p>
 </details>
 
 ### Safari mobile
 <details>
+<summary>iOS 15.1: Browser crashes when publishing or muting a VideoTrack that is using an H264 codec</summary>
+<p>
+
+   This issue happens due to a regression on iOS 15.1 where using an H264 codec causes the browser to crash when joining a room or when muting the VideoTrack. Please use VP8 as a workaround for now. See more details [here](https://github.com/twilio/twilio-video.js/issues/1611).
+</p>
+</details>
+<details>
+<summary>iOS 15: Low audio volume in Safari</summary>
+<p>
+
+   Safari on iOS version 15, sometimes routes audio to the earpiece and not the speakers by default. Which customers some time perceive as low audio volume. Find more details [here](https://github.com/twilio/twilio-video.js/issues/1586) and in this [WebKit bug](https://bugs.webkit.org/show_bug.cgi?id=230902).
+</p>
+</details>
+<details>
+<summary>iOS 15: Audio is 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).
+</p>
+</details>
+<details>
 <summary>Mobile Safari Participants on iOS 13.1-13.3 sometimes fail to send audio</summary>
 <p>
-    
-   This issue happened due to regression on iOS 13.1. The fix was released by Apple in iOS 13.4. Find more details in this [WebKit bug](https://bugs.webkit.org/show_bug.cgi?id=202405). 
-</p>  
+
+   This issue happened due to regression on iOS 13.1. The fix was released by Apple in iOS 13.4. Find more details in this [WebKit bug](https://bugs.webkit.org/show_bug.cgi?id=202405).
+</p>
 </details>
 <details>
 <summary>Stuttering/distorted audio in Safari on iOS 14.2 and MacOS 11.0.1</summary>
 <p>
-    
-   This issue happened due to regression in Safari's WebKit in iOS version 14.2, the fix got rolled out in iOS 14.3 beta3. Find more details [here](https://github.com/twilio/twilio-video.js/issues/1296) and in this [WebKit bug](https://bugs.webkit.org/show_bug.cgi?id=218762). 
-</p>  
+
+   This issue happened due to regression in Safari's WebKit in iOS version 14.2, the fix got rolled out in iOS 14.3 beta3. Find more details [here](https://github.com/twilio/twilio-video.js/issues/1296) and in this [WebKit bug](https://bugs.webkit.org/show_bug.cgi?id=218762).
+</p>
 </details>
 
+
 ### Firefox desktop
 <details>
 <summary>Firefox Participants sometimes fail to subscribe to DataTracks on Peer-to-Peer Rooms</summary>
 <p>
-    
-   Because of this Firefox [bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1603887) Participants that join a Peer-to-Peer Room after a DataTrack      has been published by a Firefox Participant fail to subscribe to it. You can work around this issue by publishing a DataTrack while connecting to    the Room. 
-</p>  
+
+   Because of this Firefox [bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1603887) Participants that join a Peer-to-Peer Room after a DataTrack      has been published by a Firefox Participant fail to subscribe to it. You can work around this issue by publishing a DataTrack while connecting to    the Room.
+</p>
 </details>
 <details>
 <summary>Firefox Participants cannot constrain their audio bandwidth</summary>
 <p>
-    
+
    Because of this [bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1573726), Firefox
-   Participants are not able to constrain their audio bandwidth using `LocalParticipant.setParameters()`. 
-</p>  
+   Participants are not able to constrain their audio bandwidth using `LocalParticipant.setParameters()`.
+</p>
 </details>
 
 ### All browsers
@@ -105,7 +172,7 @@ before opening a new issue. We recommend regularly upgrading to the latest versi
 <details>
 <summary>Working around the browsers' autoplay policy (which might block audio and video from playing)</summary>
 <p>
-    
+
    Chrome, Firefox and Safari enforce the autoplay policy, which blocks automatically
 playing audio or video if the user has not interacted with your application
 (ex: clicking a button to join a Room). You can find more details about the autoplay
@@ -135,7 +202,7 @@ remoteParticipant.on('trackSubscribed', track => {
 function isUserInteractionRequired(audioEl) {
   if (!audioEl.paused) {
     return Promise.resolve(false);
-  }  
+  }
   if (audioEl.hasAttribute('autoplay')) {
     return Promise.race([
       new Promise(resolve => audioEl.onplay = resolve),
@@ -149,7 +216,7 @@ function isUserInteractionRequired(audioEl) {
   });
 }
 ```
- 
+
 For RemoteVideoTracks, there are two ways to ensure playback:
 
 - Make sure that the user interacts with your application before joining a Room.
@@ -171,30 +238,30 @@ For RemoteVideoTracks, there are two ways to ensure playback:
   const video = videoTrack.attach();
   video.muted = true;
   ```
-</p>  
+</p>
 </details>
 <details>
 <summary>Support of Beta/Canary/Nightly browser releases</summary>
 <p>
-    
-   We constantly test for and ensure compatibility with the current stable and beta releases of supported browsers. 
-   However, because some of the APIs we rely upon, like WebRTC, are under active development in the browsers, 
+
+   We constantly test for and ensure compatibility with the current stable and beta releases of supported browsers.
+   However, because some of the APIs we rely upon, like WebRTC, are under active development in the browsers,
    we cannot guarantee compatibility with Canary or Nightly releases. Find our browsers support matrix [here](https://www.twilio.com/docs/video/javascript#supported-browsers)
-</p>  
+</p>
 </details>
 <details>
 <summary>Internet Explorer and other WebRTC-incompatible Browsers</summary>
 <p>
-    
+
    twilio-video.js requires WebRTC, which is not supported by Internet Explorer.
-   While twilio-video.js will load in Internet Explorer and other browsers that do not support WebRTC, 
+   While twilio-video.js will load in Internet Explorer and other browsers that do not support WebRTC,
    attempting to connect to a Room or attempting to acquire LocalTracks will fail. Find our browsers support matrix [here](https://www.twilio.com/docs/video/javascript#supported-browsers)
-</p>  
+</p>
 </details>
 <details>
 <summary>Aggressive Browser Extensions and Plugins</summary>
 <p>
-    
+
    Some browser extensions and plugins will disable WebRTC APIs, causing
 twilio-video.js to fail. Examples of such plugins include
 
@@ -204,5 +271,5 @@ twilio-video.js to fail. Examples of such plugins include
 
 These are unsupported and likely to break twilio-video.js. If you are having
 trouble with twilio-video.js, ensure these are not running.
-</p>  
+</p>
 </details>

package/README.md

@@ -1,13 +1,8 @@
-**NEW:** Please check out our [Best Practices Guide](https://www.twilio.com/docs/video/build-js-video-application-recommendations-and-best-practices)
-for building video applications with twilio-video.js.
-
 twilio-video.js
 ===============
 
 [![NPM](https://img.shields.io/npm/v/twilio-video.svg)](https://www.npmjs.com/package/twilio-video) [![CircleCI](https://circleci.com/gh/twilio/twilio-video.js/tree/master.svg?style=svg&circle-token=80e91c8284c21ff16d3003702e17b903c0b32f1d)](https://circleci.com/gh/twilio/twilio-video.js/tree/master)
 
-For 1.x, go [here](https://github.com/twilio/twilio-video.js/tree/support-1.x/).
-
 twilio-video.js allows you to add real-time voice and video to your web apps.
 
 * [API Docs](//sdk.twilio.com/js/video/latest/docs)
@@ -18,20 +13,22 @@ twilio-video.js allows you to add real-time voice and video to your web apps.
 
 **We want your feedback!** Please feel free to open a [GitHub issue](https://github.com/twilio/twilio-video.js/issues) for suggested improvements or feature requests. If you need technical support, contact [help@twilio.com](mailto:help@twilio.com).
 
+Changelog
+---------
+
+View [CHANGELOG.md](https://github.com/twilio/twilio-video.js/blob/master/CHANGELOG.md) for details about our releases.
+
 Browser Support
 ---------------
 
 |             | Chrome | Edge (Chromium) | Firefox | Safari |
 | ------------|--------|-----------------|---------|--------|
 | **Android** | ✓      | -               | ✓       | -      |
-| **iOS**     | *      | -               | *       | ✓      |
+| **iOS**     | ✓      | -               | *       | ✓      |
 | **Linux**   | ✓      | -               | ✓       | -      |
 | **macOS**   | ✓      | ✓ **            | ✓       | ✓      |
 | **Windows** | ✓      | ✓ **            | ✓       | -      |
 
-\* Chrome and Firefox for iOS do not have access to WebRTC APIs, unlike Safari
-for iOS.
-
 \*\* twilio-video.js supports the [Chromium-based Edge](https://www.microsoftedgeinsider.com/) browser.
 
 Installation
@@ -77,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.16.0/twilio-video.min.js"></script>
+<script src="//sdk.twilio.com/js/video/releases/2.18.1/twilio-video.min.js"></script>
 
 ```
 
@@ -139,11 +136,6 @@ function trackUnsubscribed(track) {
 }
 ```
 
-Changelog
----------
-
-See [CHANGELOG.md](https://github.com/twilio/twilio-video.js/blob/master/CHANGELOG.md).
-
 Content Security Policy (CSP)
 -----------------------------
 
@@ -165,10 +157,6 @@ script-src https://sdk.twilio.com
 Keep in mind, you may need to merge these policy directives with your own if
 you're using other services.
 
-License
--------
-
-See [LICENSE.md](https://github.com/twilio/twilio-video.js/blob/master/LICENSE.md).
 
 Building
 --------
@@ -224,9 +212,27 @@ Tips
 ln -s ../../pre-commit.sh .git/hooks/pre-commit
 ```
 
+Related
+-------
+### Applications using twilio-video.js
+- [Twilio Video React App](https://github.com/twilio/twilio-video-app-react)
+- [Twilio Video Javascript Quickstart](https://github.com/twilio/video-quickstart-js)
+- [Twilio Video Diagnostics App](https://github.com/twilio/twilio-video-diagnostics-react-app/blob/main/README.md)
+
+### Developer tools
+- [Twilio Video Processors](https://twilio.github.io/twilio-video-processors.js/index.html)
+- [Twilio Video Room Monitor](https://github.com/twilio/twilio-video-room-monitor.js)
+- [Twilio RTC Diagnostics SDK](https://github.com/twilio/rtc-diagnostics)
+
 Contributing
 ------------
 
 Bug fixes welcome! If you're not familiar with the GitHub pull
 request/contribution process,
 [this is a nice tutorial](https://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
+
+License
+-------
+
+See [LICENSE.md](https://github.com/twilio/twilio-video.js/blob/master/LICENSE.md).
+