Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix priority downlink policy bandwidth estimation metrics to work with Safari #1783

Merged
merged 1 commit into from
Nov 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Added

### Removed

### Fixed

- Fix priority downlink policy bandwidth estimation metrics to work with Safari.

### Changed

## [2.21.1] - 2021-11-09

### Added
Expand Down
34 changes: 17 additions & 17 deletions docs/classes/videoadaptiveprobepolicy.html
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> default<wbr>Video<w
<aside class="tsd-sources">
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#defaultvideopreferences">defaultVideoPreferences</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L73">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:73</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L74">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:74</a></li>
</ul>
</aside>
</section>
Expand All @@ -187,7 +187,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> observer<wbr>Queue<
<aside class="tsd-sources">
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#observerqueue">observerQueue</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L77">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:77</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L78">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:78</a></li>
</ul>
</aside>
</section>
Expand All @@ -198,7 +198,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> should<wbr>Pause<wb
<aside class="tsd-sources">
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#shouldpausetiles">shouldPauseTiles</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L74">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:74</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L75">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:75</a></li>
</ul>
</aside>
</section>
Expand All @@ -209,7 +209,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> tile<wbr>Controller
<aside class="tsd-sources">
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#tilecontroller">tileController</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L71">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:71</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L72">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:72</a></li>
</ul>
</aside>
</section>
Expand All @@ -220,7 +220,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> video<wbr>Index</h3
<aside class="tsd-sources">
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#videoindex">videoIndex</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L75">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:75</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L76">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:76</a></li>
</ul>
</aside>
</section>
Expand All @@ -231,7 +231,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> video<wbr>Preferenc
<aside class="tsd-sources">
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#videopreferences">videoPreferences</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L72">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:72</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L73">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:73</a></li>
</ul>
</aside>
</section>
Expand All @@ -242,7 +242,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> video<wbr>Preferenc
<aside class="tsd-sources">
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#videopreferencesupdated">videoPreferencesUpdated</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L76">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:76</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L77">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:77</a></li>
</ul>
</aside>
</section>
Expand All @@ -261,7 +261,7 @@ <h3>add<wbr>Observer</h3>
<p>Implementation of <a href="../interfaces/videodownlinkbandwidthpolicy.html">VideoDownlinkBandwidthPolicy</a>.<a href="../interfaces/videodownlinkbandwidthpolicy.html#addobserver">addObserver</a></p>
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#addobserver">addObserver</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L236">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:236</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L240">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:240</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -285,7 +285,7 @@ <h3>bind<wbr>ToTile<wbr>Controller</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#bindtotilecontroller">bindToTileController</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L137">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:137</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L138">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:138</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -309,7 +309,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> calculate<wbr>Optim
<aside class="tsd-sources">
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#calculateoptimalreceiveset">calculateOptimalReceiveSet</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L422">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:422</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L426">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:426</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
Expand All @@ -327,7 +327,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> calculate<wbr>Optim
<aside class="tsd-sources">
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#calculateoptimalreceivestreams">calculateOptimalReceiveStreams</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L284">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:284</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L288">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:288</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
Expand Down Expand Up @@ -377,7 +377,7 @@ <h3>choose<wbr>Subscriptions</h3>
<p>Implementation of <a href="../interfaces/videodownlinkbandwidthpolicy.html">VideoDownlinkBandwidthPolicy</a>.<a href="../interfaces/videodownlinkbandwidthpolicy.html#choosesubscriptions">chooseSubscriptions</a></p>
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#choosesubscriptions">chooseSubscriptions</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L227">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:227</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L231">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:231</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/videostreamidset.html" class="tsd-signature-type">VideoStreamIdSet</a></h4>
Expand All @@ -395,7 +395,7 @@ <h3>for<wbr>Each<wbr>Observer</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#foreachobserver">forEachObserver</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L244">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:244</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L248">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:248</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -438,7 +438,7 @@ <h3>remove<wbr>Observer</h3>
<p>Implementation of <a href="../interfaces/videodownlinkbandwidthpolicy.html">VideoDownlinkBandwidthPolicy</a>.<a href="../interfaces/videodownlinkbandwidthpolicy.html#removeobserver">removeObserver</a></p>
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#removeobserver">removeObserver</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L240">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:240</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L244">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:244</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -481,7 +481,7 @@ <h3>set<wbr>Video<wbr>Priority<wbr>Based<wbr>Policy<wbr>Configs</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#setvideoprioritybasedpolicyconfigs">setVideoPriorityBasedPolicyConfigs</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L254">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:254</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L258">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:258</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -530,7 +530,7 @@ <h3>update<wbr>Metrics</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#updatemetrics">updateMetrics</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L187">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:187</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L188">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:188</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -555,7 +555,7 @@ <h3>wants<wbr>Resubscribe</h3>
<p>Implementation of <a href="../interfaces/videodownlinkbandwidthpolicy.html">VideoDownlinkBandwidthPolicy</a>.<a href="../interfaces/videodownlinkbandwidthpolicy.html#wantsresubscribe">wantsResubscribe</a></p>
<p>Inherited from <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#wantsresubscribe">wantsResubscribe</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L222">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:222</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts#L226">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:226</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
Expand Down
Loading