twilio-video 2.21.3 → 2.22.2

package/CHANGELOG.md

@@ -2,6 +2,88 @@ 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.22.2 (July 25, 2022)
+======================
+
+Changes
+-------
+
+- `isSupported` flag now returns `false` if the browser does not support the Unified Plan SDP format. (VIDEO-10307)
+  
+  The following is a list of browsers with Unified Plan as the default SDP format.
+  - Chrome 72+
+  - Safari 12.1+
+  - Firefox 38+
+
+2.22.1 (July 11, 2022)
+======================
+
+Bug Fixes
+---------
+
+- The encoding of audio and screen share Tracks are prioritized in Chrome and Safari, thereby more gracefully degrading
+  their quality in limited network conditions. (VIDEO-10212)
+
+2.22.0 (July 5, 2022)
+====================
+
+New Features
+------------
+
+This release include the **Media Warnings API (Beta)** to help surface media related warning events on the SDK whenever the media server is not able to detect media from a published audio or video track.
+
+### Example
+
+```js
+const room = await connect('token', {
+  notifyWarnings: [ 'recording-media-lost' ]
+  // Other connect options
+});
+
+Array.from(room.localParticipant.tracks.values()).forEach(publication => {
+  publication.on('warning', name => {
+    if (name === 'recording-media-lost') {
+      console.log(`LocalTrack ${publication.track.name} is not recording media.`);
+
+      // Wait a reasonable amount of time to clear the warning.
+      const timer = setTimeout(() => {
+        // If the warning is not cleared, you can manually
+        // reconnect to the room, or show a dialog to the user
+      }, 5000);
+
+      publication.once('warningsCleared', () => {
+        console.log(`LocalTrack ${publication.track.name} warnings have cleared!`);
+        clearTimeout(timer);
+      });
+    }
+  });
+});
+```
+
+### API Definitions
+
+#### ConnectOptions
+
+- **notifyWarnings** - An array of warnings to listen to. By default, this array is empty and no warning events will be raised. Possible warning values include:
+
+  - `recording-media-lost` - Raised when the media server has not detected any media on the published track that is being recorded in the past 30 seconds. This usually happens when there are network interruptions or when the track has stopped.
+
+#### Events
+
+The SDK raises warning events when it detects certain conditions. You can implement callbacks on these events to act on them, or to alert the user of an issue. Subsequently, "warningsCleared" event is raised when conditions have returned to normal.
+
+- **LocalTrackPublication.on('warning', callback(name))** - Raised when the published Track encounters a warning.
+
+- **LocalTrackPublication.on('warningsCleared', callback())** - Raised when the published Track cleared all warning.
+
+- **LocalParticipant.on('trackWarning', callback(name, publication))** - Raised when one of the LocalParticipant's published tracks encounters a warning.
+
+- **LocalParticipant.on('trackWarningsCleared', callback(publication))** - Raised when one of the LocalParticipant's published tracks cleared all warning.
+
+- **Room.on('trackWarning', callback(name, publication, participant))** - Raised when one of the LocalParticipant's published tracks in the Room encounters a warning.
+
+- **Room.on('trackWarningsCleared', callback(publication, participant))** - Raised when one of the LocalParticipant's published tracks in the Room cleared all warning.
+
 2.21.3 (June 7, 2022)
 ====================
 
@@ -16,7 +98,7 @@ Bug Fixes
 Bug Fixes
 ---------
 
-- Fixed an issue where some extraneous errors were logged to console when a video track was stopped. (VIDEO-9511)
+- Fixed an issue where publishing a video track sometimes caused a failure with "Unhandled exception: Client is unable to create or apply a local media description". (VIDEO-9511)
 - Fixed an issue where the `dimensionsChanged` event was not firing when the track dimensions first became available. (VIDEO-3576)
 - Removed references to node dependencies that causes build errors on Angular and Vue. (VIDEO-9282)
 - Fixed an issue where incorrect device was detected when using iPad in Desktop Website mode. (VIDEO-8282)

package/COMMON_ISSUES.md

@@ -117,9 +117,34 @@ before opening a new issue. We recommend regularly upgrading to the latest versi
    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>
+<details>
+<summary>Video elements may not be visible when applying a 3d transform</summary>
+<p>
+
+   In some cases, a video element may not be visible when using a 3d CSS transform (such as `rotateY(180deg)`) to mirror a local video track. It is recommended that a 2d transform be used instead.
+
+   Recommended 2d transform to mirror a video track:
+```css
+transform: scaleX(-1)
+```
+
+   This issue is also present in Safari mobile.
+
+   For more information, please see the discussion in [this issue](https://github.com/twilio/twilio-video.js/issues/1724).
+</p>
+</details>
 
 ### Safari mobile
 <details>
+<summary>iOS 15: Echo issues on iOS 15 devices after attaching video tracks</summary>
+<p>
+
+   Attaching a VideoTrack to a video element causes echo issues if you have a LocalAudioTrack that is already attached to an audio element. This happens due to an iOS 15 [bug](https://bugs.webkit.org/show_bug.cgi?id=241492) where the audio element is unintentionally unmuted.
+
+   Apple has already fixed this issue on iOS 15.5. However, older versions will continue to experience the issue. As a workaround, you can skip attaching the LocalAudioTrack to an audio element to prevent a feedback loop that causes the echo issue. If you really need to attach the LocalAudioTrack for any reason, please feel free to reach out to us in this repo and we will help to find a workaround depending on your use case.
+</p>
+</details>
+<details>
 <summary>iOS 15: VideoTracks goes black and the page freezes on certain interruptions</summary>
 <p>
 
@@ -363,3 +388,12 @@ 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>
 </details>
+<details>
+<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. 
+
+   More information about this method (including browser compatibility) is available [here](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/setSinkId).
+</p>
+</details>

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.21.3/twilio-video.min.js"></script>
+<script src="//sdk.twilio.com/js/video/releases/2.22.2/twilio-video.min.js"></script>
 
 ```