@testrtc/watchrtc-sdk
Advanced tools
Comparing version 1.34.1-beta.13 to 1.34.1-beta.14
@@ -1,2 +0,2 @@ | ||
declare const _default: "1.34.1-beta.13"; | ||
declare const _default: "1.34.1-beta.14"; | ||
export default _default; |
{ | ||
"name": "@testrtc/watchrtc-sdk", | ||
"version": "1.34.1-beta.13", | ||
"version": "1.34.1-beta.14", | ||
"description": "Monitor your WebRTC application by collecting WebRTC statistics from end users", | ||
@@ -5,0 +5,0 @@ "main": "lib/index.js", |
116
README.md
@@ -100,3 +100,3 @@ # watchRTC JS SDK | ||
console: { level: "error", override: true }, | ||
proxyUrl: "wss://{your-proxy}" | ||
proxyUrl: "wss://{your-proxy}", | ||
}); | ||
@@ -213,6 +213,5 @@ ``` | ||
```javascript | ||
const statsListener = (stats) => { | ||
// Called each time new statistics are available | ||
} | ||
// Called each time new statistics are available | ||
}; | ||
@@ -225,11 +224,14 @@ watchRTC.addStatsListener(statsListener); | ||
The JSON object contains 2 main properties: | ||
- **connections**: Which lists the connections (based on the RTCPeerConnection used) and the properties associated to each connection, | ||
- **streams***: Which lists all the streams involved in the call | ||
- **streams\***: Which lists all the streams involved in the call | ||
For each connection, the following properties are available: | ||
- **connection**: String value. Can be one of `direct` or `relay`, | ||
- **transport**: String value. Can be one of `udp`, `tcp` or `tls`, | ||
- **address**: String value using format 'address:port'. This is the remote IP address and port, | ||
- **address**: String value using format 'address:port'. This is the remote IP address and port, | ||
For each stream, the following properties are available: | ||
- **peerID**: String value. This is the ID of the associated connection, | ||
@@ -251,3 +253,3 @@ - **kind**: String value. Can be one of `audio` or `video`, | ||
_Note_: To stop receiving the statistics, pass `null` to the `addStatsListener` function. The existing listener will be unsubscribed and removed. | ||
_Note_: To stop receiving the statistics, pass `null` to the `addStatsListener` function. The existing listener will be unsubscribed and removed. | ||
@@ -261,47 +263,50 @@ ## Samples | ||
### 1.29.2 (July 22, 2021) | ||
### 1.34.1-beta.14 (July 22, 2022) | ||
#### New features | ||
- `watchRTC.addTags()` was added | ||
- `watchRTC.setUserRating()` was added | ||
- Add support for multiple server versions | ||
### 1.30.0 (September 26, 2021) | ||
### 1.34.1-beta.12 (July 22, 2022) | ||
#### New features | ||
#### Bug fixes | ||
- `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/) | ||
- Add new debug log for "getStats" method | ||
### 1.30.2 (October 3, 2021) | ||
### 1.34.1-beta.10 (July 12, 2022) | ||
#### Bug fixes | ||
- The SDK now doesn't collect WebRTC API calls into the event log twice | ||
- Handle "Converting circular structure to JSON" error when override console | ||
### 1.30.3 (October 5, 2021) | ||
### 1.34.1-beta.7 (July 8, 2022) | ||
- Updated the readme | ||
#### Bug fixes | ||
### 1.30.4 (October 12, 2021) | ||
- HTTP trace did not work if websocket connection was not established in the first place | ||
- Fixed data collect when using Firefox | ||
- Fixed a CSP warning by making the watchRTC SDK self-suficient without any external dependencies | ||
### 1.34.1-beta.5 (July 6, 2022) | ||
### 1.30.5 (November 19, 2021) | ||
#### Bug fixes | ||
- Console override now happens only if console logs are requested to be collected | ||
- When getstats timestamp property was provided as a string, data compression failed to work | ||
- Sometimes RTCRemoteInboundRTPAudio and RTCRemoteInboundRTPVideo reports were missed, resulting in a gap at the beginning of our chart data | ||
- `addEvent` now works more accurately for events captured before the websocket connection was established to the watchRTC server | ||
### 1.33.6 (June 8, 2022) | ||
#### New features | ||
- `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/) | ||
- icecandidateerror() events are now collected by the SDK | ||
- RTCRtpSender.setParameters() calls are now collected by the SDK | ||
- Added support for parameterless setLocalDescription() calls | ||
- 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/) | ||
- 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 `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 | ||
### 1.30.6 (November 19, 2021) | ||
### 1.30.8 (February 15, 2022) | ||
#### New features | ||
#### Bug fixes | ||
- Added support for custom keys with multiple values | ||
- `watchRTC.addEvent()` now also supports parameters | ||
- We now capture getUserMedia failures as well. These will be collected and reported if a peer connection object is created by the application | ||
@@ -314,43 +319,46 @@ ### 1.30.7 (February 14, 2022) | ||
### 1.30.8 (February 15, 2022) | ||
### 1.30.6 (November 19, 2021) | ||
#### Bug fixes | ||
#### New features | ||
- We now capture getUserMedia failures as well. These will be collected and reported if a peer connection object is created by the application | ||
- Added support for custom keys with multiple values | ||
- `watchRTC.addEvent()` now also supports parameters | ||
### 1.33.6 (June 8, 2022) | ||
### 1.30.5 (November 19, 2021) | ||
#### New features | ||
- 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/) | ||
- 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 `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 | ||
- `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/) | ||
- icecandidateerror() events are now collected by the SDK | ||
- RTCRtpSender.setParameters() calls are now collected by the SDK | ||
- Added support for parameterless setLocalDescription() calls | ||
### 1.34.1-beta.5 (July 6, 2022) | ||
### 1.30.4 (October 12, 2021) | ||
#### Bug fixes | ||
- Fixed data collect when using Firefox | ||
- Fixed a CSP warning by making the watchRTC SDK self-suficient without any external dependencies | ||
- Console override now happens only if console logs are requested to be collected | ||
- When getstats timestamp property was provided as a string, data compression failed to work | ||
- Sometimes RTCRemoteInboundRTPAudio and RTCRemoteInboundRTPVideo reports were missed, resulting in a gap at the beginning of our chart data | ||
- `addEvent` now works more accurately for events captured before the websocket connection was established to the watchRTC server | ||
### 1.30.3 (October 5, 2021) | ||
### 1.34.1-beta.7 (July 8, 2022) | ||
- Updated the readme | ||
### 1.30.2 (October 3, 2021) | ||
#### Bug fixes | ||
- HTTP trace did not work if websocket connection was not established in the first place | ||
- The SDK now doesn't collect WebRTC API calls into the event log twice | ||
### 1.34.1-beta.10 (July 12, 2022) | ||
### 1.30.0 (September 26, 2021) | ||
#### Bug fixes | ||
#### New features | ||
- Handle "Converting circular structure to JSON" error when override console | ||
- `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/) | ||
### 1.34.1-beta.12 (July 22, 2022) | ||
### 1.29.2 (July 22, 2021) | ||
#### Bug fixes | ||
#### New features | ||
- Add new debug log for "getStats" method | ||
- `watchRTC.addTags()` was added | ||
- `watchRTC.setUserRating()` was added |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
488293
1285
359