feat(ads): Add getTitle to CS and SS ads (shaka-project#4513)

joeyparrish · Sep 26, 2022 · a019065 · a019065
1 parent 7166f0c
commit a019065
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 0 deletions.
diff --git a/externs/ima.js b/externs/ima.js
@@ -167,6 +167,9 @@ google.ima.Ad = class {
 
   /** @return {boolean} */
   isLinear() {}
+
+  /** @return {string} */
+  getTitle() {}
 };
 
 
@@ -389,6 +392,9 @@ google.ima.dai.api.Ad = class {
 
   /** @return {boolean} */
   isSkippable() {}
+
+  /** @return {string} */
+  getTitle() {}
 };
 
 

diff --git a/externs/shaka/ads.js b/externs/shaka/ads.js
@@ -227,4 +227,9 @@ shaka.extern.IAd = class {
    * @return {number}
    */
   getPositionInSequence() {}
+
+  /**
+   * @return {string}
+   */
+  getTitle() {}
 };
diff --git a/lib/ads/client_side_ad.js b/lib/ads/client_side_ad.js
@@ -236,6 +236,13 @@ shaka.ads.ClientSideAd = class {
     return podInfo.getAdPosition();
   }
 
+  /**
+   * @override
+   * @export
+   */
+  getTitle() {
+    return this.ad_.getTitle();
+  }
 
   /**
    * @override

diff --git a/lib/ads/server_side_ad.js b/lib/ads/server_side_ad.js
@@ -205,6 +205,13 @@ shaka.ads.ServerSideAd = class {
     return podInfo.getAdPosition();
   }
 
+  /**
+   * @override
+   * @export
+   */
+  getTitle() {
+    return this.ad_.getTitle();
+  }
 
   /**
    * @override

diff --git a/test/test/util/fake_ad.js b/test/test/util/fake_ad.js
@@ -34,6 +34,9 @@ shaka.test.FakeAd = class {
 
     /** @private {number} */
     this.volume_ = 1;
+
+    /** @private {string} */
+    this.title_ = 'Test Title';
   }
 
   /**
@@ -190,6 +193,13 @@ shaka.test.FakeAd = class {
     return this.position_;
   }
 
+  /**
+   * @override
+   * @export
+   */
+  getTitle() {
+    return this.title_;
+  }
 
   /**
    * @override