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');
  26. /**
  27.  * @event shaka.ads.AdManager.AdsLoadedEvent
  28.  * @description Fired when a sequence of ads has been loaded.
  29.  * @property {string} type
  30.  *   'ads-loaded'
  31.  * @property {number} loadTime
  32.  *    The time it takes to load ads.
  33.  * @exportDoc
  34.  */
  36. /**
  37.  * @event shaka.ads.AdManager.AdStartedEvent
  38.  * @description Fired when an ad has started playing.
  39.  * @property {string} type
  40.  *   'ad-started'
  41.  * @property {!shaka.extern.IAd} ad
  42.  *    The ad that has started playing.
  43.  * @property {Object} sdkAdObject
  44.  *    The ad object in the SDK format, if there is one.
  45.  * @property {Object} originalEvent
  46.  *    The native SDK event, if available.
  47.  * @exportDoc
  48.  */
  51. /**
  52.  * @event shaka.ads.AdManager.AdCompleteEvent
  53.  * @description Fired when an ad has played through.
  54.  * @property {string} type
  55.  *   'ad-complete'
  56.  * @property {Object} originalEvent
  57.  *    The native SDK event, if available.
  58.  * @exportDoc
  59.  */
  62. /**
  63.  * @event shaka.ads.AdManager.AdSkippedEvent
  64.  * @description Fired when an ad has been skipped.
  65.  * @property {string} type
  66.  *   'ad-skipped'
  67.  * @property {Object} originalEvent
  68.  *    The native SDK event, if available.
  69.  * @exportDoc
  70.  */
  73. /**
  74.  * @event shaka.ads.AdManager.AdFirstQuartileEvent
  75.  * @description Fired when an ad has played through the first 1/4.
  76.  * @property {string} type
  77.  *   'ad-first-quartile'
  78.  * @property {Object} originalEvent
  79.  *    The native SDK event, if available.
  80.  * @exportDoc
  81.  */
  84. /**
  85.  * @event shaka.ads.AdManager.AdMidpointEvent
  86.  * @description Fired when an ad has played through its midpoint.
  87.  * @property {string} type
  88.  *   'ad-midpoint'
  89.  * @property {Object} originalEvent
  90.  *    The native SDK event, if available.
  91.  * @exportDoc
  92.  */
  95. /**
  96.  * @event shaka.ads.AdManager.AdThirdQuartileEvent
  97.  * @description Fired when an ad has played through the third quartile.
  98.  * @property {string} type
  99.  *   'ad-third-quartile'
  100.  * @property {Object} originalEvent
  101.  *    The native SDK event, if available.
  102.  * @exportDoc
  103.  */
  106. /**
  107.  * @event shaka.ads.AdManager.AdStoppedEvent
  108.  * @description Fired when an ad has stopped playing, was skipped,
  109.  *   or was unable to proceed due to an error.
  110.  * @property {string} type
  111.  *   'ad-stopped'
  112.  * @property {Object} originalEvent
  113.  *    The native SDK event, if available.
  114.  * @exportDoc
  115.  */
  118. /**
  119.  * @event shaka.ads.AdManager.AdVolumeChangedEvent
  120.  * @description Fired when an ad's volume changed.
  121.  * @property {string} type
  122.  *   'ad-volume-changed'
  123.  * @property {Object} originalEvent
  124.  *    The native SDK event, if available.
  125.  * @exportDoc
  126.  */
  129. /**
  130.  * @event shaka.ads.AdManager.AdMutedEvent
  131.  * @description Fired when an ad was muted.
  132.  * @property {string} type
  133.  *   'ad-muted'
  134.  * @property {Object} originalEvent
  135.  *    The native SDK event, if available.
  136.  * @exportDoc
  137.  */
  140. /**
  141.  * @event shaka.ads.AdManager.AdPausedEvent
  142.  * @description Fired when an ad was paused.
  143.  * @property {string} type
  144.  *   'ad-paused'
  145.  * @property {Object} originalEvent
  146.  *    The native SDK event, if available.
  147.  * @exportDoc
  148.  */
  151. /**
  152.  * @event shaka.ads.AdManager.AdResumedEvent
  153.  * @description Fired when an ad was resumed after a pause.
  154.  * @property {string} type
  155.  *   'ad-resumed'
  156.  * @property {Object} originalEvent
  157.  *    The native SDK event, if available.
  158.  * @exportDoc
  159.  */
  162. /**
  163.  * @event shaka.ads.AdManager.AdSkipStateChangedEvent
  164.  * @description Fired when an ad's skip state changes (for example, when
  165.  *  it becomes possible to skip the ad).
  166.  * @property {string} type
  167.  *   'ad-skip-state-changed'
  168.  * @property {Object} originalEvent
  169.  *    The native SDK event, if available.
  170.  * @exportDoc
  171.  */
  174. /**
  175.  * @event shaka.ads.AdManager.AdCuePointsChangedEvent
  176.  * @description Fired when the ad cue points change, signalling ad breaks
  177.  *  change.
  178.  * @property {string} type
  179.  *   'ad-cue-points-changed'
  180.  * @property {!Array.<!shaka.extern.AdCuePoint>} cuepoints
  181.  *    The ad cue points, if available.
  182.  * @exportDoc
  183.  */
  186. /**
  187.  * @event shaka.ads.AdManager.AdProgressEvent
  188.  * @description Fired when there is an update to the current ad's progress.
  189.  * @property {string} type
  190.  *   'ad-progress'
  191.  * @property {Object} originalEvent
  192.  *    The native SDK event, if available.
  193.  * @exportDoc
  194.  */
  197. /**
  198.  * @event shaka.ads.AdManager.AdBufferingEvent
  199.  * @description Fired when the ad has stalled playback to buffer.
  200.  * @property {string} type
  201.  *   'ad-buffering'
  202.  * @property {Object} originalEvent
  203.  *    The native SDK event, if available.
  204.  * @exportDoc
  205.  */
  208. /**
  209.  * @event shaka.ads.AdManager.AdImpressionEvent
  210.  * @description Fired when the impression URL has been pinged.
  211.  * @property {string} type
  212.  *   'ad-impression'
  213.  * @property {Object} originalEvent
  214.  *    The native SDK event, if available.
  215.  * @exportDoc
  216.  */
  219. /**
  220.  * @event shaka.ads.AdManager.AdClickEvent
  221.  * @description Fired when the ad was clicked.
  222.  * @property {string} type
  223.  *   'ad-clicked'
  224.  * @property {Object} originalEvent
  225.  *    The native SDK event, if available.
  226.  * @exportDoc
  227.  */
  230. /**
  231.  * @event shaka.ads.AdManager.AdDurationChangedEvent
  232.  * @description Fired when the ad's duration changes.
  233.  * @property {string} type
  234.  *   'ad-duration-changed'
  235.  * @property {Object} originalEvent
  236.  *    The native SDK event, if available.
  237.  * @exportDoc
  238.  */
  241. /**
  242.  * @event shaka.ads.AdManager.AdClosedEvent
  243.  * @description Fired when the ad was closed by the user.
  244.  * @property {string} type
  245.  *   'ad-closed'
  246.  * @property {Object} originalEvent
  247.  *    The native SDK event, if available.
  248.  * @exportDoc
  249.  */
  252. /**
  253.  * @event shaka.ads.AdManager.AdLoadedEvent
  254.  * @description Fired when the ad data becomes available.
  255.  * @property {string} type
  256.  *   'ad-loaded'
  257.  * @property {Object} originalEvent
  258.  *    The native SDK event, if available.
  259.  * @exportDoc
  260.  */
  263. /**
  264.  * @event shaka.ads.AdManager.AllAdsCompletedEvent
  265.  * @description Fired when the ads manager is done playing all the ads.
  266.  * @property {string} type
  267.  *   'all-ads-completed'
  268.  * @property {Object} originalEvent
  269.  *    The native SDK event, if available.
  270.  * @exportDoc
  271.  */
  274. /**
  275.  * @event shaka.ads.AdManager.AdLinearChangedEvent
  276.  * @description Fired when the displayed ad changes from
  277.  *   linear to nonlinear, or vice versa.
  278.  * @property {string} type
  279.  *   'ad-linear-changed'
  280.  * @property {Object} originalEvent
  281.  *    The native SDK event, if available.
  282.  * @exportDoc
  283.  */
  286. /**
  287.  * @event shaka.ads.AdManager.AdMetadataEvent
  288.  * @description Fired when the ad's metadata becomes available.
  289.  * @property {string} type
  290.  *   'ad-metadata'
  291.  * @property {Object} originalEvent
  292.  *    The native SDK event, if available.
  293.  * @exportDoc
  294.  */
  297. /**
  298.  * @event shaka.ads.AdManager#AdBreakReadyEvent
  299.  * @description Fired when the client-side SDK is ready to play a
  300.  *   VPAID ad or an ad rule.
  301.  * @property {string} type
  302.  *   'ad-break-ready'
  303.  * @property {Object} originalEvent
  304.  *    The native SDK event, if available.
  305.  * @exportDoc
  306.  */
  309. /**
  310.  * @event shaka.ads.AdManager.AdRecoverableErrorEvent
  311.  * @description Fired when the a non-fatal error was encountered.
  312.  *   The presentation will continue with the same or next ad playback
  313.  *   depending on the error situation.
  314.  * @property {string} type
  315.  *   'ad-recoverable-error'
  316.  * @property {Object} originalEvent
  317.  *    The native SDK event, if available.
  318.  * @exportDoc
  319.  */
  322. /**
  323.  * @event shaka.ads.Utils.AD_ERROR
  324.  * @description Fired when a fatal error is encountered.
  325.  * @property {string} type
  326.  *   'ad-error'
  327.  * @property {Object} originalEvent
  328.  *    The native SDK event, if available.
  329.  * @exportDoc
  330.  */
  333. /**
  334.  * @event shaka.ads.AdManager.AdInteractionEvent
  335.  * @description Fired when an ad triggers the interaction callback.
  336.  * @property {string} type
  337.  *   'ad-interaction'
  338.  * @property {Object} originalEvent
  339.  *    The native SDK event, if available.
  340.  * @exportDoc
  341.  */
  344. /**
  345.  * @event shaka.ads.AdManager#ImaAdManagerLoadedEvent
  346.  * @description Fired when the native IMA ad manager becomes available.
  347.  * @property {string} type
  348.  *   'ima-ad-manager-loaded'
  349.  * @property {!Object} imaAdManager
  350.  *    The native IMA ad manager.
  351.  * @exportDoc
  352.  */
  355. /**
  356.  * @event shaka.ads.AdManager#ImaStreamManagerLoadedEvent
  357.  * @description Fired when the native IMA stream manager becomes available.
  358.  * @property {string} type
  359.  *   'ima-stream-manager-loaded'
  360.  * @property {!Object} imaStreamManager
  361.  *    The native IMA stream manager.
  362.  * @exportDoc
  363.  */
  366. /**
  367.  * @event shaka.ads.AdManager.AdClickedEvent
  368.  * @description Fired when the ad was clicked.
  369.  * @property {string} type
  370.  *   'ad-clicked'
  371.  * @exportDoc
  372.  */
  375. /**
  376.  * @event shaka.ads.AdManager.AdContentPauseRequestedEvent
  377.  * @description Fired when the ad requires the main content to be paused.
  378.  *   Fired when the platform does not support multiple media elements.
  379.  * @property {string} type
  380.  *   'ad-content-pause-requested'
  381.  * @property {?boolean} saveLivePosition
  382.  *    Indicates whether the live position has to be saved or not.
  383.  * @exportDoc
  384.  */
  387. /**
  388.  * @event shaka.ads.AdManager.AdContentResumeRequestedEvent
  389.  * @description Fired when the ad requires the main content to be resumed.
  390.  *   Fired when the platform does not support multiple media elements.
  391.  * @property {string} type
  392.  *   'ad-content-resume-requested'
  393.  * @property {?number} offset
  394.  *   Indicates the offset that should be applied to the previously saved time.
  395.  * @exportDoc
  396.  */
  399. /**
  400.  * @event shaka.ads.AdManager.AdContentResumeRequestedEvent
  401.  * @description Fired when the ad requires the video of the main content to be
  402.  *   attached.
  403.  * @property {string} type
  404.  *   'ad-content-attach-requested'
  405.  * @exportDoc
  406.  */
  409. /**
  410.  * A class responsible for ad-related interactions.
  411.  * @implements {shaka.extern.IAdManager}
  412.  * @implements {shaka.util.IReleasable}
  413.  * @export
  414.  */
  415. shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
  416.   /** */
  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 overriden.');
  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 overriden.');
  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.     if (region.schemeIdUri != 'urn:mpeg:dash:event:alternativeMPD:2022') {
  847.       return;
  848.     }
  849.     if (!this.interstitialAdManager_) {
  850.       this.initInterstitial(/* adContainer= */ null, basePlayer, baseVideo);
  851.     }
  852.     if (this.interstitialAdManager_) {
  853.       this.interstitialAdManager_.addRegion(region);
  854.     }
  855.   }
  857.   /**
  858.    * @override
  859.    * @export
  860.    */
  861.   addCustomInterstitial(interstitial) {
  862.     if (!this.interstitialAdManager_) {
  863.       throw new shaka.util.Error(
  864.           shaka.util.Error.Severity.RECOVERABLE,
  865.           shaka.util.Error.Category.ADS,
  866.           shaka.util.Error.Code.INTERSTITIAL_AD_MANAGER_NOT_INITIALIZED);
  867.     }
  868.     this.interstitialAdManager_.addInterstitials([interstitial]);
  869.   }
  871.   /**
  872.    * @override
  873.    * @export
  874.    */
  875.   addAdUrlInterstitial(url) {
  876.     if (!this.interstitialAdManager_) {
  877.       throw new shaka.util.Error(
  878.           shaka.util.Error.Severity.RECOVERABLE,
  879.           shaka.util.Error.Category.ADS,
  880.           shaka.util.Error.Code.INTERSTITIAL_AD_MANAGER_NOT_INITIALIZED);
  881.     }
  882.     return this.interstitialAdManager_.addAdUrlInterstitial(url);
  883.   }
  885.   /**
  886.    * @param {!shaka.util.FakeEvent} event
  887.    * @private
  888.    */
  889.   processAndDispatchEvent_(event) {
  890.     if (event && event.type) {
  891.       switch (event.type) {
  892.         case shaka.ads.Utils.ADS_LOADED: {
  893.           const loadTime = (/** @type {!Object} */ (event))['loadTime'];
  894.           this.stats_.addLoadTime(loadTime);
  895.           break;
  896.         }
  897.         case shaka.ads.Utils.AD_STARTED:
  898.           this.stats_.incrementStarted();
  899.           break;
  900.         case shaka.ads.Utils.AD_COMPLETE:
  901.           this.stats_.incrementPlayedCompletely();
  902.           break;
  903.         case shaka.ads.Utils.AD_SKIPPED:
  904.           this.stats_.incrementSkipped();
  905.           break;
  906.         case shaka.ads.Utils.AD_ERROR:
  907.           this.stats_.incrementErrors();
  908.           break;
  909.       }
  910.     }
  911.     this.dispatchEvent(event);
  912.   }
  913. };
  915. /**
  916.  * The event name for when a sequence of ads has been loaded.
  917.  *
  918.  * Deprecated, please use {@link shaka.ads.Utils}
  919.  *
  920.  * @const {string}
  921.  * @export
  922.  * @deprecated
  923.  */
  924. shaka.ads.AdManager.ADS_LOADED = 'ads-loaded';
  926. /**
  927.  * The event name for when an ad has started playing.
  928.  *
  929.  * Deprecated, please use {@link shaka.ads.Utils}
  930.  *
  931.  * @const {string}
  932.  * @export
  933.  * @deprecated
  934.  */
  935. shaka.ads.AdManager.AD_STARTED = 'ad-started';
  938. /**
  939.  * The event name for when an ad playhead crosses first quartile.
  940.  *
  941.  * Deprecated, please use {@link shaka.ads.Utils}
  942.  *
  943.  * @const {string}
  944.  * @export
  945.  * @deprecated
  946.  */
  947. shaka.ads.AdManager.AD_FIRST_QUARTILE = 'ad-first-quartile';
  950. /**
  951.  * The event name for when an ad playhead crosses midpoint.
  952.  *
  953.  * Deprecated, please use {@link shaka.ads.Utils}
  954.  *
  955.  * @const {string}
  956.  * @export
  957.  * @deprecated
  958.  */
  959. shaka.ads.AdManager.AD_MIDPOINT = 'ad-midpoint';
  962. /**
  963.  * The event name for when an ad playhead crosses third quartile.
  964.  *
  965.  * Deprecated, please use {@link shaka.ads.Utils}
  966.  *
  967.  * @const {string}
  968.  * @export
  969.  * @deprecated
  970.  */
  971. shaka.ads.AdManager.AD_THIRD_QUARTILE = 'ad-third-quartile';
  974. /**
  975.  * The event name for when an ad has completed playing.
  976.  *
  977.  * Deprecated, please use {@link shaka.ads.Utils}
  978.  *
  979.  * @const {string}
  980.  * @export
  981.  * @deprecated
  982.  */
  983. shaka.ads.AdManager.AD_COMPLETE = 'ad-complete';
  986. /**
  987.  * The event name for when an ad has finished playing
  988.  * (played all the way through, was skipped, or was unable to proceed
  989.  * due to an error).
  990.  *
  991.  * Deprecated, please use {@link shaka.ads.Utils}
  992.  *
  993.  * @const {string}
  994.  * @export
  995.  * @deprecated
  996.  */
  997. shaka.ads.AdManager.AD_STOPPED = 'ad-stopped';
  1000. /**
  1001.  * The event name for when an ad is skipped by the user.
  1002.  *
  1003.  * Deprecated, please use {@link shaka.ads.Utils}
  1004.  *
  1005.  * @const {string}
  1006.  * @export
  1007.  * @deprecated
  1008.  */
  1009. shaka.ads.AdManager.AD_SKIPPED = 'ad-skipped';
  1012. /**
  1013.  * The event name for when the ad volume has changed.
  1014.  *
  1015.  * Deprecated, please use {@link shaka.ads.Utils}
  1016.  *
  1017.  * @const {string}
  1018.  * @export
  1019.  * @deprecated
  1020.  */
  1021. shaka.ads.AdManager.AD_VOLUME_CHANGED = 'ad-volume-changed';
  1024. /**
  1025.  * The event name for when the ad was muted.
  1026.  *
  1027.  * Deprecated, please use {@link shaka.ads.Utils}
  1028.  *
  1029.  * @const {string}
  1030.  * @export
  1031.  * @deprecated
  1032.  */
  1033. shaka.ads.AdManager.AD_MUTED = 'ad-muted';
  1036. /**
  1037.  * The event name for when the ad was paused.
  1038.  *
  1039.  * Deprecated, please use {@link shaka.ads.Utils}
  1040.  *
  1041.  * @const {string}
  1042.  * @export
  1043.  * @deprecated
  1044.  */
  1045. shaka.ads.AdManager.AD_PAUSED = 'ad-paused';
  1048. /**
  1049.  * The event name for when the ad was resumed after a pause.
  1050.  *
  1051.  * Deprecated, please use {@link shaka.ads.Utils}
  1052.  *
  1053.  * @const {string}
  1054.  * @export
  1055.  * @deprecated
  1056.  */
  1057. shaka.ads.AdManager.AD_RESUMED = 'ad-resumed';
  1060. /**
  1061.  * The event name for when the ad's skip status changes
  1062.  * (usually it becomes skippable when it wasn't before).
  1063.  *
  1064.  * Deprecated, please use {@link shaka.ads.Utils}
  1065.  *
  1066.  * @const {string}
  1067.  * @export
  1068.  * @deprecated
  1069.  */
  1070. shaka.ads.AdManager.AD_SKIP_STATE_CHANGED = 'ad-skip-state-changed';
  1073. /**
  1074.  * The event name for when the ad's cue points (start/end markers)
  1075.  * have changed.
  1076.  *
  1077.  * Deprecated, please use {@link shaka.ads.Utils}
  1078.  *
  1079.  * @const {string}
  1080.  * @export
  1081.  * @deprecated
  1082.  */
  1083. shaka.ads.AdManager.CUEPOINTS_CHANGED = 'ad-cue-points-changed';
  1086. /**
  1087.  * The event name for when the native IMA ad manager object has
  1088.  * loaded and become available.
  1089.  *
  1090.  * Deprecated, please use {@link shaka.ads.Utils}
  1091.  *
  1092.  * @const {string}
  1093.  * @export
  1094.  * @deprecated
  1095.  */
  1096. shaka.ads.AdManager.IMA_AD_MANAGER_LOADED = 'ima-ad-manager-loaded';
  1099. /**
  1100.  * The event name for when the native IMA stream manager object has
  1101.  * loaded and become available.
  1102.  *
  1103.  * Deprecated, please use {@link shaka.ads.Utils}
  1104.  *
  1105.  * @const {string}
  1106.  * @export
  1107.  * @deprecated
  1108.  */
  1109. shaka.ads.AdManager.IMA_STREAM_MANAGER_LOADED = 'ima-stream-manager-loaded';
  1112. /**
  1113.  * The event name for when the ad was clicked.
  1114.  *
  1115.  * Deprecated, please use {@link shaka.ads.Utils}
  1116.  *
  1117.  * @const {string}
  1118.  * @export
  1119.  * @deprecated
  1120.  */
  1121. shaka.ads.AdManager.AD_CLICKED = 'ad-clicked';
  1124. /**
  1125.  * The event name for when there is an update to the current ad's progress.
  1126.  *
  1127.  * Deprecated, please use {@link shaka.ads.Utils}
  1128.  *
  1129.  * @const {string}
  1130.  * @export
  1131.  * @deprecated
  1132.  */
  1133. shaka.ads.AdManager.AD_PROGRESS = 'ad-progress';
  1136. /**
  1137.  * The event name for when the ad is buffering.
  1138.  *
  1139.  * Deprecated, please use {@link shaka.ads.Utils}
  1140.  *
  1141.  * @const {string}
  1142.  * @export
  1143.  * @deprecated
  1144.  */
  1145. shaka.ads.AdManager.AD_BUFFERING = 'ad-buffering';
  1148. /**
  1149.  * The event name for when the ad's URL was hit.
  1150.  *
  1151.  * Deprecated, please use {@link shaka.ads.Utils}
  1152.  *
  1153.  * @const {string}
  1154.  * @export
  1155.  * @deprecated
  1156.  */
  1157. shaka.ads.AdManager.AD_IMPRESSION = 'ad-impression';
  1160. /**
  1161.  * The event name for when the ad's duration changed.
  1162.  *
  1163.  * Deprecated, please use {@link shaka.ads.Utils}
  1164.  *
  1165.  * @const {string}
  1166.  * @export
  1167.  * @deprecated
  1168.  */
  1169. shaka.ads.AdManager.AD_DURATION_CHANGED = 'ad-duration-changed';
  1172. /**
  1173.  * The event name for when the ad was closed by the user.
  1174.  *
  1175.  * Deprecated, please use {@link shaka.ads.Utils}
  1176.  *
  1177.  * @const {string}
  1178.  * @export
  1179.  * @deprecated
  1180.  */
  1181. shaka.ads.AdManager.AD_CLOSED = 'ad-closed';
  1184. /**
  1185.  * The event name for when the ad data becomes available.
  1186.  *
  1187.  * Deprecated, please use {@link shaka.ads.Utils}
  1188.  *
  1189.  * @const {string}
  1190.  * @export
  1191.  * @deprecated
  1192.  */
  1193. shaka.ads.AdManager.AD_LOADED = 'ad-loaded';
  1196. /**
  1197.  * The event name for when all the ads were completed.
  1198.  *
  1199.  * Deprecated, please use {@link shaka.ads.Utils}
  1200.  *
  1201.  * @const {string}
  1202.  * @export
  1203.  * @deprecated
  1204.  */
  1205. shaka.ads.AdManager.ALL_ADS_COMPLETED = 'all-ads-completed';
  1208. /**
  1209.  * The event name for when the ad changes from or to linear.
  1210.  *
  1211.  * Deprecated, please use {@link shaka.ads.Utils}
  1212.  *
  1213.  * @const {string}
  1214.  * @export
  1215.  * @deprecated
  1216.  */
  1217. shaka.ads.AdManager.AD_LINEAR_CHANGED = 'ad-linear-changed';
  1220. /**
  1221.  * The event name for when the ad's metadata becomes available.
  1222.  *
  1223.  * Deprecated, please use {@link shaka.ads.Utils}
  1224.  *
  1225.  * @const {string}
  1226.  * @export
  1227.  * @deprecated
  1228.  */
  1229. shaka.ads.AdManager.AD_METADATA = 'ad-metadata';
  1232. /**
  1233.  * The event name for when the ad display encountered a recoverable
  1234.  * error.
  1235.  *
  1236.  * Deprecated, please use {@link shaka.ads.Utils}
  1237.  *
  1238.  * @const {string}
  1239.  * @export
  1240.  * @deprecated
  1241.  */
  1242. shaka.ads.AdManager.AD_RECOVERABLE_ERROR = 'ad-recoverable-error';
  1244. /**
  1245.  * The event name for when the ad manager dispatch errors.
  1246.  *
  1247.  * Deprecated, please use {@link shaka.ads.Utils}
  1248.  *
  1249.  * @const {string}
  1250.  * @export
  1251.  * @deprecated
  1252.  */
  1253. shaka.ads.AdManager.AD_ERROR = 'ad-error';
  1255. /**
  1256.  * The event name for when the client side SDK signalled its readiness
  1257.  * to play a VPAID ad or an ad rule.
  1258.  *
  1259.  * Deprecated, please use {@link shaka.ads.Utils}
  1260.  *
  1261.  * @const {string}
  1262.  * @export
  1263.  * @deprecated
  1264.  */
  1265. shaka.ads.AdManager.AD_BREAK_READY = 'ad-break-ready';
  1268. /**
  1269.  * The event name for when the interaction callback for the ad was
  1270.  * triggered.
  1271.  *
  1272.  * Deprecated, please use {@link shaka.ads.Utils}
  1273.  *
  1274.  * @const {string}
  1275.  * @export
  1276.  * @deprecated
  1277.  */
  1278. shaka.ads.AdManager.AD_INTERACTION = 'ad-interaction';
  1281. /**
  1282.  * The name of the event for when an ad requires the main content to be paused.
  1283.  * Fired when the platform does not support multiple media elements.
  1284.  *
  1285.  * Deprecated, please use {@link shaka.ads.Utils}
  1286.  *
  1287.  * @const {string}
  1288.  * @export
  1289.  * @deprecated
  1290.  */
  1291. shaka.ads.AdManager.AD_CONTENT_PAUSE_REQUESTED = 'ad-content-pause-requested';
  1294. /**
  1295.  * The name of the event for when an ad requires the main content to be resumed.
  1296.  * Fired when the platform does not support multiple media elements.
  1297.  *
  1298.  * Deprecated, please use {@link shaka.ads.Utils}
  1299.  *
  1300.  * @const {string}
  1301.  * @export
  1302.  * @deprecated
  1303.  */
  1304. shaka.ads.AdManager.AD_CONTENT_RESUME_REQUESTED = 'ad-content-resume-requested';
  1307. /**
  1308.  * The name of the event for when an ad requires the video of the main content
  1309.  * to be attached.
  1310.  *
  1311.  * Deprecated, please use {@link shaka.ads.Utils}
  1312.  *
  1313.  * @const {string}
  1314.  * @export
  1315.  * @deprecated
  1316.  */
  1317. shaka.ads.AdManager.AD_CONTENT_ATTACH_REQUESTED = 'ad-content-attach-requested';
  1320. /**
  1321.  * Set this is a default ad manager for the player.
  1322.  * Apps can also set their own ad manager, if they'd like.
  1323.  */
  1324. shaka.Player.setAdManagerFactory(() => new shaka.ads.AdManager());