Merge pull request #9 from red5pro/sdk/15.0.0

sdk: v15.0.0

Author: bustardcelly

CHANGES.md

@@ -1,5 +1,13 @@
 # Changes
 
+## 15.0.0
+
+**ALERT: Breaking Changes**
+
+- feat: Removal of WebSocket based clients, `RTCPublisher`, `RTCSubscriber` and `RTCConferenceParticipant`
+- feat: WHIP/WHEP clients become main players: `WHIPClient` and `WHEPClient`
+- feat: Complete rewrite of SDK in `TypeScript` - allowing for types available in module installation.
+
 ## 14.3.0
 
 - fix: viewless subscriber/whep response to metadata (Todd Anderson)
@@ -38,12 +46,13 @@
 - Fix for connectionParams tacked on WHIP/WHEP calls. (Todd Anderson)
 - Fix for Firefox issue with Bundle order (Todd Anderson)
 
-  > The issue was that the offer provided by the server has a BUNDLE order of 0 1 2. When the WHEP client set that as their remote SDP and generated an offer,
-  > the BUNDLE order changed to 2 1 0 in the answer SDP. This would cause
-  > subscription issues and non-existant candidates.
+    > The issue was that the offer provided by the server has a BUNDLE order of 0 1
+    > 2. When the WHEP client set that as their remote SDP and generated an offer,
+    > the BUNDLE order changed to 2 1 0 in the answer SDP. This would cause
+    > subscription issues and non-existant candidates.
 
-  > Solution was the munge in the incoming offer BUNDLE line order to that of the
-  > answer.
+    > Solution was the munge in the incoming offer BUNDLE line order to that of the
+    > answer.
 
 - Using host query param when Location provided to WHIP/WHEP clients. (Todd Anderson)
 - Fix for live seek fullURL switching. (Todd Anderson)
@@ -63,7 +72,7 @@
 - using Hls.js fallback for Safari and seek feature. (bustardcelly)
 - Allow playback on scrub when unpublish (bustardcelly)
 
-  > If the live stream becomes unpublished, but the video has been scrubbed to VOD time segment, then we want to allow for playback until the end of the live stream termination.
+    > If the live stream becomes unpublished, but the video has been scrubbed to VOD time segment, then we want to allow for playback until the end of the live stream termination.
 
 ## 10.6.0
 
@@ -116,16 +125,16 @@
 - Fix for flash stalled playback. (bustardcelly)
 - Added notifications for RTCPeerConnection open event. (bustardcelly)
 
-  > This will allow for clients to recognize when they can start using peer connection APIs such as mute/unmute.
+    > This will allow for clients to recognize when they can start using peer connection APIs such as mute/unmute.
 
 - fix for HLS socket authentication failure capture. (bustardcelly)
 - Fix for Safari Publisher issue. (bustardcelly)
 
-  > When `gUM` returns with `video` track listed before `audio`, there is an issue on delivering the media to the server. Most likely due to mismatched candidates.
+    > When `gUM` returns with `video` track listed before `audio`, there is an issue on delivering the media to the server. Most likely due to mismatched candidates.
 
 - Fixed improper spelling of `productInstallUrl` config option. (bustardcelly)
 
-  > Is now `productInstallURL` for both rtmp publisher and subscriber.
+    > Is now `productInstallURL` for both rtmp publisher and subscriber.
 
 - fix for unpublish not resolving if not currently publishing. (bustardcelly)
 - API update to allow for providing MediaStream for publish to bypass gUM in SDK internally. (bustardcelly)
@@ -145,9 +154,9 @@
 - fix for bandwidth inject in latest chrome browser. (bustardcelly)
 - adding notification and retry support for autoplay restriction of subscribers. (bustardcelly)
 
-  > - WebRTC, RTMP and HLS Subscriber support
-  > - muteOnAutoplayRestriction configuration property added
-  > - Additional subscriber events for client-side notifications of autoplay restrictions
+    > * WebRTC, RTMP and HLS Subscriber support
+    > * muteOnAutoplayRestriction configuration property added
+    > * Additional subscriber events for client-side notifications of autoplay restrictions
 
 - allowing for decoupled socket for sharedobject connections. (bustardcelly)
 
@@ -168,10 +177,10 @@
 - fix for DOM cleanup on unsubscribe. (bustardcelly)
 - Adding `rtcConfiguration` support (bustardcelly)
 
