twilio-video 2.22.2 → 3.0.0-preview.1

package/CHANGELOG.md

@@ -1,7 +1,103 @@
-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.
+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 latest Video JavaScript SDK.
 
 **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.
 
+3.0.0-preview.1 (July 25, 2022)
+===============================
+
+New Features
+------------
+
+**Large Rooms Pilot**
+
+twilio-video.js now allows you to create and join a [Large Group Room](https://www.twilio.com/docs/video/large-group-rooms),
+which supports a large number of Participants (> 50). This feature is in pilot, and requires that your account be enabled
+in order to use it. **Note that the following API changes apply only for Large Rooms, and not for non-large Group Rooms and
+Peer-to-Peer Rooms**.
+
+- An audio and video RemoteTrack will now have an additional property called `switchOffReason`, which describes the
+  [reason](https://sdk.stage.twilio.com/js/video/releases/3.0.0-preview.1/docs/global.html#TrackSwitchOffReason) for
+  it being switched off. The `switchedOff` event will also have this reason string as a second argument. (VIDEO-8670, VIDEO-8748)
+- An audio or video RemoteTrack's `mediaStreamTrack` is set to `null` whenever it is switched off. When it is switched
+  on, it is set to a MediaStreamTrack. (VIDEO-8668, VIDEO-8745)
+- When the `switchOffReason` changes for an already switched off audio or video RemoteTrack, the `switchedOff` event is
+  raised. (VIDEO-8668, VIDEO-8745)
+- A RemoteAudioTrack of a Participant that is not active in the Large Room will now be switched off. (VIDEO-8668)
+- A RemoteVideoTrack will now be switched off if the number of switched on RemoteVideoTracks reached the limit set by the media server. (VIDEO-8745)
+- Renamed BandwidthProfileOptions to BandwidthProfile. (VIDEO-8754)
+- Renamed VideoBandwidthProfileOptions to VideoBandwidthProfile. (VIDEO-8753)
+- The `isEnabled` property of the RemoteTrack is deprecated and scheduled for removal. Alternatively, you can determine if
+  a RemoteTrack is enabled by using the following expression. (VIDEO-8742, VIDEO-8750)
+  ```js
+  const isEnabled = remoteTrack.switchOffReason !== 'disabled-by-publisher';
+  ```
+- The `disabled` and `enabled` events of the RemoteTrack are deprecated and scheduled for removal. Alternatively, you can
+  handle the `switchedOff` and `switchedOn` events as shown below. (VIDEO-8742, VIDEO-8750)
+  ```js
+  let recentSwitchOffReason = remoteTrack.switchOffReason;
+
+  remoteTrack.on('switchedOff', switchOffReason => {
+    recentSwitchOffReason = switchOffReason;
+    if (switchOffReason === 'disabled-by-publisher') {
+      /* The RemoteTrack is disabled. */
+    }
+  });
+
+  remoteTrack.on('switchedOn', () => {
+    if (recentSwitchOffReason === 'disabled-by-publisher') {
+      /* The RemoteTrack is enabled. */
+    }
+    recentSwitchOffReason = null;
+  });
+  ```
+- The `isTrackEnabled` property of the RemoteTrackPublication is deprecated and scheduled for removal. Alternatively, you
+  can determine if a RemoteTrackPublication is enabled by using the following expression. (VIDEO-8743, VIDEO-8751)
+  ```js
+  const { track } = remoteTrackPublication;
+  const isTrackEnabled = !(track && track.switchOffReason === 'disabled-by-publisher');
+  ```
+  `isTrackEnabled` is now only valid for RemoteTracks that are subscribed to, and defaults to `true` for unsubscribed
+  RemoteTracks.
+- The `trackDisabled` and `trackEnabled` events of the RemoteTrack are deprecated and scheduled for removal. Alternatively,
+  you can handle the `trackSwitchedOff` and `trackSwitchedOn` events as shown below. (VIDEO-8743, VIDEO-8751)
+  ```js
+  const { track } = remoteTrackPublication;
+  let recentSwitchOffReason = track ? track.switchOffReason : null;
+
+  remoteTrackPublication.on('trackSwitchedOff', (track, switchOffReason) => {
+    recentSwitchOffReason = switchOffReason;
+    if (switchOffReason === 'disabled-by-publisher') {
+      /* The RemoteTrack is disabled. */
+    }
+  });
+
+  remoteTrackPublication.on('trackSwitchedOn', (track) => {
+    if (recentSwitchOffReason === 'disabled-by-publisher') {
+      /* The RemoteTrack is enabled. */
+    }
+    recentSwitchOffReason = null;
+  });
+  ```
+  The `trackDisabled` and `trackEnabled` events are now only fired for subscribed RemoteTracks.
+- Any audio and video Tracks shared while joining the Room will **no longer** be guaranteed to be published by the time
+  the CancelablePromise returned by `connect()` is resolved. The application will now have to listen to the "trackPublished"
+  event on the LocalParticipant. (VIDEO-8817)
+  ```js
+  const room = await connect('token', {
+    audio: true,
+    video: true,
+    room: 'my-large-room'
+  });
+
+  room.localParticipant.on('trackPublished', publication => {
+    console.log(`Successfully published ${publication.kind} Track`);
+  });
+  ```
+- `Room.getStats()` is broken, and will be fixed in an upcoming release. For now, the Track-level stats returned by this
+  method will not be accurate.
+- [PSTN Participants](https://www.twilio.com/docs/video/adding-programmable-voice-participants-video-rooms) cannot connect
+  to Large Rooms.
+
 2.22.2 (July 25, 2022)
 ======================
 

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.22.2/twilio-video.min.js"></script>
+<script src="//sdk.twilio.com/js/video/releases/3.0.0-preview.1/twilio-video.min.js"></script>
 
 ```