Source: lib/ads/ad_manager.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. goog.provide('shaka.ads.AdManager');
  10. goog.require('goog.asserts');
  11. goog.require('shaka.Deprecate');
  12. goog.require('shaka.Player');
  13. goog.require('shaka.ads.AdsStats');
  14. goog.require('shaka.ads.ClientSideAdManager');
  15. goog.require('shaka.ads.InterstitialAdManager');
  16. goog.require('shaka.ads.MediaTailorAdManager');
  17. goog.require('shaka.ads.Utils');
  18. goog.require('shaka.ads.ServerSideAdManager');
  19. goog.require('shaka.log');
  20. goog.require('shaka.util.Error');
  21. goog.require('shaka.util.FakeEvent');
  22. goog.require('shaka.util.FakeEventTarget');
  23. goog.require('shaka.util.IReleasable');
  24. goog.require('shaka.util.TXml');
  27. /**
  28.  * @event shaka.ads.AdManager.AdsLoadedEvent
  29.  * @description Fired when a sequence of ads has been loaded.
  30.  * @property {string} type
  31.  *   'ads-loaded'
  32.  * @property {number} loadTime
  33.  *    The time it takes to load ads.
  34.  * @exportDoc
  35.  */
  37. /**
  38.  * @event shaka.ads.AdManager.AdStartedEvent
  39.  * @description Fired when an ad has started playing.
  40.  * @property {string} type
  41.  *   'ad-started'
  42.  * @property {!shaka.extern.IAd} ad
  43.  *    The ad that has started playing.
  44.  * @property {Object} sdkAdObject
  45.  *    The ad object in the SDK format, if there is one.
  46.  * @property {Object} originalEvent
  47.  *    The native SDK event, if available.
  48.  * @exportDoc
  49.  */
  52. /**
  53.  * @event shaka.ads.AdManager.AdCompleteEvent
  54.  * @description Fired when an ad has played through.
  55.  * @property {string} type
  56.  *   'ad-complete'
  57.  * @property {Object} originalEvent
  58.  *    The native SDK event, if available.
  59.  * @exportDoc
  60.  */
  63. /**
  64.  * @event shaka.ads.AdManager.AdSkippedEvent
  65.  * @description Fired when an ad has been skipped.
  66.  * @property {string} type
  67.  *   'ad-skipped'
  68.  * @property {Object} originalEvent
  69.  *    The native SDK event, if available.
  70.  * @exportDoc
  71.  */
  74. /**
  75.  * @event shaka.ads.AdManager.AdFirstQuartileEvent
  76.  * @description Fired when an ad has played through the first 1/4.
  77.  * @property {string} type
  78.  *   'ad-first-quartile'
  79.  * @property {Object} originalEvent
  80.  *    The native SDK event, if available.
  81.  * @exportDoc
  82.  */
  85. /**
  86.  * @event shaka.ads.AdManager.AdMidpointEvent
  87.  * @description Fired when an ad has played through its midpoint.
  88.  * @property {string} type
  89.  *   'ad-midpoint'
  90.  * @property {Object} originalEvent
  91.  *    The native SDK event, if available.
  92.  * @exportDoc
  93.  */
  96. /**
  97.  * @event shaka.ads.AdManager.AdThirdQuartileEvent
  98.  * @description Fired when an ad has played through the third quartile.
  99.  * @property {string} type
  100.  *   'ad-third-quartile'
  101.  * @property {Object} originalEvent
  102.  *    The native SDK event, if available.
  103.  * @exportDoc
  104.  */
  107. /**
  108.  * @event shaka.ads.AdManager.AdStoppedEvent
  109.  * @description Fired when an ad has stopped playing, was skipped,
  110.  *   or was unable to proceed due to an error.
  111.  * @property {string} type
  112.  *   'ad-stopped'
  113.  * @property {Object} originalEvent
  114.  *    The native SDK event, if available.
  115.  * @exportDoc
  116.  */
  119. /**
  120.  * @event shaka.ads.AdManager.AdVolumeChangedEvent
  121.  * @description Fired when an ad's volume changed.
  122.  * @property {string} type
  123.  *   'ad-volume-changed'
  124.  * @property {Object} originalEvent
  125.  *    The native SDK event, if available.
  126.  * @exportDoc
  127.  */
  130. /**
  131.  * @event shaka.ads.AdManager.AdMutedEvent
  132.  * @description Fired when an ad was muted.
  133.  * @property {string} type
  134.  *   'ad-muted'
  135.  * @property {Object} originalEvent
  136.  *    The native SDK event, if available.
  137.  * @exportDoc
  138.  */
  141. /**
  142.  * @event shaka.ads.AdManager.AdPausedEvent
  143.  * @description Fired when an ad was paused.
  144.  * @property {string} type
  145.  *   'ad-paused'
  146.  * @property {Object} originalEvent
  147.  *    The native SDK event, if available.
  148.  * @exportDoc
  149.  */
  152. /**
  153.  * @event shaka.ads.AdManager.AdResumedEvent
  154.  * @description Fired when an ad was resumed after a pause.
  155.  * @property {string} type
  156.  *   'ad-resumed'
  157.  * @property {Object} originalEvent
  158.  *    The native SDK event, if available.
  159.  * @exportDoc
  160.  */
  163. /**
  164.  * @event shaka.ads.AdManager.AdSkipStateChangedEvent
  165.  * @description Fired when an ad's skip state changes (for example, when
  166.  *  it becomes possible to skip the ad).
  167.  * @property {string} type
  168.  *   'ad-skip-state-changed'
  169.  * @property {Object} originalEvent
  170.  *    The native SDK event, if available.
  171.  * @exportDoc
  172.  */
  175. /**
  176.  * @event shaka.ads.AdManager.AdCuePointsChangedEvent
  177.  * @description Fired when the ad cue points change, signalling ad breaks
  178.  *  change.
  179.  * @property {string} type
  180.  *   'ad-cue-points-changed'
  181.  * @property {!Array<!shaka.extern.AdCuePoint>} cuepoints
  182.  *    The ad cue points, if available.
  183.  * @exportDoc
  184.  */
  187. /**
  188.  * @event shaka.ads.AdManager.AdProgressEvent
  189.  * @description Fired when there is an update to the current ad's progress.
  190.  * @property {string} type
  191.  *   'ad-progress'
  192.  * @property {Object} originalEvent
  193.  *    The native SDK event, if available.
  194.  * @exportDoc
  195.  */
  198. /**
  199.  * @event shaka.ads.AdManager.AdBufferingEvent
  200.  * @description Fired when the ad has stalled playback to buffer.
  201.  * @property {string} type
  202.  *   'ad-buffering'
  203.  * @property {Object} originalEvent
  204.  *    The native SDK event, if available.
  205.  * @exportDoc
  206.  */
  209. /**
  210.  * @event shaka.ads.AdManager.AdImpressionEvent
  211.  * @description Fired when the impression URL has been pinged.
  212.  * @property {string} type
  213.  *   'ad-impression'
  214.  * @property {Object} originalEvent
  215.  *    The native SDK event, if available.
  216.  * @exportDoc
  217.  */
  220. /**
  221.  * @event shaka.ads.AdManager.AdClickEvent
  222.  * @description Fired when the ad was clicked.
  223.  * @property {string} type
  224.  *   'ad-clicked'
  225.  * @property {Object} originalEvent
  226.  *    The native SDK event, if available.
  227.  * @exportDoc
  228.  */
  231. /**
  232.  * @event shaka.ads.AdManager.AdDurationChangedEvent
  233.  * @description Fired when the ad's duration changes.
  234.  * @property {string} type
  235.  *   'ad-duration-changed'
  236.  * @property {Object} originalEvent
  237.  *    The native SDK event, if available.
  238.  * @exportDoc
  239.  */
  242. /**
  243.  * @event shaka.ads.AdManager.AdClosedEvent
  244.  * @description Fired when the ad was closed by the user.
  245.  * @property {string} type
  246.  *   'ad-closed'
  247.  * @property {Object} originalEvent
  248.  *    The native SDK event, if available.
  249.  * @exportDoc
  250.  */
  253. /**
  254.  * @event shaka.ads.AdManager.AdLoadedEvent
  255.  * @description Fired when the ad data becomes available.
  256.  * @property {string} type
  257.  *   'ad-loaded'
  258.  * @property {Object} originalEvent
  259.  *    The native SDK event, if available.
  260.  * @exportDoc
  261.  */
  264. /**
  265.  * @event shaka.ads.AdManager.AllAdsCompletedEvent
  266.  * @description Fired when the ads manager is done playing all the ads.
  267.  * @property {string} type
  268.  *   'all-ads-completed'
  269.  * @property {Object} originalEvent
  270.  *    The native SDK event, if available.
  271.  * @exportDoc
  272.  */
  275. /**
  276.  * @event shaka.ads.AdManager.AdLinearChangedEvent
  277.  * @description Fired when the displayed ad changes from
  278.  *   linear to nonlinear, or vice versa.
  279.  * @property {string} type
  280.  *   'ad-linear-changed'
  281.  * @property {Object} originalEvent
  282.  *    The native SDK event, if available.
  283.  * @exportDoc
  284.  */
  287. /**
  288.  * @event shaka.ads.AdManager.AdMetadataEvent
  289.  * @description Fired when the ad's metadata becomes available.
  290.  * @property {string} type
  291.  *   'ad-metadata'
  292.  * @property {Object} originalEvent
  293.  *    The native SDK event, if available.
  294.  * @exportDoc
  295.  */
  298. /**
  299.  * @event shaka.ads.AdManager#AdBreakReadyEvent
  300.  * @description Fired when the client-side SDK is ready to play a
  301.  *   VPAID ad or an ad rule.
  302.  * @property {string} type
  303.  *   'ad-break-ready'
  304.  * @property {Object} originalEvent
  305.  *    The native SDK event, if available.
  306.  * @exportDoc
  307.  */
  310. /**
  311.  * @event shaka.ads.AdManager.AdRecoverableErrorEvent
  312.  * @description Fired when the a non-fatal error was encountered.
  313.  *   The presentation will continue with the same or next ad playback
  314.  *   depending on the error situation.
  315.  * @property {string} type
  316.  *   'ad-recoverable-error'
  317.  * @property {Object} originalEvent
  318.  *    The native SDK event, if available.
  319.  * @exportDoc
  320.  */
  323. /**
  324.  * @event shaka.ads.Utils.AD_ERROR
  325.  * @description Fired when a fatal error is encountered.
  326.  * @property {string} type
  327.  *   'ad-error'
  328.  * @property {Object} originalEvent
  329.  *    The native SDK event, if available.
  330.  * @exportDoc
  331.  */
  334. /**
  335.  * @event shaka.ads.AdManager.AdInteractionEvent
  336.  * @description Fired when an ad triggers the interaction callback.
  337.  * @property {string} type
  338.  *   'ad-interaction'
  339.  * @property {Object} originalEvent
  340.  *    The native SDK event, if available.
  341.  * @exportDoc
  342.  */
  345. /**
  346.  * @event shaka.ads.AdManager#ImaAdManagerLoadedEvent
  347.  * @description Fired when the native IMA ad manager becomes available.
  348.  * @property {string} type
  349.  *   'ima-ad-manager-loaded'
  350.  * @property {!Object} imaAdManager
  351.  *    The native IMA ad manager.
  352.  * @exportDoc
  353.  */
  356. /**
  357.  * @event shaka.ads.AdManager#ImaStreamManagerLoadedEvent
  358.  * @description Fired when the native IMA stream manager becomes available.
  359.  * @property {string} type
  360.  *   'ima-stream-manager-loaded'
  361.  * @property {!Object} imaStreamManager
  362.  *    The native IMA stream manager.
  363.  * @exportDoc
  364.  */
  367. /**
  368.  * @event shaka.ads.AdManager.AdClickedEvent
  369.  * @description Fired when the ad was clicked.
  370.  * @property {string} type
  371.  *   'ad-clicked'
  372.  * @exportDoc
  373.  */
  376. /**
  377.  * @event shaka.ads.AdManager.AdContentPauseRequestedEvent
  378.  * @description Fired when the ad requires the main content to be paused.
  379.  *   Fired when the platform does not support multiple media elements.
  380.  * @property {string} type
  381.  *   'ad-content-pause-requested'
  382.  * @property {?boolean} saveLivePosition
  383.  *    Indicates whether the live position has to be saved or not.
  384.  * @exportDoc
  385.  */
  388. /**
  389.  * @event shaka.ads.AdManager.AdContentResumeRequestedEvent
  390.  * @description Fired when the ad requires the main content to be resumed.
  391.  *   Fired when the platform does not support multiple media elements.
  392.  * @property {string} type
  393.  *   'ad-content-resume-requested'
  394.  * @property {?number} offset
  395.  *   Indicates the offset that should be applied to the previously saved time.
  396.  * @exportDoc
  397.  */
  400. /**
  401.  * @event shaka.ads.AdManager.AdContentResumeRequestedEvent
  402.  * @description Fired when the ad requires the video of the main content to be
  403.  *   attached.
  404.  * @property {string} type
  405.  *   'ad-content-attach-requested'
  406.  * @exportDoc
  407.  */
  410. /**
  411.  * A class responsible for ad-related interactions.
  412.  * @implements {shaka.extern.IAdManager}
  413.  * @implements {shaka.util.IReleasable}
  414.  * @export
  415.  */
  416. shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
  417.   /** */
  418.   constructor() {
  419.     super();
  420.     /** @private {shaka.ads.InterstitialAdManager} */
  421.     this.interstitialAdManager_ = null;
  422.     /** @private {shaka.ads.ClientSideAdManager} */
  423.     this.csAdManager_ = null;
  424.     /** @private {shaka.ads.MediaTailorAdManager} */
  425.     this.mtAdManager_ = null;
  426.     /** @private {shaka.ads.ServerSideAdManager} */
  427.     this.ssAdManager_ = null;
  428.     /** @private {shaka.ads.AdsStats} */
  429.     this.stats_ = new shaka.ads.AdsStats();
  430.     /** @private {string} locale */
  431.     this.locale_ = navigator.language;
  432.     /** @private {?shaka.extern.AdsConfiguration} */
  433.     this.config_ = null;
  434.   }
  437.   /**
  438.    * @override
  439.    * @export
  440.    */
  441.   setLocale(locale) {
  442.     this.locale_ = locale;
  443.   }
  446.   /**
  447.    * @override
  448.    * @export
  449.    */
  450.   configure(config) {
  451.     this.config_ = config;
  452.     if (this.interstitialAdManager_) {
  453.       this.interstitialAdManager_.configure(this.config_);
  454.     }
  455.     if (this.csAdManager_) {
  456.       this.csAdManager_.configure(this.config_);
  457.     }
  458.     if (this.ssAdManager_) {
  459.       this.ssAdManager_.configure(this.config_);
  460.     }
  461.   }
  464.   /**
  465.    * @override
  466.    * @export
  467.    */
  468.   initInterstitial(adContainer, basePlayer, baseVideo) {
  469.     if (!adContainer) {
  470.       shaka.log.info('Initializing interstitials without ad container');
  471.     }
  472.     if (this.interstitialAdManager_) {
  473.       this.interstitialAdManager_.release();
  474.     }
  475.     this.interstitialAdManager_ = new shaka.ads.InterstitialAdManager(
  476.         adContainer, basePlayer, baseVideo,
  477.         (e) => this.processAndDispatchEvent_(e));
  479.     goog.asserts.assert(this.config_, 'Config must not be null!');
  480.     this.interstitialAdManager_.configure(this.config_);
  481.   }
  484.   /**
  485.    * @override
  486.    * @export
  487.    */
  488.   initClientSide(adContainer, video, adsRenderingSettings) {
  489.     // Check that Client Side IMA SDK has been included
  490.     // NOTE: (window['google'] && google.ima) check for any
  491.     // IMA SDK, including SDK for Server Side ads.
  492.     // The 3rd check insures we have the right SDK:
  493.     // {google.ima.AdsLoader} is an object that's part of CS IMA SDK
  494.     // but not SS SDK.
  495.     if (!window['google'] || !google.ima || !google.ima.AdsLoader) {
  496.       throw new shaka.util.Error(
  497.           shaka.util.Error.Severity.CRITICAL,
  498.           shaka.util.Error.Category.ADS,
  499.           shaka.util.Error.Code.CS_IMA_SDK_MISSING);
  500.     }
  502.     if (this.csAdManager_) {
  503.       this.csAdManager_.release();
  504.     }
  506.     this.csAdManager_ = new shaka.ads.ClientSideAdManager(
  507.         adContainer, video, this.locale_, adsRenderingSettings,
  508.         (e) => this.processAndDispatchEvent_(e));
  510.     goog.asserts.assert(this.config_, 'Config must not be null!');
  511.     this.csAdManager_.configure(this.config_);
  512.   }
  515.   /**
  516.    * @override
  517.    * @export
  518.    */
  519.   release() {
  520.     if (this.interstitialAdManager_) {
  521.       this.interstitialAdManager_.release();
  522.       this.interstitialAdManager_ = null;
  523.     }
  524.     if (this.csAdManager_) {
  525.       this.csAdManager_.release();
  526.       this.csAdManager_ = null;
  527.     }
  528.     if (this.mtAdManager_) {
  529.       this.mtAdManager_.release();
  530.       this.mtAdManager_ = null;
  531.     }
  532.     if (this.ssAdManager_) {
  533.       this.ssAdManager_.release();
  534.       this.ssAdManager_ = null;
  535.     }
  536.     super.release();
  537.   }
  540.   /**
  541.    * @override
  542.    * @export
  543.    */
  544.   onAssetUnload() {
  545.     if (this.interstitialAdManager_) {
  546.       this.interstitialAdManager_.stop();
  547.     }
  548.     if (this.csAdManager_) {
  549.       this.csAdManager_.stop();
  550.     }
  551.     if (this.mtAdManager_) {
  552.       this.mtAdManager_.stop();
  553.     }
  554.     if (this.ssAdManager_) {
  555.       this.ssAdManager_.stop();
  556.     }
  558.     this.dispatchEvent(
  559.         new shaka.util.FakeEvent(shaka.ads.Utils.AD_STOPPED));
  560.     this.dispatchEvent(new shaka.util.FakeEvent(
  561.         shaka.ads.Utils.AD_CONTENT_ATTACH_REQUESTED));
  563.     this.stats_ = new shaka.ads.AdsStats();
  564.   }
  567.   /**
  568.    * @override
  569.    * @export
  570.    */
  571.   requestClientSideAds(imaRequest) {
  572.     if (!this.csAdManager_) {
  573.       throw new shaka.util.Error(
  574.           shaka.util.Error.Severity.RECOVERABLE,
  575.           shaka.util.Error.Category.ADS,
  576.           shaka.util.Error.Code.CS_AD_MANAGER_NOT_INITIALIZED);
  577.     }
  579.     this.csAdManager_.requestAds(imaRequest);
  580.   }
  583.   /**
  584.    * @override
  585.    * @export
  586.    */
  587.   updateClientSideAdsRenderingSettings(adsRenderingSettings) {
  588.     if (!this.csAdManager_) {
  589.       throw new shaka.util.Error(
  590.           shaka.util.Error.Severity.RECOVERABLE,
  591.           shaka.util.Error.Category.ADS,
  592.           shaka.util.Error.Code.CS_AD_MANAGER_NOT_INITIALIZED);
  593.     }
  595.     this.csAdManager_.updateAdsRenderingSettings(adsRenderingSettings);
  596.   }
  599.   /**
  600.    * @override
  601.    * @export
  602.    */
  603.   initMediaTailor(adContainer, networkingEngine, video) {
  604.     if (this.mtAdManager_) {
  605.       this.mtAdManager_.release();
  606.     }
  608.     this.mtAdManager_ = new shaka.ads.MediaTailorAdManager(
  609.         adContainer, networkingEngine, video,
  610.         (e) => this.processAndDispatchEvent_(e));
  611.   }
  614.   /**
  615.    * @param {string} url
  616.    * @param {Object} adsParams
  617.    * @param {string=} backupUrl
  618.    * @return {!Promise<string>}
  619.    * @override
  620.    * @export
  621.    */
  622.   requestMediaTailorStream(url, adsParams, backupUrl = '') {
  623.     if (!this.mtAdManager_) {
  624.       throw new shaka.util.Error(
  625.           shaka.util.Error.Severity.RECOVERABLE,
  626.           shaka.util.Error.Category.ADS,
  627.           shaka.util.Error.Code.MT_AD_MANAGER_NOT_INITIALIZED);
  628.     }
  630.     return this.mtAdManager_.streamRequest(url, adsParams, backupUrl);
  631.   }
  634.   /**
  635.    * @param {string} url
  636.    * @override
  637.    * @export
  638.    */
  639.   addMediaTailorTrackingUrl(url) {
  640.     if (!this.mtAdManager_) {
  641.       throw new shaka.util.Error(
  642.           shaka.util.Error.Severity.RECOVERABLE,
  643.           shaka.util.Error.Category.ADS,
  644.           shaka.util.Error.Code.MT_AD_MANAGER_NOT_INITIALIZED);
  645.     }
  647.     this.mtAdManager_.addTrackingUrl(url);
  648.   }
  651.   /**
  652.    * @override
  653.    * @export
  654.    */
  655.   initServerSide(adContainer, video) {
  656.     // Check that Client Side IMA SDK has been included
  657.     // NOTE: (window['google'] && google.ima) check for any
  658.     // IMA SDK, including SDK for Server Side ads.
  659.     // The 3rd check insures we have the right SDK:
  660.     // {google.ima.dai} is an object that's part of DAI IMA SDK
  661.     // but not SS SDK.
  662.     if (!window['google'] || !google.ima || !google.ima.dai) {
  663.       throw new shaka.util.Error(
  664.           shaka.util.Error.Severity.CRITICAL,
  665.           shaka.util.Error.Category.ADS,
  666.           shaka.util.Error.Code.SS_IMA_SDK_MISSING);
  667.     }
  669.     if (this.ssAdManager_) {
  670.       this.ssAdManager_.release();
  671.     }
  673.     this.ssAdManager_ = new shaka.ads.ServerSideAdManager(
  674.         adContainer, video, this.locale_,
  675.         (e) => this.processAndDispatchEvent_(e));
  677.     goog.asserts.assert(this.config_, 'Config must not be null!');
  678.     this.ssAdManager_.configure(this.config_);
  679.   }
  682.   /**
  683.    * @param {!google.ima.dai.api.StreamRequest} imaRequest
  684.    * @param {string=} backupUrl
  685.    * @return {!Promise<string>}
  686.    * @override
  687.    * @export
  688.    */
  689.   requestServerSideStream(imaRequest, backupUrl = '') {
  690.     if (!this.ssAdManager_) {
  691.       throw new shaka.util.Error(
  692.           shaka.util.Error.Severity.RECOVERABLE,
  693.           shaka.util.Error.Category.ADS,
  694.           shaka.util.Error.Code.SS_AD_MANAGER_NOT_INITIALIZED);
  695.     }
  697.     if (!imaRequest.adTagParameters) {
  698.       imaRequest.adTagParameters = {};
  699.     }
  700.     const adTagParams = imaRequest.adTagParameters;
  702.     if (adTagParams['mpt'] || adTagParams['mpv']) {
  703.       shaka.log.alwaysWarn('You have attempted to set "mpt" and/or "mpv" ' +
  704.         'parameters of the ad tag. Please note that those parameters are ' +
  705.         'used for Shaka adoption tracking and will be overridden.');
  706.     }
  708.     // Set player and version parameters for tracking
  709.     imaRequest.adTagParameters['mpt'] = 'shaka-player';
  710.     imaRequest.adTagParameters['mpv'] = shaka.Player.version;
  711.     return this.ssAdManager_.streamRequest(imaRequest, backupUrl);
  712.   }
  715.   /**
  716.    * @override
  717.    * @export
  718.    */
  719.   replaceServerSideAdTagParameters(adTagParameters) {
  720.     if (!this.ssAdManager_) {
  721.       throw new shaka.util.Error(
  722.           shaka.util.Error.Severity.RECOVERABLE,
  723.           shaka.util.Error.Category.ADS,
  724.           shaka.util.Error.Code.SS_AD_MANAGER_NOT_INITIALIZED);
  725.     }
  727.     if (adTagParameters['mpt'] || adTagParameters['mpv']) {
  728.       shaka.log.alwaysWarn('You have attempted to set "mpt" and/or "mpv" ' +
  729.         'parameters of the ad tag. Please note that those parameters are ' +
  730.         'used for Shaka adoption tracking and will be overridden.');
  731.     }
  733.     adTagParameters['mpt'] = 'Shaka Player';
  734.     adTagParameters['mpv'] = shaka.Player.version;
  736.     this.ssAdManager_.replaceAdTagParameters(adTagParameters);
  737.   }
  740.   /**
  741.    * @return {!Array<!shaka.extern.AdCuePoint>}
  742.    * @override
  743.    * @export
  744.    */
  745.   getServerSideCuePoints() {
  746.     shaka.Deprecate.deprecateFeature(5,
  747.         'AdManager.getServerSideCuePoints',
  748.         'Please use getCuePoints function.');
  749.     return this.getCuePoints();
  750.   }
  753.   /**
  754.    * @return {!Array<!shaka.extern.AdCuePoint>}
  755.    * @override
  756.    * @export
  757.    */
  758.   getCuePoints() {
  759.     let cuepoints = [];
  760.     if (this.ssAdManager_) {
  761.       cuepoints = cuepoints.concat(this.ssAdManager_.getCuePoints());
  762.     }
  763.     if (this.mtAdManager_) {
  764.       cuepoints = cuepoints.concat(this.mtAdManager_.getCuePoints());
  765.     }
  766.     return cuepoints;
  767.   }
  770.   /**
  771.    * @return {shaka.extern.AdsStats}
  772.    * @override
  773.    * @export
  774.    */
  775.   getStats() {
  776.     return this.stats_.getBlob();
  777.   }
  779.   /**
  780.    * @override
  781.    * @export
  782.    */
  783.   onManifestUpdated(isLive) {
  784.     if (this.mtAdManager_) {
  785.       this.mtAdManager_.onManifestUpdated(isLive);
  786.     }
  787.   }
  789.   /**
  790.    * @override
  791.    * @export
  792.    */
  793.   onDashTimedMetadata(region) {
  794.     if (this.ssAdManager_ && region.schemeIdUri == 'urn:google:dai:2018') {
  795.       const type = region.schemeIdUri;
  796.       const data = region.eventNode ?
  797.           region.eventNode.attributes['messageData'] : null;
  798.       const timestamp = region.startTime;
  799.       this.ssAdManager_.onTimedMetadata(type, data, timestamp);
  800.     }
  801.   }
  803.   /**
  804.    * @override
  805.    * @export
  806.    */
  807.   onHlsTimedMetadata(metadata, timestamp) {
  808.     if (this.ssAdManager_) {
  809.       this.ssAdManager_.onTimedMetadata('ID3', metadata['data'], timestamp);
  810.     }
  811.   }
  813.   /**
  814.    * @override
  815.    * @export
  816.    */
  817.   onCueMetadataChange(value) {
  818.     if (this.ssAdManager_) {
  819.       this.ssAdManager_.onCueMetadataChange(value);
  820.     }
  821.   }
  823.   /**
  824.    * @override
  825.    * @export
  826.    */
  827.   onHLSInterstitialMetadata(basePlayer, baseVideo, interstitial) {
  828.     if (this.config_ && this.config_.disableHLSInterstitial) {
  829.       return;
  830.     }
  831.     if (!this.interstitialAdManager_) {
  832.       this.initInterstitial(/* adContainer= */ null, basePlayer, baseVideo);
  833.     }
  834.     if (this.interstitialAdManager_) {
  835.       this.interstitialAdManager_.addMetadata(interstitial);
  836.     }
  837.   }
  839.   /**
  840.    * @override
  841.    * @export
  842.    */
  843.   onDASHInterstitialMetadata(basePlayer, baseVideo, region) {
  844.     if (this.config_ && this.config_.disableDASHInterstitial) {
  845.       return;
  846.     }
  847.     const schemeIdUri = region.schemeIdUri;
  848.     if (schemeIdUri == 'urn:mpeg:dash:event:alternativeMPD:insert:2025' ||
  849.         schemeIdUri == 'urn:mpeg:dash:event:alternativeMPD:replace:2025') {
  850.       if (!this.interstitialAdManager_) {
  851.         this.initInterstitial(/* adContainer= */ null, basePlayer, baseVideo);
  852.       }
  853.       if (this.interstitialAdManager_) {
  854.         this.interstitialAdManager_.addRegion(region);
  855.       }
  856.     } else if (schemeIdUri == 'urn:mpeg:dash:event:2012' &&
  857.         region.eventNode &&
  858.         shaka.util.TXml.findChild(region.eventNode, 'OverlayEvent')) {
  859.       if (!this.interstitialAdManager_) {
  860.         this.initInterstitial(/* adContainer= */ null, basePlayer, baseVideo);
  861.       }
  862.       if (this.interstitialAdManager_) {
  863.         this.interstitialAdManager_.addOverlayRegion(region);
  864.       }
  865.     }
  866.   }
  868.   /**
  869.    * @override
  870.    * @export
  871.    */
  872.   addCustomInterstitial(interstitial) {
  873.     if (!this.interstitialAdManager_) {
  874.       throw new shaka.util.Error(
  875.           shaka.util.Error.Severity.RECOVERABLE,
  876.           shaka.util.Error.Category.ADS,
  877.           shaka.util.Error.Code.INTERSTITIAL_AD_MANAGER_NOT_INITIALIZED);
  878.     }
  879.     this.interstitialAdManager_.addInterstitials([interstitial]);
  880.   }
  882.   /**
  883.    * @override
  884.    * @export
  885.    */
  886.   addAdUrlInterstitial(url) {
  887.     if (!this.interstitialAdManager_) {
  888.       throw new shaka.util.Error(
  889.           shaka.util.Error.Severity.RECOVERABLE,
  890.           shaka.util.Error.Category.ADS,
  891.           shaka.util.Error.Code.INTERSTITIAL_AD_MANAGER_NOT_INITIALIZED);
  892.     }
  893.     return this.interstitialAdManager_.addAdUrlInterstitial(url);
  894.   }
  896.   /**
  897.    * @override
  898.    * @export
  899.    */
  900.   getInterstitialPlayer() {
  901.     if (!this.interstitialAdManager_) {
  902.       throw new shaka.util.Error(
  903.           shaka.util.Error.Severity.RECOVERABLE,
  904.           shaka.util.Error.Category.ADS,
  905.           shaka.util.Error.Code.INTERSTITIAL_AD_MANAGER_NOT_INITIALIZED);
  906.     }
  907.     return this.interstitialAdManager_.getPlayer();
  908.   }
  910.   /**
  911.    * @param {!shaka.util.FakeEvent} event
  912.    * @private
  913.    */
  914.   processAndDispatchEvent_(event) {
  915.     if (event && event.type) {
  916.       switch (event.type) {
  917.         case shaka.ads.Utils.ADS_LOADED: {
  918.           const loadTime = (/** @type {!Object} */ (event))['loadTime'];
  919.           this.stats_.addLoadTime(loadTime);
  920.           break;
  921.         }
  922.         case shaka.ads.Utils.AD_STARTED:
  923.           this.stats_.incrementStarted();
  924.           break;
  925.         case shaka.ads.Utils.AD_COMPLETE:
  926.           this.stats_.incrementPlayedCompletely();
  927.           break;
  928.         case shaka.ads.Utils.AD_SKIPPED:
  929.           this.stats_.incrementSkipped();
  930.           break;
  931.         case shaka.ads.Utils.AD_ERROR:
  932.           this.stats_.incrementErrors();
  933.           break;
  934.       }
  935.     }
  936.     this.dispatchEvent(event);
  937.   }
  938. };
  940. /**
  941.  * The event name for when a sequence of ads has been loaded.
  942.  *
  943.  * Deprecated, please use {@link shaka.ads.Utils}
  944.  *
  945.  * @const {string}
  946.  * @export
  947.  * @deprecated
  948.  */
  949. shaka.ads.AdManager.ADS_LOADED = 'ads-loaded';
  951. /**
  952.  * The event name for when an ad has started playing.
  953.  *
  954.  * Deprecated, please use {@link shaka.ads.Utils}
  955.  *
  956.  * @const {string}
  957.  * @export
  958.  * @deprecated
  959.  */
  960. shaka.ads.AdManager.AD_STARTED = 'ad-started';
  963. /**
  964.  * The event name for when an ad playhead crosses first quartile.
  965.  *
  966.  * Deprecated, please use {@link shaka.ads.Utils}
  967.  *
  968.  * @const {string}
  969.  * @export
  970.  * @deprecated
  971.  */
  972. shaka.ads.AdManager.AD_FIRST_QUARTILE = 'ad-first-quartile';
  975. /**
  976.  * The event name for when an ad playhead crosses midpoint.
  977.  *
  978.  * Deprecated, please use {@link shaka.ads.Utils}
  979.  *
  980.  * @const {string}
  981.  * @export
  982.  * @deprecated
  983.  */
  984. shaka.ads.AdManager.AD_MIDPOINT = 'ad-midpoint';
  987. /**
  988.  * The event name for when an ad playhead crosses third quartile.
  989.  *
  990.  * Deprecated, please use {@link shaka.ads.Utils}
  991.  *
  992.  * @const {string}
  993.  * @export
  994.  * @deprecated
  995.  */
  996. shaka.ads.AdManager.AD_THIRD_QUARTILE = 'ad-third-quartile';
  999. /**
  1000.  * The event name for when an ad has completed playing.
  1001.  *
  1002.  * Deprecated, please use {@link shaka.ads.Utils}
  1003.  *
  1004.  * @const {string}
  1005.  * @export
  1006.  * @deprecated
  1007.  */
  1008. shaka.ads.AdManager.AD_COMPLETE = 'ad-complete';
  1011. /**
  1012.  * The event name for when an ad has finished playing
  1013.  * (played all the way through, was skipped, or was unable to proceed
  1014.  * due to an error).
  1015.  *
  1016.  * Deprecated, please use {@link shaka.ads.Utils}
  1017.  *
  1018.  * @const {string}
  1019.  * @export
  1020.  * @deprecated
  1021.  */
  1022. shaka.ads.AdManager.AD_STOPPED = 'ad-stopped';
  1025. /**
  1026.  * The event name for when an ad is skipped by the user.
  1027.  *
  1028.  * Deprecated, please use {@link shaka.ads.Utils}
  1029.  *
  1030.  * @const {string}
  1031.  * @export
  1032.  * @deprecated
  1033.  */
  1034. shaka.ads.AdManager.AD_SKIPPED = 'ad-skipped';
  1037. /**
  1038.  * The event name for when the ad volume has changed.
  1039.  *
  1040.  * Deprecated, please use {@link shaka.ads.Utils}
  1041.  *
  1042.  * @const {string}
  1043.  * @export
  1044.  * @deprecated
  1045.  */
  1046. shaka.ads.AdManager.AD_VOLUME_CHANGED = 'ad-volume-changed';
  1049. /**
  1050.  * The event name for when the ad was muted.
  1051.  *
  1052.  * Deprecated, please use {@link shaka.ads.Utils}
  1053.  *
  1054.  * @const {string}
  1055.  * @export
  1056.  * @deprecated
  1057.  */
  1058. shaka.ads.AdManager.AD_MUTED = 'ad-muted';
  1061. /**
  1062.  * The event name for when the ad was paused.
  1063.  *
  1064.  * Deprecated, please use {@link shaka.ads.Utils}
  1065.  *
  1066.  * @const {string}
  1067.  * @export
  1068.  * @deprecated
  1069.  */
  1070. shaka.ads.AdManager.AD_PAUSED = 'ad-paused';
  1073. /**
  1074.  * The event name for when the ad was resumed after a pause.
  1075.  *
  1076.  * Deprecated, please use {@link shaka.ads.Utils}
  1077.  *
  1078.  * @const {string}
  1079.  * @export
  1080.  * @deprecated
  1081.  */
  1082. shaka.ads.AdManager.AD_RESUMED = 'ad-resumed';
  1085. /**
  1086.  * The event name for when the ad's skip status changes
  1087.  * (usually it becomes skippable when it wasn't before).
  1088.  *
  1089.  * Deprecated, please use {@link shaka.ads.Utils}
  1090.  *
  1091.  * @const {string}
  1092.  * @export
  1093.  * @deprecated
  1094.  */
  1095. shaka.ads.AdManager.AD_SKIP_STATE_CHANGED = 'ad-skip-state-changed';
  1098. /**
  1099.  * The event name for when the ad's cue points (start/end markers)
  1100.  * have changed.
  1101.  *
  1102.  * Deprecated, please use {@link shaka.ads.Utils}
  1103.  *
  1104.  * @const {string}
  1105.  * @export
  1106.  * @deprecated
  1107.  */
  1108. shaka.ads.AdManager.CUEPOINTS_CHANGED = 'ad-cue-points-changed';
  1111. /**
  1112.  * The event name for when the native IMA ad manager object has
  1113.  * loaded and become available.
  1114.  *
  1115.  * Deprecated, please use {@link shaka.ads.Utils}
  1116.  *
  1117.  * @const {string}
  1118.  * @export
  1119.  * @deprecated
  1120.  */
  1121. shaka.ads.AdManager.IMA_AD_MANAGER_LOADED = 'ima-ad-manager-loaded';
  1124. /**
  1125.  * The event name for when the native IMA stream manager object has
  1126.  * loaded and become available.
  1127.  *
  1128.  * Deprecated, please use {@link shaka.ads.Utils}
  1129.  *
  1130.  * @const {string}
  1131.  * @export
  1132.  * @deprecated
  1133.  */
  1134. shaka.ads.AdManager.IMA_STREAM_MANAGER_LOADED = 'ima-stream-manager-loaded';
  1137. /**
  1138.  * The event name for when the ad was clicked.
  1139.  *
  1140.  * Deprecated, please use {@link shaka.ads.Utils}
  1141.  *
  1142.  * @const {string}
  1143.  * @export
  1144.  * @deprecated
  1145.  */
  1146. shaka.ads.AdManager.AD_CLICKED = 'ad-clicked';
  1149. /**
  1150.  * The event name for when there is an update to the current ad's progress.
  1151.  *
  1152.  * Deprecated, please use {@link shaka.ads.Utils}
  1153.  *
  1154.  * @const {string}
  1155.  * @export
  1156.  * @deprecated
  1157.  */
  1158. shaka.ads.AdManager.AD_PROGRESS = 'ad-progress';
  1161. /**
  1162.  * The event name for when the ad is buffering.
  1163.  *
  1164.  * Deprecated, please use {@link shaka.ads.Utils}
  1165.  *
  1166.  * @const {string}
  1167.  * @export
  1168.  * @deprecated
  1169.  */
  1170. shaka.ads.AdManager.AD_BUFFERING = 'ad-buffering';
  1173. /**
  1174.  * The event name for when the ad's URL was hit.
  1175.  *
  1176.  * Deprecated, please use {@link shaka.ads.Utils}
  1177.  *
  1178.  * @const {string}
  1179.  * @export
  1180.  * @deprecated
  1181.  */
  1182. shaka.ads.AdManager.AD_IMPRESSION = 'ad-impression';
  1185. /**
  1186.  * The event name for when the ad's duration changed.
  1187.  *
  1188.  * Deprecated, please use {@link shaka.ads.Utils}
  1189.  *
  1190.  * @const {string}
  1191.  * @export
  1192.  * @deprecated
  1193.  */
  1194. shaka.ads.AdManager.AD_DURATION_CHANGED = 'ad-duration-changed';
  1197. /**
  1198.  * The event name for when the ad was closed by the user.
  1199.  *
  1200.  * Deprecated, please use {@link shaka.ads.Utils}
  1201.  *
  1202.  * @const {string}
  1203.  * @export
  1204.  * @deprecated
  1205.  */
  1206. shaka.ads.AdManager.AD_CLOSED = 'ad-closed';
  1209. /**
  1210.  * The event name for when the ad data becomes available.
  1211.  *
  1212.  * Deprecated, please use {@link shaka.ads.Utils}
  1213.  *
  1214.  * @const {string}
  1215.  * @export
  1216.  * @deprecated
  1217.  */
  1218. shaka.ads.AdManager.AD_LOADED = 'ad-loaded';
  1221. /**
  1222.  * The event name for when all the ads were completed.
  1223.  *
  1224.  * Deprecated, please use {@link shaka.ads.Utils}
  1225.  *
  1226.  * @const {string}
  1227.  * @export
  1228.  * @deprecated
  1229.  */
  1230. shaka.ads.AdManager.ALL_ADS_COMPLETED = 'all-ads-completed';
  1233. /**
  1234.  * The event name for when the ad changes from or to linear.
  1235.  *
  1236.  * Deprecated, please use {@link shaka.ads.Utils}
  1237.  *
  1238.  * @const {string}
  1239.  * @export
  1240.  * @deprecated
  1241.  */
  1242. shaka.ads.AdManager.AD_LINEAR_CHANGED = 'ad-linear-changed';
  1245. /**
  1246.  * The event name for when the ad's metadata becomes available.
  1247.  *
  1248.  * Deprecated, please use {@link shaka.ads.Utils}
  1249.  *
  1250.  * @const {string}
  1251.  * @export
  1252.  * @deprecated
  1253.  */
  1254. shaka.ads.AdManager.AD_METADATA = 'ad-metadata';
  1257. /**
  1258.  * The event name for when the ad display encountered a recoverable
  1259.  * error.
  1260.  *
  1261.  * Deprecated, please use {@link shaka.ads.Utils}
  1262.  *
  1263.  * @const {string}
  1264.  * @export
  1265.  * @deprecated
  1266.  */
  1267. shaka.ads.AdManager.AD_RECOVERABLE_ERROR = 'ad-recoverable-error';
  1269. /**
  1270.  * The event name for when the ad manager dispatch errors.
  1271.  *
  1272.  * Deprecated, please use {@link shaka.ads.Utils}
  1273.  *
  1274.  * @const {string}
  1275.  * @export
  1276.  * @deprecated
  1277.  */
  1278. shaka.ads.AdManager.AD_ERROR = 'ad-error';
  1280. /**
  1281.  * The event name for when the client side SDK signalled its readiness
  1282.  * to play a VPAID ad or an ad rule.
  1283.  *
  1284.  * Deprecated, please use {@link shaka.ads.Utils}
  1285.  *
  1286.  * @const {string}
  1287.  * @export
  1288.  * @deprecated
  1289.  */
  1290. shaka.ads.AdManager.AD_BREAK_READY = 'ad-break-ready';
  1293. /**
  1294.  * The event name for when the interaction callback for the ad was
  1295.  * triggered.
  1296.  *
  1297.  * Deprecated, please use {@link shaka.ads.Utils}
  1298.  *
  1299.  * @const {string}
  1300.  * @export
  1301.  * @deprecated
  1302.  */
  1303. shaka.ads.AdManager.AD_INTERACTION = 'ad-interaction';
  1306. /**
  1307.  * The name of the event for when an ad requires the main content to be paused.
  1308.  * Fired when the platform does not support multiple media elements.
  1309.  *
  1310.  * Deprecated, please use {@link shaka.ads.Utils}
  1311.  *
  1312.  * @const {string}
  1313.  * @export
  1314.  * @deprecated
  1315.  */
  1316. shaka.ads.AdManager.AD_CONTENT_PAUSE_REQUESTED = 'ad-content-pause-requested';
  1319. /**
  1320.  * The name of the event for when an ad requires the main content to be resumed.
  1321.  * Fired when the platform does not support multiple media elements.
  1322.  *
  1323.  * Deprecated, please use {@link shaka.ads.Utils}
  1324.  *
  1325.  * @const {string}
  1326.  * @export
  1327.  * @deprecated
  1328.  */
  1329. shaka.ads.AdManager.AD_CONTENT_RESUME_REQUESTED = 'ad-content-resume-requested';
  1332. /**
  1333.  * The name of the event for when an ad requires the video of the main content
  1334.  * to be attached.
  1335.  *
  1336.  * Deprecated, please use {@link shaka.ads.Utils}
  1337.  *
  1338.  * @const {string}
  1339.  * @export
  1340.  * @deprecated
  1341.  */
  1342. shaka.ads.AdManager.AD_CONTENT_ATTACH_REQUESTED = 'ad-content-attach-requested';
  1345. /**
  1346.  * Set this is a default ad manager for the player.
  1347.  * Apps can also set their own ad manager, if they'd like.
  1348.  */
  1349. shaka.Player.setAdManagerFactory(() => new shaka.ads.AdManager());