-  > - WebRTC Publisher
-  > - WebRTC Subscriber
-  > - defaults to `iceServers` if rtcConfiguration is undefined
-  > - Provides a default rtcConfiguration
+    > * WebRTC Publisher
+    > * WebRTC Subscriber
+    > * defaults to `iceServers` if rtcConfiguration is undefined
+    > * Provides a default rtcConfiguration
 
 ## 5.2.0
 
@@ -183,8 +192,8 @@
 - remove of duplicate event handler. (bustardcelly)
 - Adding check for empty candidate from server (bustardcelly)
 
-  > - Server at times (depending on client) will send a `candidate` object as empty during the negotiation process.
-  > - A new event type has been added to notify listeners of this empty candidate
+    > * Server at times (depending on client) will send a `candidate` object as empty during the negotiation process.
+    > * A new event type has been added to notify listeners of this empty candidate
 
 - Pub/Sub support for mobile device orientation recognition. (bustardcelly)
 
@@ -193,7 +202,7 @@
 - removing onbeforeunload hook to dismantle sockets. (bustardcelly)
 - Allowing for auth/validation on HLS Subscribers (bustardcelly)
 
-  > Enabling auth/validation using connectionParam options on HLS Subscribers. This will internally attempt to make a connection on a WebSocket using the connection parameters. If the socket is opened, it is considered successful validation. If rejected, the client is shutdown.
+    > Enabling auth/validation using connectionParam options on HLS Subscribers. This will internally attempt to make a connection on a WebSocket using the connection parameters. If the socket is opened, it is considered successful validation. If rejected, the client is shutdown.
 
 - fix for mutiple property updates on shared object integration. (bustardcelly)
 - offload translation logic for orientation to focus on dynamic layout updates. (bustardcelly)
@@ -202,8 +211,8 @@
 - removal of unnecessary bandwidth config prop on subscribers. (bustardcelly)
 - Exposing autoLayoutOrientation (bustardcelly)
 
-  > Defaulted to true.
-  > When set to false, it is up to the developer to assign transitions as related to orientation of broadcasts.
+    > Defaulted to true.
+    > When set to false, it is up to the developer to assign transitions as related to orientation of broadcasts.
 
 ## 4.5.0
 
@@ -264,6 +273,7 @@
 
 ## 3.4.3
 
+
 - fix for test of `srcObject` in video element. (bustardcelly)
 - fix for subscriber.stop event dispatch. (bustardcelly)
 
@@ -273,10 +283,12 @@
 - offloading subscriber start event to websocket notification. (bustardcelly)
 - Update for API change in browsers. (bustardcelly)
 
-  Though latest adapter.js should handle, adding for legacy and new browsers.
+    Though latest adapter.js should handle, adding for legacy and new browsers.
+
 
 ## 3.4.0
 
+
 ## 3.3.0
 
 - using std camera sizes for RPRO-3787 (bustardcelly)
@@ -291,3 +303,4 @@
 
 - proper removal of child in flash embed. (bustardcelly)
 - support for IE and remove element on flash fallback. (bustardcelly)
+

CONFERENCE_PARTICIPANT_README.md

@@ -1,10 +1,10 @@
 <h3 align="center">
-  <img src="assets/red5pro_logo.png" alt="Red5 Pro Logo" />
+  <img src="assets/Red5_Truetime_black.png" alt="Red5 Pro Logo" height="65" />
 </h3>
 <p align="center">
-  <a href="WHIP_WHEP_README.md">WHIP/WHEP</a> &bull;
-  <a href="PUBLISHER_README.md">publisher</a> &bull;
-  <a href="SUBSCRIBER_README.md">subscriber</a> &bull;
+  <a href="README.md">Quick Start</a> &bull;
+  <a href="docs/whip-client.md">Publishing</a> &bull;
+  <a href="docs/whep-client.md">Subscribing</a>
 </p>
 
 ---
@@ -13,6 +13,8 @@
 
 This documentation serves as a guide in migrating client-side code where a breaking change to the API has been made in a distribution.
 
