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.   constructor() {
  418.     super();
  419.     /** @private {shaka.ads.InterstitialAdManager} */
  420.     this.interstitialAdManager_ = null;
  421.     /** @private {shaka.ads.ClientSideAdManager} */
  422.     this.csAdManager_ = null;
  423.     /** @private {shaka.ads.MediaTailorAdManager} */
  424.     this.mtAdManager_ = null;
  425.     /** @private {shaka.ads.ServerSideAdManager} */
  426.     this.ssAdManager_ = null;
  427.     /** @private {shaka.ads.AdsStats} */
  428.     this.stats_ = new shaka.ads.AdsStats();
  429.     /** @private {string} locale */
  430.     this.locale_ = navigator.language;
  431.     /** @private {?shaka.extern.AdsConfiguration} */
  432.     this.config_ = null;
  433.   }
  436.   /**
  437.    * @override
  438.    * @export
  439.    */
  440.   setLocale(locale) {
  441.     this.locale_ = locale;
  442.   }
  445.   /**
  446.    * @override
  447.    * @export
  448.    */
  449.   configure(config) {
  450.     this.config_ = config;
  451.     if (this.interstitialAdManager_) {
  452.       this.interstitialAdManager_.configure(this.config_);
  453.     }
  454.     if (this.csAdManager_) {
  455.       this.csAdManager_.configure(this.config_);
  456.     }
  457.     if (this.ssAdManager_) {
  458.       this.ssAdManager_.configure(this.config_);
  459.     }
  460.   }
  463.   /**
  464.    * @override
  465.    * @export
  466.    */
  467.   initInterstitial(adContainer, basePlayer, baseVideo) {
  468.     if (!adContainer) {
  469.       shaka.log.info('Initializing interstitials without ad container');
  470.     }
  471.     if (this.interstitialAdManager_) {
  472.       this.interstitialAdManager_.release();
  473.     }
  474.     this.interstitialAdManager_ = new shaka.ads.InterstitialAdManager(
  475.         adContainer, basePlayer, baseVideo,
  476.         (e) => this.processAndDispatchEvent_(e));
  478.     goog.asserts.assert(this.config_, 'Config must not be null!');
  479.     this.interstitialAdManager_.configure(this.config_);
  480.   }
  483.   /**
  484.    * @override
  485.    * @export
  486.    */
  487.   initClientSide(adContainer, video, adsRenderingSettings) {
  488.     // Check that Client Side IMA SDK has been included
  489.     // NOTE: (window['google'] && google.ima) check for any
  490.     // IMA SDK, including SDK for Server Side ads.
  491.     // The 3rd check insures we have the right SDK:
  492.     // {google.ima.AdsLoader} is an object that's part of CS IMA SDK
  493.     // but not SS SDK.
  494.     if (!window['google'] || !google.ima || !google.ima.AdsLoader) {
  495.       throw new shaka.util.Error(
  496.           shaka.util.Error.Severity.CRITICAL,
  497.           shaka.util.Error.Category.ADS,
  498.           shaka.util.Error.Code.CS_IMA_SDK_MISSING);
  499.     }
  501.     if (this.csAdManager_) {
  502.       this.csAdManager_.release();
  503.     }
  505.     this.csAdManager_ = new shaka.ads.ClientSideAdManager(
  506.         adContainer, video, this.locale_, adsRenderingSettings,
  507.         (e) => this.processAndDispatchEvent_(e));
  509.     goog.asserts.assert(this.config_, 'Config must not be null!');
  510.     this.csAdManager_.configure(this.config_);
  511.   }
  514.   /**
  515.    * @override
  516.    * @export
  517.    */
  518.   release() {
  519.     if (this.interstitialAdManager_) {
  520.       this.interstitialAdManager_.release();
  521.       this.interstitialAdManager_ = null;
  522.     }
  523.     if (this.csAdManager_) {
  524.       this.csAdManager_.release();
  525.       this.csAdManager_ = null;
  526.     }
  527.     if (this.mtAdManager_) {
  528.       this.mtAdManager_.release();
  529.       this.mtAdManager_ = null;
  530.     }
  531.     if (this.ssAdManager_) {
  532.       this.ssAdManager_.release();
  533.       this.ssAdManager_ = null;
  534.     }
  535.     super.release();
  536.   }
  539.   /**
  540.    * @override
  541.    * @export
  542.    */
  543.   onAssetUnload() {
  544.     if (this.interstitialAdManager_) {
  545.       this.interstitialAdManager_.stop();
  546.     }
  547.     if (this.csAdManager_) {
  548.       this.csAdManager_.stop();
  549.     }
  550.     if (this.mtAdManager_) {
  551.       this.mtAdManager_.stop();
  552.     }
  553.     if (this.ssAdManager_) {
  554.       this.ssAdManager_.stop();
  555.     }
  557.     this.dispatchEvent(
  558.         new shaka.util.FakeEvent(shaka.ads.Utils.AD_STOPPED));
  559.     this.dispatchEvent(new shaka.util.FakeEvent(
  560.         shaka.ads.Utils.AD_CONTENT_ATTACH_REQUESTED));
  562.     this.stats_ = new shaka.ads.AdsStats();
  563.   }
  566.   /**
  567.    * @override
  568.    * @export
  569.    */
  570.   requestClientSideAds(imaRequest) {
  571.     if (!this.csAdManager_) {
  572.       throw new shaka.util.Error(
  573.           shaka.util.Error.Severity.RECOVERABLE,
  574.           shaka.util.Error.Category.ADS,
  575.           shaka.util.Error.Code.CS_AD_MANAGER_NOT_INITIALIZED);
  576.     }
  578.     this.csAdManager_.requestAds(imaRequest);
  579.   }
  582.   /**
  583.    * @override
  584.    * @export
  585.    */
  586.   updateClientSideAdsRenderingSettings(adsRenderingSettings) {
  587.     if (!this.csAdManager_) {
  588.       throw new shaka.util.Error(
  589.           shaka.util.Error.Severity.RECOVERABLE,
  590.           shaka.util.Error.Category.ADS,
  591.           shaka.util.Error.Code.CS_AD_MANAGER_NOT_INITIALIZED);
  592.     }
  594.     this.csAdManager_.updateAdsRenderingSettings(adsRenderingSettings);
  595.   }
  598.   /**
  599.    * @override
  600.    * @export
  601.    */
  602.   initMediaTailor(adContainer, networkingEngine, video) {
  603.     if (this.mtAdManager_) {
  604.       this.mtAdManager_.release();
  605.     }
  607.     this.mtAdManager_ = new shaka.ads.MediaTailorAdManager(
  608.         adContainer, networkingEngine, video,
  609.         (e) => this.processAndDispatchEvent_(e));
  610.   }
  613.   /**
  614.    * @param {string} url
  615.    * @param {Object} adsParams
  616.    * @param {string=} backupUrl
  617.    * @return {!Promise<string>}
  618.    * @override
  619.    * @export
  620.    */
  621.   requestMediaTailorStream(url, adsParams, backupUrl = '') {
  622.     if (!this.mtAdManager_) {
  623.       throw new shaka.util.Error(
  624.           shaka.util.Error.Severity.RECOVERABLE,
  625.           shaka.util.Error.Category.ADS,
  626.           shaka.util.Error.Code.MT_AD_MANAGER_NOT_INITIALIZED);
  627.     }
  629.     return this.mtAdManager_.streamRequest(url, adsParams, backupUrl);
  630.   }
  633.   /**
  634.    * @param {string} url
  635.    * @override
  636.    * @export
  637.    */
  638.   addMediaTailorTrackingUrl(url) {
  639.     if (!this.mtAdManager_) {
  640.       throw new shaka.util.Error(
  641.           shaka.util.Error.Severity.RECOVERABLE,
  642.           shaka.util.Error.Category.ADS,
  643.           shaka.util.Error.Code.MT_AD_MANAGER_NOT_INITIALIZED);
  644.     }
  646.     this.mtAdManager_.addTrackingUrl(url);
  647.   }
  650.   /**
  651.    * @override
  652.    * @export
  653.    */
  654.   initServerSide(adContainer, video) {
  655.     // Check that Client Side IMA SDK has been included
  656.     // NOTE: (window['google'] && google.ima) check for any
  657.     // IMA SDK, including SDK for Server Side ads.
  658.     // The 3rd check insures we have the right SDK:
  659.     // {google.ima.dai} is an object that's part of DAI IMA SDK
  660.     // but not SS SDK.
  661.     if (!window['google'] || !google.ima || !google.ima.dai) {
  662.       throw new shaka.util.Error(
  663.           shaka.util.Error.Severity.CRITICAL,
  664.           shaka.util.Error.Category.ADS,
  665.           shaka.util.Error.Code.SS_IMA_SDK_MISSING);
  666.     }
  668.     if (this.ssAdManager_) {
  669.       this.ssAdManager_.release();
  670.     }
  672.     this.ssAdManager_ = new shaka.ads.ServerSideAdManager(
  673.         adContainer, video, this.locale_,
  674.         (e) => this.processAndDispatchEvent_(e));
  676.     goog.asserts.assert(this.config_, 'Config must not be null!');
  677.     this.ssAdManager_.configure(this.config_);
  678.   }
  681.   /**
  682.    * @param {!google.ima.dai.api.StreamRequest} imaRequest
  683.    * @param {string=} backupUrl
  684.    * @return {!Promise<string>}
  685.    * @override
  686.    * @export
  687.    */
  688.   requestServerSideStream(imaRequest, backupUrl = '') {
  689.     if (!this.ssAdManager_) {
  690.       throw new shaka.util.Error(
  691.           shaka.util.Error.Severity.RECOVERABLE,
  692.           shaka.util.Error.Category.ADS,
  693.           shaka.util.Error.Code.SS_AD_MANAGER_NOT_INITIALIZED);
  694.     }
  696.     if (!imaRequest.adTagParameters) {
  697.       imaRequest.adTagParameters = {};
  698.     }
  699.     const adTagParams = imaRequest.adTagParameters;
  701.     if (adTagParams['mpt'] || adTagParams['mpv']) {
  702.       shaka.log.alwaysWarn('You have attempted to set "mpt" and/or "mpv" ' +
  703.         'parameters of the ad tag. Please note that those parameters are ' +
  704.         'used for Shaka adoption tracking and will be overridden.');
  705.     }
  707.     // Set player and version parameters for tracking
  708.     imaRequest.adTagParameters['mpt'] = 'shaka-player';
  709.     imaRequest.adTagParameters['mpv'] = shaka.Player.version;
  710.     return this.ssAdManager_.streamRequest(imaRequest, backupUrl);
  711.   }
  714.   /**
  715.    * @override
  716.    * @export
  717.    */
  718.   replaceServerSideAdTagParameters(adTagParameters) {
  719.     if (!this.ssAdManager_) {
  720.       throw new shaka.util.Error(
  721.           shaka.util.Error.Severity.RECOVERABLE,
  722.           shaka.util.Error.Category.ADS,
  723.           shaka.util.Error.Code.SS_AD_MANAGER_NOT_INITIALIZED);
  724.     }
  726.     if (adTagParameters['mpt'] || adTagParameters['mpv']) {
  727.       shaka.log.alwaysWarn('You have attempted to set "mpt" and/or "mpv" ' +
  728.         'parameters of the ad tag. Please note that those parameters are ' +
  729.         'used for Shaka adoption tracking and will be overridden.');
  730.     }
  732.     adTagParameters['mpt'] = 'Shaka Player';
  733.     adTagParameters['mpv'] = shaka.Player.version;
  735.     this.ssAdManager_.replaceAdTagParameters(adTagParameters);
  736.   }
  739.   /**
  740.    * @return {!Array<!shaka.extern.AdCuePoint>}
  741.    * @override
  742.    * @export
  743.    */
  744.   getServerSideCuePoints() {
  745.     shaka.Deprecate.deprecateFeature(5,
  746.         'AdManager.getServerSideCuePoints',
  747.         'Please use getCuePoints function.');
  748.     return this.getCuePoints();
  749.   }
  752.   /**
  753.    * @return {!Array<!shaka.extern.AdCuePoint>}
  754.    * @override
  755.    * @export
  756.    */
  757.   getCuePoints() {
  758.     let cuepoints = [];
  759.     if (this.ssAdManager_) {
  760.       cuepoints = cuepoints.concat(this.ssAdManager_.getCuePoints());
  761.     }
  762.     if (this.mtAdManager_) {
  763.       cuepoints = cuepoints.concat(this.mtAdManager_.getCuePoints());
  764.     }
  765.     return cuepoints;
  766.   }
  769.   /**
  770.    * @return {shaka.extern.AdsStats}
  771.    * @override
  772.    * @export
  773.    */
  774.   getStats() {
  775.     return this.stats_.getBlob();
  776.   }
  778.   /**
  779.    * @override
  780.    * @export
  781.    */
  782.   onManifestUpdated(isLive) {
  783.     if (this.mtAdManager_) {
  784.       this.mtAdManager_.onManifestUpdated(isLive);
  785.     }
  786.   }
  788.   /**
  789.    * @override
  790.    * @export
  791.    */
  792.   onDashTimedMetadata(region) {
  793.     if (this.ssAdManager_ && region.schemeIdUri == 'urn:google:dai:2018') {
  794.       const type = region.schemeIdUri;
  795.       const data = region.eventNode ?
  796.           region.eventNode.attributes['messageData'] : null;
  797.       const timestamp = region.startTime;
  798.       this.ssAdManager_.onTimedMetadata(type, data, timestamp);
  799.     }
  800.   }
  802.   /**
  803.    * @override
  804.    * @export
  805.    */
  806.   onHlsTimedMetadata(metadata, timestamp) {
  807.     if (this.ssAdManager_) {
  808.       this.ssAdManager_.onTimedMetadata('ID3', metadata['data'], timestamp);
  809.     }
  810.   }
  812.   /**
  813.    * @override
  814.    * @export
  815.    */
  816.   onCueMetadataChange(value) {
  817.     if (this.ssAdManager_) {
  818.       this.ssAdManager_.onCueMetadataChange(value);
  819.     }
  820.   }
  822.   /**
  823.    * @override
  824.    * @export
  825.    */
  826.   onHLSInterstitialMetadata(basePlayer, baseVideo, interstitial) {
  827.     if (this.config_ && this.config_.disableHLSInterstitial) {
  828.       return;
  829.     }
  830.     if (!this.interstitialAdManager_) {
  831.       this.initInterstitial(/* adContainer= */ null, basePlayer, baseVideo);
  832.     }
  833.     if (this.interstitialAdManager_) {
  834.       this.interstitialAdManager_.addMetadata(interstitial);
  835.     }
  836.   }
  838.   /**
  839.    * @override
  840.    * @export
  841.    */
  842.   onDASHInterstitialMetadata(basePlayer, baseVideo, region) {
  843.     if (this.config_ && this.config_.disableDASHInterstitial) {
  844.       return;
  845.     }
  846.     const schemeIdUri = region.schemeIdUri;
  847.     if (schemeIdUri == 'urn:mpeg:dash:event:alternativeMPD:insert:2025' ||
  848.         schemeIdUri == 'urn:mpeg:dash:event:alternativeMPD:replace:2025') {
  849.       if (!this.interstitialAdManager_) {
  850.         this.initInterstitial(/* adContainer= */ null, basePlayer, baseVideo);
  851.       }
  852.       if (this.interstitialAdManager_) {
  853.         this.interstitialAdManager_.addRegion(region);
  854.       }
  855.     } else if ((schemeIdUri == 'urn:mpeg:dash:event:2012' ||
  856.         schemeIdUri == 'urn:scte:dash:scte214-events') &&
  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.           const ad = (/** @type {!Object} */ (event))['ad'];
  925.           if (ad && !ad.isLinear()) {
  926.             this.stats_.incrementOverlayAds();
  927.           }
  928.           break;
  929.         }
  930.         case shaka.ads.Utils.AD_COMPLETE:
  931.           this.stats_.incrementPlayedCompletely();
  932.           break;
  933.         case shaka.ads.Utils.AD_SKIPPED:
  934.           this.stats_.incrementSkipped();
  935.           break;
  936.         case shaka.ads.Utils.AD_ERROR:
  937.           this.stats_.incrementErrors();
  938.           break;
  939.       }
  940.     }
  941.     this.dispatchEvent(event);
  942.   }
  943. };
  945. /**
  946.  * The event name for when a sequence of ads has been loaded.
  947.  *
  948.  * Deprecated, please use {@link shaka.ads.Utils}
  949.  *
  950.  * @const {string}
  951.  * @export
  952.  * @deprecated
  953.  */
  954. shaka.ads.AdManager.ADS_LOADED = 'ads-loaded';
  956. /**
  957.  * The event name for when an ad has started playing.
  958.  *
  959.  * Deprecated, please use {@link shaka.ads.Utils}
  960.  *
  961.  * @const {string}
  962.  * @export
  963.  * @deprecated
  964.  */
  965. shaka.ads.AdManager.AD_STARTED = 'ad-started';
  968. /**
  969.  * The event name for when an ad playhead crosses first quartile.
  970.  *
  971.  * Deprecated, please use {@link shaka.ads.Utils}
  972.  *
  973.  * @const {string}
  974.  * @export
  975.  * @deprecated
  976.  */
  977. shaka.ads.AdManager.AD_FIRST_QUARTILE = 'ad-first-quartile';
  980. /**
  981.  * The event name for when an ad playhead crosses midpoint.
  982.  *
  983.  * Deprecated, please use {@link shaka.ads.Utils}
  984.  *
  985.  * @const {string}
  986.  * @export
  987.  * @deprecated
  988.  */
  989. shaka.ads.AdManager.AD_MIDPOINT = 'ad-midpoint';
  992. /**
  993.  * The event name for when an ad playhead crosses third quartile.
  994.  *
  995.  * Deprecated, please use {@link shaka.ads.Utils}
  996.  *
  997.  * @const {string}
  998.  * @export
  999.  * @deprecated
  1000.  */
  1001. shaka.ads.AdManager.AD_THIRD_QUARTILE = 'ad-third-quartile';
  1004. /**
  1005.  * The event name for when an ad has completed playing.
  1006.  *
  1007.  * Deprecated, please use {@link shaka.ads.Utils}
  1008.  *
  1009.  * @const {string}
  1010.  * @export
  1011.  * @deprecated
  1012.  */
  1013. shaka.ads.AdManager.AD_COMPLETE = 'ad-complete';
  1016. /**
  1017.  * The event name for when an ad has finished playing
  1018.  * (played all the way through, was skipped, or was unable to proceed
  1019.  * due to an error).
  1020.  *
  1021.  * Deprecated, please use {@link shaka.ads.Utils}
  1022.  *
  1023.  * @const {string}
  1024.  * @export
  1025.  * @deprecated
  1026.  */
  1027. shaka.ads.AdManager.AD_STOPPED = 'ad-stopped';
  1030. /**
  1031.  * The event name for when an ad is skipped by the user.
  1032.  *
  1033.  * Deprecated, please use {@link shaka.ads.Utils}
  1034.  *
  1035.  * @const {string}
  1036.  * @export
  1037.  * @deprecated
  1038.  */
  1039. shaka.ads.AdManager.AD_SKIPPED = 'ad-skipped';
  1042. /**
  1043.  * The event name for when the ad volume has changed.
  1044.  *
  1045.  * Deprecated, please use {@link shaka.ads.Utils}
  1046.  *
  1047.  * @const {string}
  1048.  * @export
  1049.  * @deprecated
  1050.  */
  1051. shaka.ads.AdManager.AD_VOLUME_CHANGED = 'ad-volume-changed';
  1054. /**
  1055.  * The event name for when the ad was muted.
  1056.  *
  1057.  * Deprecated, please use {@link shaka.ads.Utils}
  1058.  *
  1059.  * @const {string}
  1060.  * @export
  1061.  * @deprecated
  1062.  */
  1063. shaka.ads.AdManager.AD_MUTED = 'ad-muted';
  1066. /**
  1067.  * The event name for when the ad was paused.
  1068.  *
  1069.  * Deprecated, please use {@link shaka.ads.Utils}
  1070.  *
  1071.  * @const {string}
  1072.  * @export
  1073.  * @deprecated
  1074.  */
  1075. shaka.ads.AdManager.AD_PAUSED = 'ad-paused';
  1078. /**
  1079.  * The event name for when the ad was resumed after a pause.
  1080.  *
  1081.  * Deprecated, please use {@link shaka.ads.Utils}
  1082.  *
  1083.  * @const {string}
  1084.  * @export
  1085.  * @deprecated
  1086.  */
  1087. shaka.ads.AdManager.AD_RESUMED = 'ad-resumed';
  1090. /**
  1091.  * The event name for when the ad's skip status changes
  1092.  * (usually it becomes skippable when it wasn't before).
  1093.  *
  1094.  * Deprecated, please use {@link shaka.ads.Utils}
  1095.  *
  1096.  * @const {string}
  1097.  * @export
  1098.  * @deprecated
  1099.  */
  1100. shaka.ads.AdManager.AD_SKIP_STATE_CHANGED = 'ad-skip-state-changed';
  1103. /**
  1104.  * The event name for when the ad's cue points (start/end markers)
  1105.  * have changed.
  1106.  *
  1107.  * Deprecated, please use {@link shaka.ads.Utils}
  1108.  *
  1109.  * @const {string}
  1110.  * @export
  1111.  * @deprecated
  1112.  */
  1113. shaka.ads.AdManager.CUEPOINTS_CHANGED = 'ad-cue-points-changed';
  1116. /**
  1117.  * The event name for when the native IMA ad manager object has
  1118.  * loaded and become available.
  1119.  *
  1120.  * Deprecated, please use {@link shaka.ads.Utils}
  1121.  *
  1122.  * @const {string}
  1123.  * @export
  1124.  * @deprecated
  1125.  */
  1126. shaka.ads.AdManager.IMA_AD_MANAGER_LOADED = 'ima-ad-manager-loaded';
  1129. /**
  1130.  * The event name for when the native IMA stream manager object has
  1131.  * loaded and become available.
  1132.  *
  1133.  * Deprecated, please use {@link shaka.ads.Utils}
  1134.  *
  1135.  * @const {string}
  1136.  * @export
  1137.  * @deprecated
  1138.  */
  1139. shaka.ads.AdManager.IMA_STREAM_MANAGER_LOADED = 'ima-stream-manager-loaded';
  1142. /**
  1143.  * The event name for when the ad was clicked.
  1144.  *
  1145.  * Deprecated, please use {@link shaka.ads.Utils}
  1146.  *
  1147.  * @const {string}
  1148.  * @export
  1149.  * @deprecated
  1150.  */
  1151. shaka.ads.AdManager.AD_CLICKED = 'ad-clicked';
  1154. /**
  1155.  * The event name for when there is an update to the current ad's progress.
  1156.  *
  1157.  * Deprecated, please use {@link shaka.ads.Utils}
  1158.  *
  1159.  * @const {string}
  1160.  * @export
  1161.  * @deprecated
  1162.  */
  1163. shaka.ads.AdManager.AD_PROGRESS = 'ad-progress';
  1166. /**
  1167.  * The event name for when the ad is buffering.
  1168.  *
  1169.  * Deprecated, please use {@link shaka.ads.Utils}
  1170.  *
  1171.  * @const {string}
  1172.  * @export
  1173.  * @deprecated
  1174.  */
  1175. shaka.ads.AdManager.AD_BUFFERING = 'ad-buffering';
  1178. /**
  1179.  * The event name for when the ad's URL was hit.
  1180.  *
  1181.  * Deprecated, please use {@link shaka.ads.Utils}
  1182.  *
  1183.  * @const {string}
  1184.  * @export
  1185.  * @deprecated
  1186.  */
  1187. shaka.ads.AdManager.AD_IMPRESSION = 'ad-impression';
  1190. /**
  1191.  * The event name for when the ad's duration changed.
  1192.  *
  1193.  * Deprecated, please use {@link shaka.ads.Utils}
  1194.  *
  1195.  * @const {string}
  1196.  * @export
  1197.  * @deprecated
  1198.  */
  1199. shaka.ads.AdManager.AD_DURATION_CHANGED = 'ad-duration-changed';
  1202. /**
  1203.  * The event name for when the ad was closed by the user.
  1204.  *
  1205.  * Deprecated, please use {@link shaka.ads.Utils}
  1206.  *
  1207.  * @const {string}
  1208.  * @export
  1209.  * @deprecated
  1210.  */
  1211. shaka.ads.AdManager.AD_CLOSED = 'ad-closed';
  1214. /**
  1215.  * The event name for when the ad data becomes available.
  1216.  *
  1217.  * Deprecated, please use {@link shaka.ads.Utils}
  1218.  *
  1219.  * @const {string}
  1220.  * @export
  1221.  * @deprecated
  1222.  */
  1223. shaka.ads.AdManager.AD_LOADED = 'ad-loaded';
  1226. /**
  1227.  * The event name for when all the ads were completed.
  1228.  *
  1229.  * Deprecated, please use {@link shaka.ads.Utils}
  1230.  *
  1231.  * @const {string}
  1232.  * @export
  1233.  * @deprecated
  1234.  */
  1235. shaka.ads.AdManager.ALL_ADS_COMPLETED = 'all-ads-completed';
  1238. /**
  1239.  * The event name for when the ad changes from or to linear.
  1240.  *
  1241.  * Deprecated, please use {@link shaka.ads.Utils}
  1242.  *
  1243.  * @const {string}
  1244.  * @export
  1245.  * @deprecated
  1246.  */
  1247. shaka.ads.AdManager.AD_LINEAR_CHANGED = 'ad-linear-changed';
  1250. /**
  1251.  * The event name for when the ad's metadata becomes available.
  1252.  *
  1253.  * Deprecated, please use {@link shaka.ads.Utils}
  1254.  *
  1255.  * @const {string}
  1256.  * @export
  1257.  * @deprecated
  1258.  */
  1259. shaka.ads.AdManager.AD_METADATA = 'ad-metadata';
  1262. /**
  1263.  * The event name for when the ad display encountered a recoverable
  1264.  * error.
  1265.  *
  1266.  * Deprecated, please use {@link shaka.ads.Utils}
  1267.  *
  1268.  * @const {string}
  1269.  * @export
  1270.  * @deprecated
  1271.  */
  1272. shaka.ads.AdManager.AD_RECOVERABLE_ERROR = 'ad-recoverable-error';
  1274. /**
  1275.  * The event name for when the ad manager dispatch errors.
  1276.  *
  1277.  * Deprecated, please use {@link shaka.ads.Utils}
  1278.  *
  1279.  * @const {string}
  1280.  * @export
  1281.  * @deprecated
  1282.  */
  1283. shaka.ads.AdManager.AD_ERROR = 'ad-error';
  1285. /**
  1286.  * The event name for when the client side SDK signalled its readiness
  1287.  * to play a VPAID ad or an ad rule.
  1288.  *
  1289.  * Deprecated, please use {@link shaka.ads.Utils}
  1290.  *
  1291.  * @const {string}
  1292.  * @export
  1293.  * @deprecated
  1294.  */
  1295. shaka.ads.AdManager.AD_BREAK_READY = 'ad-break-ready';
  1298. /**
  1299.  * The event name for when the interaction callback for the ad was
  1300.  * triggered.
  1301.  *
  1302.  * Deprecated, please use {@link shaka.ads.Utils}
  1303.  *
  1304.  * @const {string}
  1305.  * @export
  1306.  * @deprecated
  1307.  */
  1308. shaka.ads.AdManager.AD_INTERACTION = 'ad-interaction';
  1311. /**
  1312.  * The name of the event for when an ad requires the main content to be paused.
  1313.  * Fired when the platform does not support multiple media elements.
  1314.  *
  1315.  * Deprecated, please use {@link shaka.ads.Utils}
  1316.  *
  1317.  * @const {string}
  1318.  * @export
  1319.  * @deprecated
  1320.  */
  1321. shaka.ads.AdManager.AD_CONTENT_PAUSE_REQUESTED = 'ad-content-pause-requested';
  1324. /**
  1325.  * The name of the event for when an ad requires the main content to be resumed.
  1326.  * Fired when the platform does not support multiple media elements.
  1327.  *
  1328.  * Deprecated, please use {@link shaka.ads.Utils}
  1329.  *
  1330.  * @const {string}
  1331.  * @export
  1332.  * @deprecated
  1333.  */
  1334. shaka.ads.AdManager.AD_CONTENT_RESUME_REQUESTED = 'ad-content-resume-requested';
  1337. /**
  1338.  * The name of the event for when an ad requires the video of the main content
  1339.  * to be attached.
  1340.  *
  1341.  * Deprecated, please use {@link shaka.ads.Utils}
  1342.  *
  1343.  * @const {string}
  1344.  * @export
  1345.  * @deprecated
  1346.  */
  1347. shaka.ads.AdManager.AD_CONTENT_ATTACH_REQUESTED = 'ad-content-attach-requested';
  1350. /**
  1351.  * Set this is a default ad manager for the player.
  1352.  * Apps can also set their own ad manager, if they'd like.
  1353.  */
  1354. shaka.Player.setAdManagerFactory(() => new shaka.ads.AdManager());