Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@testrtc/watchrtc-sdk
Advanced tools
@testrtc/watchrtc-sdk - npm Package Compare versions
Comparing version 1.41.1-beta.4 to 1.41.1-beta.5
@@ -12,7 +12,6 @@ export declare const detectAdvancedPlatform: (customUserAgent: any, customUserAgentData: any) => Promise<{ | ||
| architecture: any; | ||
| bitness: any; | ||
| mobile: any; | ||
| model: any; | ||
| } | { | ||
| name: string | null; | ||
| name: string; | ||
| version: string | null; | ||
@@ -27,5 +26,4 @@ majorVersion: string | undefined; | ||
| architecture?: undefined; | ||
| bitness?: undefined; | ||
| mobile?: undefined; | ||
| model?: undefined; | ||
| } | undefined>; |
@@ -1,2 +0,2 @@ | ||
| declare const _default: "1.41.1-beta.4"; | ||
| declare const _default: "1.41.1-beta.5"; | ||
| export default _default; |
| { | ||
| "name": "@testrtc/watchrtc-sdk", | ||
| "version": "1.41.1-beta.4", | ||
| "version": "1.41.1-beta.5", | ||
| "description": "Monitor your WebRTC application by collecting WebRTC statistics from end users", | ||
@@ -5,0 +5,0 @@ "main": "lib/index.js", |
@@ -5,3 +5,3 @@ # watchRTC JS SDK | ||
| This is done by including our watchRTC SDK which connects to the testRTC backend and collects the relevant data. | ||
| Please check out our [watchRTC knowledge base](https://testrtc.com/article-categories/watchrtc/) to learn more about the features and capabilities of this WebRTC monitoring service. | ||
| Please check out our [watchRTC knowledge base](https://support.testrtc.com/hc/en-us/sections/8428280686223-watchRTC-Passive-Monitoring) to learn more about the features and capabilities of this WebRTC monitoring service. | ||
@@ -72,13 +72,13 @@ ## Installation | ||
| Before you start, be sure to also read our [Getting started with watchRTC](https://testrtc.com/docs/getting-started-with-watchrtc/) guide. | ||
| Before you start, be sure to also read our [Getting started with watchRTC](https://support.testrtc.com/hc/en-us/sections/8428298108047-Getting-started-with-watchRTC) guide. | ||
| Configuring the SDK to connect to the watchRTC backend requires passing the following parameters to the SDK: | ||
| - **rtcApiKey** - watchRTC API key, as provided by testRTC | ||
| - **rtcRoomId** - an identifier to the session/room/conference. This will enable an analysis of all participants in the same room as a single logical unit. Read more about [rooms and peers in watchRTC](https://testrtc.com/docs/rooms-and-peers-in-watchrtc/). | ||
| - **rtcRoomId** - an identifier to the session/room/conference. This will enable an analysis of all participants in the same room as a single logical unit. Read more about [rooms and peers in watchRTC](https://support.testrtc.com/hc/en-us/articles/8428294248591-Rooms-and-peers-in-watchRTC). | ||
| - **rtcPeerId** - an identifier of this peer/user in the session. This will make it easier to identify and troubleshoot users. It is recommended to use non-PII data here as much as possible (no emails or names for example) | ||
| - **keys** - (optional) key value object. Used to associate with this peer connection. These can later be searched for or filtered. Read more about [keys in watchRTC](https://testrtc.com/docs/using-custom-keys-in-watchrtc/). | ||
| - **console** - (optional) collect browser console log messages. Read more about [collecting console logs in watchRTC](https://testrtc.com/docs/console-logs-in-watchrtc/). | ||
| - **keys** - (optional) key value object. Used to associate with this peer connection. These can later be searched for or filtered. Read more about [keys in watchRTC](https://support.testrtc.com/hc/en-us/articles/8428309995663-Using-custom-keys-in-watchRTC). | ||
| - **console** - (optional) collect browser console log messages. Read more about [collecting console logs in watchRTC](https://support.testrtc.com/hc/en-us/articles/8428310024975-Console-logs-in-watchRTC). | ||
| - **proxyUrl** - (optional) secured web socket proxy server address, the proxy server should forward the connection to testRTC's watchRTC servers | ||
| Based on your application's logic, you can and should pass these configuration parameters at different stages. Read more about [Setting up a proxy for watchRTC traffic](https://testrtc.com/docs/setting-up-a-proxy-for-watchrtc-traffic/). | ||
| - **collectionInterval** - (optional) the number of seconds in which watchRTC will collect stats. Used until the connection to watchRTC server won't be opened. Read more about [collection interval in watchRTC](https://testrtc.com/docs/collection-interval-in-watchrtc/) | ||
| Based on your application's logic, you can and should pass these configuration parameters at different stages. Read more about [Setting up a proxy for watchRTC traffic](https://support.testrtc.com/hc/en-us/articles/8428298293007-Setting-up-a-proxy-for-watchRTC-traffic). | ||
| - **collectionInterval** - (optional) the number of seconds in which watchRTC will collect stats. Used until the connection to watchRTC server won't be opened. Read more about [collection interval in watchRTC](https://support.testrtc.com/hc/en-us/articles/8428322349071-Collection-Intervals-in-watchRTC) | ||
@@ -144,11 +144,2 @@ 1. In the call to the `watchRTC.init()` | ||
| ### Open/Close connection to server | ||
| By default, watchRTC SDK will automatically establish a connection with the watchRTC server and close it after an idle period. At times, it might make sense for your application to manually open and close that connection explicitly. This is done by calling `watchRTC.connect()` and `watchRTC.disconnect()`. Read more about [manually connecting/disconnecting to watchRTC servers](https://testrtc.com/docs/connecting-to-watchrtc/). | ||
| ```javascript | ||
| watchRTC.connect(); | ||
| watchRTC.disconnect(); | ||
| ``` | ||
| ### Adding keys | ||
@@ -159,3 +150,3 @@ | ||
| - keys - These can later be searched for or filtered. Read more about [keys in watchRTC](https://testrtc.com/docs/using-custom-keys-in-watchrtc/). | ||
| - keys - These can later be searched for or filtered. Read more about [keys in watchRTC](https://support.testrtc.com/hc/en-us/articles/8428309995663-Using-custom-keys-in-watchRTC). | ||
@@ -187,3 +178,3 @@ ```javascript | ||
| Returns a `Promise` which resolves with an empty object in success case, or with an `error` property if something went wrong. | ||
| Read more about [adding custom events in watchRTC](https://testrtc.com/docs/adding-custom-events-in-watchrtc/). | ||
| Read more about [adding custom events in watchRTC](https://support.testrtc.com/hc/en-us/articles/8428298243727-Adding-custom-events-in-watchRTC). | ||
@@ -217,3 +208,3 @@ - **name** - The event name. This will be displayed when the event occurred | ||
| By default, watchRTC will assign the SSRC information as the name for incoming channels. You can change these to human-readable format indicating the source of the channels by mapping their streams. This is done by calling `watchRTC.mapTrack(trackIdentifier)`. Read more about [mapping streams in watchRTC](https://testrtc.com/docs/mapping-streams-in-watchrtc/). | ||
| By default, watchRTC will assign the SSRC information as the name for incoming channels. You can change these to human-readable format indicating the source of the channels by mapping their streams. This is done by calling `watchRTC.mapTrack(trackIdentifier)`. Read more about [mapping streams in watchRTC](https://support.testrtc.com/hc/en-us/articles/8428294345999-Mapping-streams-in-watchRTC). | ||
@@ -231,5 +222,14 @@ - **id** - the TrackIdentifier to map from in the PeerConnection object | ||
| In call center scenarios, there's a feature called persistent connection or nailup call. With it, a WebRTC peer connection is created and maintained, while actual real calls take place on top of that single connection, keeping it open in-between these calls. This is used to reduce call setup times and to reduce the amount of needed signaling messages. You can mark the begining and end of such application specific calls on a persistent connection using `watchRTC.persistentStart(rtcRoomId, rtcPeerId)` and `watchRTC.persistentEnd()`. Read more about [persistent connections and watchRTC](https://testrtc.com/docs/persistent-connections-and-watchrtc/). | ||
| In call center scenarios, there's a feature called persistent connection or nailup call. With it, a WebRTC peer connection is created and maintained, while actual real calls take place on top of that single connection, keeping it open in-between these calls. This is used to reduce call setup times and to reduce the amount of needed signaling messages. You can mark the begining and end of such application specific calls on a persistent connection using `watchRTC.persistentStart(rtcRoomId, rtcPeerId)` and `watchRTC.persistentEnd()`. Read more about [persistent connections and watchRTC](https://support.testrtc.com/hc/en-us/articles/8428298299151-Persistent-connections-and-watchRTC). | ||
| _Note_: Make sure to pass new rtcRoomId for next call in order to separate sessions. | ||
| ### Open/Close connection to server | ||
| By default, watchRTC SDK will automatically establish a connection with the watchRTC server and close it after an idle period. At times, it might make sense for your application to manually open and close that connection explicitly. This is done by calling `watchRTC.connect()` and `watchRTC.disconnect()`. Read more about [manually connecting/disconnecting to watchRTC servers](https://support.testrtc.com/hc/en-us/articles/8428322263567-Connecting-to-watchRTC). | ||
| ```javascript | ||
| watchRTC.connect(); | ||
| watchRTC.disconnect(); | ||
| ``` | ||
| ### Collect WebRTC statistics (BETA) | ||
@@ -325,3 +325,3 @@ | ||
| // run: "Location", | ||
| // any other parameter from https://testrtc.com/docs/url-parameters-in-qualityrtc/ | ||
| // any other parameter from https://support.testrtc.com/hc/en-us/articles/8428284359823-URL-parameters-in-qualityRTC | ||
| }, | ||
@@ -335,3 +335,3 @@ progressCallback | ||
| // answer is in the format described in https://testrtc.com/docs/webhook-support-in-qualityrtc/ | ||
| // answer is in the format described in https://support.testrtc.com/hc/en-us/articles/8428324242319-Webhook-support-in-qualityRTC | ||
| console.log(`runNetworkTest answer`, answer); | ||
@@ -348,2 +348,7 @@ } | ||
| ### 1.41.1-beta.5 (Oct 16, 2024) | ||
| - Better identify Windows version 11 when using Chromium-based browsers. | ||
| - Better identify macOS version when using Safari | ||
| ### 1.41.1-beta.4 (Oct 11, 2024) | ||
@@ -560,3 +565,3 @@ | ||
| - Added collectionInterval to the configuration, to deal with connectivity related edge cases. Read more about [collection interval in watchRTC](https://testrtc.com/docs/collection-interval-in-watchrtc/) | ||
| - Added collectionInterval to the configuration, to deal with connectivity related edge cases. Read more about [collection interval in watchRTC](https://support.testrtc.com/hc/en-us/articles/8428322349071-Collection-Intervals-in-watchRTC) | ||
@@ -650,6 +655,6 @@ ### 1.36.1 (Feb 20,2023) | ||
| - You can now collect console logs using the SDK. Read more about [Collecting console logs in watchRTC](https://testrtc.com/docs/collecting-console-logs-in-watchrtc/) | ||
| - You can now collect console logs using the SDK. Read more about [Collecting console logs in watchRTC](https://support.testrtc.com/hc/en-us/articles/8428310024975-Console-logs-in-watchRTC) | ||
| - The SDK now tries to reconnect if it loses its connection to the watchRTC server | ||
| - We now queue custom events if the SDK isn't connected to the server. These get sent to the server once a connection is available | ||
| - You can now open/close the connection to server manually. Read more about [manually connecting/disconnecting to watchRTC servers](https://testrtc.com/docs/connecting-to-watchrtc/) | ||
| - You can now open/close the connection to server manually. Read more about [manually connecting/disconnecting to watchRTC servers](https://support.testrtc.com/hc/en-us/articles/8428322263567-Connecting-to-watchRTC) | ||
| - You can now `await` on the following SDK methods: `addKeys()`, `setUserRating()`, `addEvent()`. These methods now return a `Promise` which resolves with an empty object on success case, or with an `error` property if something went wrong | ||
@@ -680,4 +685,4 @@ | ||
| - `watchRTC.mapStream()` was added. Read more about [mapping streams in watchRTC](https://testrtc.com/docs/mapping-streams-in-watchrtc/) | ||
| - `watchRTC.addEvent()` was added. Read more about [events in watchRTC](https://testrtc.com/docs/adding-custom-events-in-watchrtc/) | ||
| - `watchRTC.mapStream()` was added. Read more about [mapping streams in watchRTC](https://support.testrtc.com/hc/en-us/articles/8428294345999-Mapping-streams-in-watchRTC) | ||
| - `watchRTC.addEvent()` was added. Read more about [events in watchRTC](https://support.testrtc.com/hc/en-us/articles/8428298243727-Adding-custom-events-in-watchRTC) | ||
| - icecandidateerror() events are now collected by the SDK | ||
@@ -707,3 +712,3 @@ - RTCRtpSender.setParameters() calls are now collected by the SDK | ||
| - `watchRTC.addTags()` was deprecated. We no longer support tags. These have been replaced with a key/value system | ||
| - `watchRTC.addKeys()` was added. Read more about [keys in watchRTC](https://testrtc.com/docs/using-custom-keys-in-watchrtc/) | ||
| - `watchRTC.addKeys()` was added. Read more about [keys in watchRTC](https://support.testrtc.com/hc/en-us/articles/8428309995663-Using-custom-keys-in-watchRTC) | ||
@@ -710,0 +715,0 @@ ### 1.29.2 (July 22, 2021) |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis 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
LicenseThis 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
- increased by0.42%
665901
- Number of lines in readme file
- increased by0.71%
707
Worsened metrics
- Lines of code
- decreased by-0.06%
1645
No dependency changes