+- [14.x to 15.0.0](#migrating-from-14x-to-1500)
+- [13.x to 14.0.0](#migrating-from-13x-to-1400)
 - [12.x to 13.0.0](#migrating-from-12x-to-1300)
 - [10.x to 11.0.0](#migrating-from-10x-to-1100)
 - [8.0.0 to 9.1.0](#migrating-from-800-to-910)
@@ -22,6 +24,54 @@ This documentation serves as a guide in migrating client-side code where a break
 - [4.0.0 to 5.0.0](#migrating-from-400-to-500)
 - [3.5.0 to 4.0.0](#migrating-from-350-to-400)
 
+# Migrating from `14.x` to `15.0.0`
+
+**ALERT: Breaking Changes**
+
+The `15.0.0` release of the Red5 Pro WebRTC SDK is a complete rewrite of the SDK! Developed in TypeScript from the ground-up, we eliminated a lot of cruft and APIs that had become obsolete and deprecated over the years.
+
+With the slimming-down approach to the SDK also came the major breaking change of removing the WebSocket based clients: `RTCPublisher` and `RTCSubscriber`. As such, the clients introduced in the `11.0.0` release of the SDK are now the main actors and should be exclusively used: `WHIPClient` and `WHEPClient`.
+
+The [WebRTC-HTTP ingestion](https://www.ietf.org/archive/id/draft-ietf-wish-whip-01.html)(WHIP) and [WebRTC-HTTP egress](https://www.ietf.org/archive/id/draft-murillo-whep-00.html)(WHEP) protocols provide the ability to negotation and establish a connection using HTTP/S requests. This removes the requirement for a WebSocket, which historically has been used for the role of negotiation and connection.
+
+> Not only that, but their connection times are blazingly fast!
+
+If you have already been using the `WHIPClient` and `WHEPClient` from the Red5 Pro WebRTC SDK, you shouldn't find any hiccups and will not need to update anything - simply enjoy the benefits of a slimmer SDK and the inclusion of types!
+
+If you have been using the WebSocket-based `RTCPublisher` and `RTCSubscriber` clients, we have hopefully made it painless enough to simply swap out that instantiation with their corresponding WHIP/WHEP client - the initialization and API is all the same.
+
+For example, if you were previously establishing a publisher as such:
+
+```js
+const config = {
+  host: 'myred5.cloud',
+  streamName: 'mystream'
+}
+const publisher = new RTCPublisher()
+publisher.on('*', event => console.log(event))
+await publisher.init(config)
+await publisher.publish()
+```
+
+You can simply swap over to using the `WHEPClient` like so:
+
+```js
+const config = {
+  host: 'myred5.cloud',
+  streamName: 'mystream'
+}
+const publisher = new WHIPClient()
+publisher.on('*', event => console.log(event))
+await publisher.init(config)
+await publisher.publish()
+```
+
+> The same is true for moving from `RTCSubscriber` to `WHEPClient`!
+
+# Migrating from `13.x` to `14.0.0`
+
+Though the version number shows a major change, it was more to be in line with the semver of the Red5 Pro Server release. _No breaking changes._
+
 # Migrating from `12.x` to `13.0.0`
 
 The SDK release of `13.0.0` has additional configuration requirements when integrating with Stream Manager 2.0 deployments. This release sees the introduction of the `endpoint` initialization configuration on which you provide the full URL path to the Stream Manager 2.0 proxy. The proxy will handle directing the clients to the target Origin and Edge nodes.
@@ -30,9 +80,8 @@ The `endpoint` init config param is to be used in tandem with a `nodeGroup` conn
 
 More Information related to this configuration is detailed in the following documents:
 
-* [WHIP/WHEP] (./WHIP_WHEP_README.md#stream-manager-20)
-* [RTCPublisher] (./SUBSCRIBER_README.md#stream-manager-20)
-* [RTCSubscriber] (./PUBLISHER_README.md#stream-manager-20)
+* [WHIPClient](docs/whip-client.md#stream-manager-20)
+* [WHEPClient](docs/whep-client.md#stream-manager-20)
 
 > [NOTE] SharedObject support has been removed in 13.0.0
 
@@ -42,7 +91,7 @@ The SDK release of `11.0.0` provides the capability of utilizing the [WHIP](http
 
 The [WebRTC-HTTP ingestion](https://www.ietf.org/archive/id/draft-ietf-wish-whip-01.html)(WHIP) and [WebRTC-HTTP egress](https://www.ietf.org/archive/id/draft-murillo-whep-00.html)(WHEP) protocols provide the ability to negotation and establish a connection using HTTP/S requests. This removes the requirement for a WebSocket, which historically has been used for the role of negotiation and connection.
 
-> Read more [in the WHIP/WHEP documentation](WHIP_WHEP_README.md)!
+> Read more about [WHIPClient](docs/whip-client.md) and [WHEPClient](docs/whep-client.md).
 
 # Migrating from `8.0.0` to `9.1.0`