twilio-video 2.17.0 → 2.18.2

package/CHANGELOG.md

@@ -1,6 +1,44 @@
 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.2 (December 15, 2021)
+==========================
+
+Bug Fixes
+---------
+
+- Fixed a bug where setting `clientTrackSwitchOffControl` to `auto` caused the RemoteVideoTracks to get switched off while playing in picture-in-picture mode. Note that this fix does not apply to Firefox as it does not yet implement [picture-in-picture](https://developer.mozilla.org/en-US/docs/Web/API/Picture-in-Picture_API) APIs. (VIDEO-6677)
+
+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)
 ===========================
@@ -40,7 +78,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) => {

package/COMMON_ISSUES.md

@@ -36,6 +36,13 @@ before opening a new issue. We recommend regularly upgrading to the latest versi
 
 ### Chrome mobile
 <details>
+<summary>Android 12: Video distortion on Chrome when hardware acceleration is enabled</summary>
+<p>
+
+   This is a VP8 encoder issue on Android 12. Please see this [github ticket](https://github.com/twilio/twilio-video.js/issues/1627) and this [Chrome bug](https://bugs.chromium.org/p/chromium/issues/detail?id=1237677) for more details.
+</p>
+</details>
+<details>
 <summary>Android Chrome on Pixel 3 receives corrupted video frames with codec VP8</summary>
 <p>
 
@@ -53,6 +60,23 @@ before opening a new issue. We recommend regularly upgrading to the latest versi
 </details>
 
 ### Safari desktop
+<details>
+<summary>Browser crashes when muting a VideoTrack that is using an H264 codec on Safari 15.1</summary>
+<p>
+
+   Due to a regression on Safari 15.1, the browser crashes when a VideoTrack is muted that is using an H264 codec. 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>
@@ -89,6 +113,111 @@ before opening a new issue. We recommend regularly upgrading to the latest versi
 
 ### Safari mobile
 <details>
+<summary>iOS 15: VideoTracks goes black and the page freezes on certain interruptions</summary>
+<p>
+
+   Certain interruptions such as incoming calls, backgrounding the browser or switching between apps causes VideoTracks on Chrome and Safari on iOS 15.1 to go black. Sometimes, the whole page also freezes and become unresponsive causing audio and video to cut off. These issues are regressions on iOS 15.1. See the following bugs for more details.
+
+   * [Page freezing](https://bugs.webkit.org/show_bug.cgi?id=230922#c12)
+   * [VideoTrack going black](https://bugs.webkit.org/show_bug.cgi?id=232599)
+
+   A workaround can be implemented to prevent the VideoTrack from going black. This workaround however doesn't prevent the issue where sometimes the page freezes. It is recommended to apply this workaround on Chrome and Safari on iOS 15.1.
+
+  ```js
+  // Keeps track of video elements and their event listeners
+  const videoElements = {};
+
+  // Listen to onPlay and onPause events and intelligently re-attach the video element
+  function shimVideoElement(track, el) {
+    let wasInterrupted = false;
+
+    const onPause = () => {
+      wasInterrupted = true;
+    };
+
+    const onPlay = () => {
+      if (wasInterrupted) {
+        track.detach(el);
+        track.attach(el);
+        wasInterrupted = false;
+      }
+    };
+
+    el.addEventListener('pause', onPause);
+    el.addEventListener('play', onPlay);
+
+    // Track this element so we can remove the listeners
+    videoElements[el] = { onPause, onPlay };
+  }
+  ```
+
+  Apply the workaround after attaching the video element.
+
+  ```js
+  videoTrack.attach(videoElement);
+  shimVideoElement(videoTrack, videoElement);
+  ```
+
+  Remove the listeners before detaching the video element.
+
+  ```js
+  const { onPause, onPlay } = videoElements[videoElement];
+  videoElement.removeEventListener('pause', onPause);
+  videoElement.removeEventListener('play', onPlay);
+  ```
+</p>
+</details>
+<details>
+<summary>iOS 15: Browser crashes when publishing or muting a VideoTrack that is using an H264 codec</summary>
+<p>
+
+   Chrome and Safari on iOS 15.1 crashes when a VideoTrack is muted or published using an H264 codec. This issue happens due to a regression on iOS 15.1. 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). As a workaround, you can pipe all remote audio tracks into a single audio context for iOS 15. Using a gain node, you can increase the gain value to increase the audio volume levels. See example below.
+
+   ```js
+   // Make sure to reuse the audioContext object as browsers
+   // have limits to the number of AudioContext instances you can create.
+   const audioContext = new (window.AudioContext || window.webkitAudioContext)();
+
+   function attachAudioTrack(remoteAudioTrack) {
+     const audioNode = audioContext.createMediaStreamSource(new MediaStream([remoteAudioTrack.mediaStreamTrack]));
+     const gainNode = audioContext.createGain();
+     
+     // Adjust this value depending on your customers' preference
+     gainNode.gain.value = 20;
+     
+     audioNode.connect(gainNode);
+     gainNode.connect(audioContext.destination);
+   }
+
+   // Attach the RemoteAudioTrack once received.
+   attachAudioTrack(remoteAudioTrack);
+   ```
+
+   This workaround has the following potential side effects.
+
+   * There is a possibility of the introduction of echo. Please adjust the gain value and check for echo while testing the workaround.
+   * The output volume might end up really high if the user switches headsets.
+   * The default volume might end up really high once Apple rolls out the fix for this issue.
+
+   Keeping the side effects in mind, you might need to adjust your UI to improve the experience. For example, you can turn off this workaround by default and have a "call to action" in your UI that allows the user to turn the volume up if they cannot hear any audio. This button will then apply the workaround. Another option is to listen for `devicechange` events to determine if the user switches headsets. When this happens, you will have the ability to reset the gain value.
+
+</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>
 
@@ -103,6 +232,7 @@ before opening a new issue. We recommend regularly upgrading to the latest versi
 </p>
 </details>
 
+
 ### Firefox desktop
 <details>
 <summary>Firefox Participants sometimes fail to subscribe to DataTracks on Peer-to-Peer Rooms</summary>

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,6 +13,11 @@ 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
 ---------------
 
@@ -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.17.0/twilio-video.min.js"></script>
+<script src="//sdk.twilio.com/js/video/releases/2.18.2/twilio-video.min.js"></script>
 
 ```
 
@@ -136,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)
 -----------------------------
 
@@ -162,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
 --------
@@ -221,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).
+