feat(Ads): Add config to allow disable interstitials (#7271)

shaka-project · Sep 6, 2024 · 64e45c9 · 64e45c9
1 parent bb78f9f
commit 64e45c9
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 2 deletions.
diff --git a/demo/config.js b/demo/config.js
@@ -376,7 +376,11 @@ shakaDemo.Config = class {
         .addBoolInput_('Skip play detection',
             'ads.skipPlayDetection')
         .addBoolInput_('Supports multiple media elements',
-            'ads.supportsMultipleMediaElements');
+            'ads.supportsMultipleMediaElements')
+        .addBoolInput_('Ignore HLS Interstitial',
+            'ads.disableHLSInterstitial')
+        .addBoolInput_('Ignore DASH Interstitial',
+            'ads.disableDASHInterstitial');
   }
 
   /**

diff --git a/externs/shaka/player.js b/externs/shaka/player.js
@@ -1888,7 +1888,9 @@ shaka.extern.MediaSourceConfiguration;
  * @typedef {{
  *   customPlayheadTracker: boolean,
  *   skipPlayDetection: boolean,
- *   supportsMultipleMediaElements: boolean
+ *   supportsMultipleMediaElements: boolean,
+ *   disableHLSInterstitial: boolean,
+ *   disableDASHInterstitial: boolean
  * }}
  *
  * @description
@@ -1915,6 +1917,14 @@ shaka.extern.MediaSourceConfiguration;
  *   Defaults to <code>true</code> except on Tizen, WebOS, Chromecast,
  *   Hisense, PlayStation 4, PlayStation5, Xbox whose default value is
  *   <code>false</code>.
+ * @property {boolean} disableHLSInterstitial
+ *   If this is true, we ignore HLS interstitial events.
+ *   <br>
+ *   Defaults to <code>false</code>.
+ * @property {boolean} disableDASHInterstitial
+ *   If this is true, we ignore DASH interstitial events.
+ *   <br>
+ *   Defaults to <code>false</code>.
  *
  * @exportDoc
  */

diff --git a/lib/ads/ad_manager.js b/lib/ads/ad_manager.js
@@ -824,6 +824,9 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
    * @export
    */
   onHLSInterstitialMetadata(basePlayer, baseVideo, interstitial) {
+    if (this.config_ && this.config_.disableHLSInterstitial) {
+      return;
+    }
     if (!this.interstitialAdManager_) {
       this.initInterstitial(/* adContainer= */ null, basePlayer, baseVideo);
     }
@@ -837,6 +840,9 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
    * @export
    */
   onDASHInterstitialMetadata(basePlayer, baseVideo, region) {
+    if (this.config_ && this.config_.disableDASHInterstitial) {
+      return;
+    }
     if (region.schemeIdUri != 'urn:mpeg:dash:event:alternativeMPD:2022') {
       return;
     }

diff --git a/lib/util/player_configuration.js b/lib/util/player_configuration.js
@@ -408,6 +408,8 @@ shaka.util.PlayerConfiguration = class {
       customPlayheadTracker,
       skipPlayDetection,
       supportsMultipleMediaElements,
+      disableHLSInterstitial: false,
+      disableDASHInterstitial: false,
     };
 
     const textDisplayer = {