Fix priority downlink policy bandwidth estimation metrics to work wit…

…h Safari
aws · Nov 11, 2021 · 1224701 · 1224701
1 parent 9a2c5c1
commit 1224701
Show file tree

Hide file tree

Showing 8 changed files with 159 additions and 107 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -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

diff --git a/docs/classes/videoadaptiveprobepolicy.html b/docs/classes/videoadaptiveprobepolicy.html
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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#L237">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:237</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -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>
@@ -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#L423">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:423</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -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#L285">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:285</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -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#L228">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:228</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <a href="../interfaces/videostreamidset.html" class="tsd-signature-type">VideoStreamIdSet</a></h4>
@@ -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#L245">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:245</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -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#L241">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:241</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -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#L255">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:255</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -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>
@@ -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#L223">src/videodownlinkbandwidthpolicy/VideoPriorityBasedPolicy.ts:223</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>