feat(ABR): Add preferNetworkInformationBandwidth config (#7090)

shaka-project · Jul 23, 2024 · 6425b91 · 6425b91
1 parent 1d5c7d2
commit 6425b91
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 2 deletions.
diff --git a/demo/config.js b/demo/config.js
@@ -315,7 +315,9 @@ shakaDemo.Config = class {
         .addNumberInput_('Minimum time to switch',
             'abr.minTimeToSwitch',
             /* canBeDecimal= */ true,
-            /* canBeZero= */ true);
+            /* canBeZero= */ true)
+        .addBoolInput_('Prefer Network Information bandwidth',
+            'abr.preferNetworkInformationBandwidth');
     this.addRetrictionsSection_('abr', 'Adaptation Restrictions');
   }
 

diff --git a/externs/shaka/player.js b/externs/shaka/player.js
@@ -1922,7 +1922,8 @@ shaka.extern.AdsConfiguration;
  *   clearBufferSwitch: boolean,
  *   safeMarginSwitch: number,
  *   cacheLoadThreshold: number,
- *   minTimeToSwitch: number
+ *   minTimeToSwitch: number,
+ *   preferNetworkInformationBandwidth: boolean
  * }}
  *
  * @property {boolean} enabled
@@ -2008,6 +2009,13 @@ shaka.extern.AdsConfiguration;
  *   <br>
  *   Defaults to <code>0</code> seconds except in Apple browsers whose default
  *   value  is <code>0.5</code> seconds.
+ * @property {boolean} preferNetworkInformationBandwidth
+ *   If true, use the Network Information API bandwidth estimation in the
+ *   current AbrManager, if it is available in the browser environment. This
+ *   way Shaka Player will never estimate the bandwidth and we will always
+ *   trust the information provided by the browser.
+ *   <br>
+ *   Defaults to <code>false</code>.
  * @exportDoc
  */
 shaka.extern.AbrConfiguration;

diff --git a/lib/abr/simple_abr_manager.js b/lib/abr/simple_abr_manager.js
@@ -346,6 +346,11 @@ shaka.abr.SimpleAbrManager = class {
    */
   getBandwidthEstimate() {
     const defaultBandwidthEstimate = this.getDefaultBandwidth_();
+    if (navigator.connection && navigator.connection.downlink &&
+        this.config_.useNetworkInformation &&
+        this.config_.preferNetworkInformationBandwidth) {
+      return defaultBandwidthEstimate;
+    }
     const bandwidthEstimate = this.bandwidthEstimator_.getBandwidthEstimate(
         defaultBandwidthEstimate);
     if (this.cmsdManager_) {

diff --git a/lib/util/player_configuration.js b/lib/util/player_configuration.js
@@ -351,6 +351,7 @@ shaka.util.PlayerConfiguration = class {
       safeMarginSwitch: 0,
       cacheLoadThreshold: 20,
       minTimeToSwitch: shaka.util.Platform.isApple() ? 0.5 : 0,
+      preferNetworkInformationBandwidth: false,
     };
 
     const cmcd = {