|
1 |
| -1.12.6 (In Progress) |
| 1 | +1.13.0 (In Progress) |
2 | 2 | ====================
|
3 | 3 |
|
4 | 4 | Changes
|
5 | 5 | -------
|
6 | 6 |
|
7 | 7 | * Added `high-packets-lost-fraction` [network warning](https://www.twilio.com/docs/voice/insights/call-quality-events-twilio-client-sdk#network-warnings). This new warning is raised when the average of the most recent seven seconds of packet-loss samples is greater than `3%`. When the average packet-loss over the most recent seven seconds is less than or equal to `1%`, then the warning is cleared.
|
| 8 | + |
8 | 9 | * The behavior for raising the `constant-audio-level` warning has been updated. Now, the most recent ten seconds of volume values are recorded and then analyzed. If the standard deviation of these samples is less than 1% of the maximum audio value, then the warning is raised. When the standard deviation is greater than 1% and the warning has already been raised, then the warning is cleared.
|
9 | 10 |
|
| 11 | +* We now log an `outgoing` event to Insights when making an outbound call. This event also contains information whether the call is a preflight or not. |
| 12 | + |
| 13 | +* Added a boolean field to the signaling payload for calls initiated by `Device.testPreflight` for debugging purposes. |
| 14 | + |
| 15 | +1.13.0-beta2 (Sept 10, 2020) |
| 16 | +============================ |
| 17 | + |
| 18 | +Breaking Changes |
| 19 | +---------------- |
| 20 | + |
| 21 | +* We now emit `(warning: PreflightTest.Warning)` object from PreflightTest.on('warning'), |
| 22 | + rather than `(name: string, data: RTCWarning)`. The `PreflightTest.Warning` object has been updated |
| 23 | + to match the following interface: |
| 24 | + ```ts |
| 25 | + export interface Warning { |
| 26 | + description: string; |
| 27 | + name: string; |
| 28 | + rtcWarning?: RTCWarning; |
| 29 | + } |
| 30 | + ``` |
| 31 | +* Renamed the following `PreflightTest.Report` fields to reflect the correct object types. |
| 32 | + | Old field name | New field name | |
| 33 | + |:------------------------------------------------|:-----------------------------------------------------| |
| 34 | + | `PreflightTest.Report.iceCandidates` | `PreflightTest.Report.iceCandidateStats` | |
| 35 | + | `PreflightTest.Report.selectedIceCandidatePair` | `PreflightTest.Report.selectedIceCandidatePairStats` | |
| 36 | + |
| 37 | +Additions |
| 38 | +--------- |
| 39 | + |
| 40 | +* We now emit a PreflightTest.Warning (`insights-connection-error`) the first time Insights emits an |
| 41 | + error, and add that Warning in `Report.warnings`. |
| 42 | +* Added signaling timing information in the `PreflightTest.Report.networkTiming` object. |
| 43 | + |
| 44 | + Example: |
| 45 | + |
| 46 | + ```ts |
| 47 | + const preflightTest = Device.testPreflight(token, options); |
| 48 | + |
| 49 | + preflightTest.on(PreflightTest.Events.Completed, (report) => { |
| 50 | + console.log(report.networkTiming); |
| 51 | + }); |
| 52 | + /* Outputs the following |
| 53 | + { |
| 54 | + "signaling": { |
| 55 | + "start": 1595885835227, |
| 56 | + "end": 1595885835573, |
| 57 | + "duration": 346 |
| 58 | + } |
| 59 | + ... |
| 60 | + } |
| 61 | + */ |
| 62 | + ``` |
| 63 | + |
| 64 | +Bug Fixes |
| 65 | +--------- |
| 66 | + |
| 67 | +* Fixed an issue where the browser console is flooded with errors after a network handover. |
| 68 | + |
| 69 | +1.13.0-beta1 (July 7, 2020) |
| 70 | +============================= |
| 71 | + |
| 72 | +Bug Fixes |
| 73 | +--------- |
| 74 | + |
| 75 | +* Fixed an issue where preflight is not muting the audio output after output audio devices are updated. |
| 76 | + |
| 77 | +1.13.0-preview1 (June 17, 2020) |
| 78 | +=============================== |
| 79 | + |
| 80 | +New Features - Preview |
| 81 | +---------------------- |
| 82 | + |
| 83 | +* The SDK now supports a preflight test API which can help determine Voice calling readiness. The API creates a test call and will provide information to help troubleshoot call related issues. This new API is a static member of the [Device](https://www.twilio.com/docs/voice/client/javascript/device#twilio-device) class and can be used like the example below. Please see [API Docs](PREFLIGHT.md) for more details about this new API. |
| 84 | + |
| 85 | + ```ts |
| 86 | + // Initiate the test |
| 87 | + const preflight = Device.testPreflight(token, options); |
| 88 | + |
| 89 | + // Subscribe to events |
| 90 | + preflight.on('completed', (report) => console.log(report)); |
| 91 | + preflight.on('failed', (error) => console.log(error)); |
| 92 | + ``` |
| 93 | + |
| 94 | +* [Connection.on('warning')](https://www.twilio.com/docs/voice/client/javascript/connection#onwarning-handlerwarningname) now provides data associated with the warning. This data can provide more details about the warning such as thresholds and WebRTC samples collected that caused the warning. The example below is a warning for high jitter. Please see [Voice Insights SDK Events Reference](https://www.twilio.com/docs/voice/insights/call-quality-events-twilio-client-sdk#warning-events) for a list of possible warnings. |
| 95 | + |
| 96 | + ```ts |
| 97 | + connection.on('warning', (warningName, warningData) => { |
| 98 | + console.log({ warningName, warningData }); |
| 99 | + }); |
| 100 | + ``` |
| 101 | + Example output: |
| 102 | + ```js |
| 103 | + { |
| 104 | + "warningName": "high-jitter", |
| 105 | + "warningData": { |
| 106 | + "name": "jitter", |
| 107 | + |
| 108 | + /** |
| 109 | + * Array of jitter values in the past 5 samples that triggered the warning |
| 110 | + */ |
| 111 | + "values": [35, 44, 31, 32, 32], |
| 112 | + |
| 113 | + /** |
| 114 | + * Array of samples collected that triggered the warning. |
| 115 | + * See sample object format here https://www.twilio.com/docs/voice/client/javascript/connection#sample |
| 116 | + */ |
| 117 | + "samples": [...], |
| 118 | + |
| 119 | + /** |
| 120 | + * The threshold configuration. |
| 121 | + * In this example, high-jitter warning will be raised if the value exceeded more than 30 |
| 122 | + */ |
| 123 | + "threshold": { |
| 124 | + "name": "max", |
| 125 | + "value": 30 |
| 126 | + } |
| 127 | + } |
| 128 | + } |
| 129 | + ``` |
| 130 | + |
10 | 131 | 1.12.5 (Sept 22, 2020)
|
11 | 132 | ====================
|
12 | 133 |
|
|
0 commit comments