Merge pull request googleads#859 from tv2/feature/prevent_ad_playing

Added option to prevent ad playing after content start
NativoPlatform · Feb 24, 2020 · 5fc5193 · 5fc5193
2 parents bad7344 + f589fc2
commit 5fc5193
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -165,6 +165,7 @@ the previous snippet. A summary of all settings follows:
 | vastLoadTimeout        | number       | Override for default VAST load timeout in milliseconds for a single wrapper. The default timeout is 5000ms. |
 | vpaidAllowed           | boolean      | **DEPRECATED**, please use vpaidMode. |
 | vpaidMode              | VpaidMode(5) | VPAID Mode. Defaults to ENABLED. This setting,overrides vpaidAllowed. |
+| preventLateAdStart | boolean | Prevent ads from starting after the content has started if an adtimeout occurred (preroll, midroll, postroll). The default value is false
 
 
 (1) [IMA SDK Docs](//developers.google.com/interactive-media-ads/docs/sdks/html5/v3/apis#ima.AdsRenderingSettings)

diff --git a/src/controller.js b/src/controller.js
@@ -87,6 +87,7 @@ Controller.IMA_DEFAULTS = {
   adLabelNofN: 'of',
   showControlsForJSAds: true,
   requestMode: 'onLoad',
+  preventLateAdStart: false,
 };
 
 /**
@@ -490,6 +491,13 @@ Controller.prototype.onPlayerReadyForPreroll = function() {
   this.sdkImpl.onPlayerReadyForPreroll();
 };
 
+/**
+ * Called if the ad times out.
+ */
+Controller.prototype.onAdTimeout = function() {
+  this.sdkImpl.onAdTimeout();
+};
+
 
 /**
  * Called when the player is ready.

diff --git a/src/player-wrapper.js b/src/player-wrapper.js
@@ -137,6 +137,7 @@ const PlayerWrapper = function(player, adsPluginSettings, controller) {
   this.vjsPlayer.on('contentended', this.boundContentEndedListener);
   this.vjsPlayer.on('dispose', this.playerDisposedListener.bind(this));
   this.vjsPlayer.on('readyforpreroll', this.onReadyForPreroll.bind(this));
+  this.vjsPlayer.on('adtimeout', this.onAdTimeout.bind(this));
   this.vjsPlayer.ready(this.onPlayerReady.bind(this));
 
   if (this.controller.getSettings().requestMode === 'onPlay') {
@@ -270,6 +271,12 @@ PlayerWrapper.prototype.onReadyForPreroll = function() {
   this.controller.onPlayerReadyForPreroll();
 };
 
+/**
+ * Detects if the ad has timed out.
+ */
+PlayerWrapper.prototype.onAdTimeout = function() {
+  this.controller.onAdTimeout();
+};
 
 /**
  * Called when the player fires its 'ready' event.

diff --git a/src/sdk-impl.js b/src/sdk-impl.js
@@ -107,6 +107,11 @@ const SdkImpl = function(controller) {
    */
   this.contentCompleteCalled = false;
 
+  /**
+   * True if the ad has timed out.
+   */
+  this.isAdTimedOut = false;
+
   /**
    * Stores the dimensions for the ads manager.
    */
@@ -301,7 +306,14 @@ SdkImpl.prototype.onAdsManagerLoaded = function(adsManagerLoadedEvent) {
     this.initAdsManager();
   }
 
-  this.controller.onAdsReady();
+  const {preventLateAdStart} = this.controller.getSettings();
+
+  if (!preventLateAdStart) {
+    this.controller.onAdsReady();
+  } else if (preventLateAdStart &&
+    !this.isAdTimedOut) {
+    this.controller.onAdsReady();
+  }
 
   if (this.controller.getSettings().adsManagerLoadedCallback) {
     this.controller.getSettings().adsManagerLoadedCallback();
@@ -558,6 +570,10 @@ SdkImpl.prototype.onPlayerReadyForPreroll = function() {
   }
 };
 
+SdkImpl.prototype.onAdTimeout = function() {
+  this.isAdTimedOut = true;
+};
+
 SdkImpl.prototype.onPlayerReady = function() {
   this.initAdObjects();