@testrtc/watchrtc-sdk - npm Package Compare versions

Comparing version 1.40.1-beta.2 to 1.40.1-beta.3

lib/version.d.ts

@@ -1,2 +0,2 @@
-declare const _default: "1.40.1-beta.2";
+declare const _default: "1.40.1-beta.3";
 export default _default;

package.json

 {
   "name": "@testrtc/watchrtc-sdk",
-  "version": "1.40.1-beta.2",
+  "version": "1.40.1-beta.3",
   "description": "Monitor your WebRTC application by collecting WebRTC statistics from end users",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -230,3 +230,3 @@ # watchRTC JS SDK
 
-**Be careful, this API is in beta. API and content could change in the next version.**
+**Be careful, this API is in beta. API and content could change in future releases.**
 Once a call is established, WatchRTC exposes WebRTC statistics collected from the existing RTCPeerConnections. Accessing to these statistics can be done by adding a listener from the application.
@@ -302,2 +302,33 @@
 
+## qualityRTC integration
+
+If you have licensed qualityRTC, then you can also conduct ad-hoc network tests to your agents and users as an integral part of your application, to quickly understand and troubleshoot WebRTC connectivity and quality issues.
+
+Learn more about [qualityRTC SDK](https://support.testrtc.com/hc/en-us/articles/9952384403343-Using-qualityRTC-SDK).
+
+### Usage
+
+```javascript
+  const progressCallback = (progress: number) => {
+    console.log(`runNetworkTest progressCallback ${progress}%`, {});
+  }
+
+  const runNetworkTest = async (testName: string) => {
+    const answer = await watchRTC.qualityrtc.run({
+        options: {
+            // run: "Location",
+            // any other parameter from https://testrtc.com/docs/url-parameters-in-qualityrtc/
+        },
+        progressCallback
+    });
+
+    // any time can call stop to stop the test
+    // watchRTC.qualityrtc.stop();
+
+
+    // answer is in the format described in https://testrtc.com/docs/webhook-support-in-qualityrtc/
+    console.log(`runNetworkTest answer`, answer);
+  }
+```
+
 ## Samples
@@ -310,4 +341,8 @@
 
-### 1.40.1.beta-2 (Jun 6, 2024)
+### 1.40.1.beta-3 (Jun 12, 2024)
 
+- Documented the interface for qualityRTC.
+
+### 1.40.1.beta-2 (Jun 12, 2024)
+
 - Release the internal listeners on local tracks when the RTCPeerConnection is closed to let the garbage collector remove this peer-connection properly
@@ -314,0 +349,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

611392

increased by0.19%

Number of lines in readme file

663

increased by5.57%

No dependency changes