fix(Ads): Don't show duplicate SKIP UI in IMA CS (#7084)

SKIP UI in IMA CS can not be disabled, see: https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/faq#13
shaka-project · Jul 23, 2024 · 9337143 · 9337143
1 parent 22a7c49
commit 9337143
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 1 deletion.
diff --git a/externs/shaka/ads.js b/externs/shaka/ads.js
@@ -280,6 +280,11 @@ shaka.extern.IAdManager.Factory;
  * @exportDoc
  */
 shaka.extern.IAd = class {
+  /**
+   * @return {boolean}
+   */
+  needsSkipUI() {}
+
   /**
    * @return {number}
    */

diff --git a/lib/ads/client_side_ad.js b/lib/ads/client_side_ad.js
@@ -50,6 +50,14 @@ shaka.ads.ClientSideAd = class {
         });
   }
 
+  /**
+   * @override
+   * @export
+   */
+  needsSkipUI() {
+    return false;
+  }
+
   /**
    * @override
    * @export

diff --git a/lib/ads/interstitial_ad.js b/lib/ads/interstitial_ad.js
@@ -41,6 +41,13 @@ shaka.ads.InterstitialAd = class {
     this.adPosition_ = adPosition;
   }
 
+  /**
+   * @override
+   * @export
+   */
+  needsSkipUI() {
+    return true;
+  }
 
   /**
    * @override

diff --git a/lib/ads/media_tailor_ad.js b/lib/ads/media_tailor_ad.js
@@ -43,6 +43,13 @@ shaka.ads.MediaTailorAd = class {
     this.isSkipped_ = false;
   }
 
+  /**
+   * @override
+   * @export
+   */
+  needsSkipUI() {
+    return true;
+  }
 
   /**
    * @override

diff --git a/lib/ads/server_side_ad.js b/lib/ads/server_side_ad.js
@@ -35,6 +35,13 @@ shaka.ads.ServerSideAd = class {
     this.adProgressData_ = data;
   }
 
+  /**
+   * @override
+   * @export
+   */
+  needsSkipUI() {
+    return true;
+  }
 
   /**
    * @override

diff --git a/test/test/util/fake_ad.js b/test/test/util/fake_ad.js
@@ -69,6 +69,13 @@ shaka.test.FakeAd = class {
     this.podIndex_ = 1;
   }
 
+  /**
+   * @override
+   */
+  needsSkipUI() {
+    return true;
+  }
+
   /**
    * @override
    */

diff --git a/ui/skip_ad_button.js b/ui/skip_ad_button.js
@@ -127,7 +127,7 @@ shaka.ui.SkipAdButton = class extends shaka.ui.Element {
    * @private
    */
   onAdStarted_() {
-    if (this.ad.isSkippable()) {
+    if (this.ad.isSkippable() && this.ad.needsSkipUI()) {
       shaka.ui.Utils.setDisplay(this.button_, true);
       shaka.ui.Utils.setDisplay(this.counter_, true);
       this.counter_.textContent = '';