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('shaka.Player');
  11. goog.require('shaka.ads.AdsStats');
  12. goog.require('shaka.ads.ClientSideAdManager');
  13. goog.require('shaka.ads.ServerSideAdManager');
  14. goog.require('shaka.log');
  15. goog.require('shaka.util.Error');
  16. goog.require('shaka.util.FakeEvent');
  17. goog.require('shaka.util.FakeEventTarget');
  18. goog.require('shaka.util.IReleasable');
  21. /**
  22.  * @event shaka.ads.AdManager.ADS_LOADED
  23.  * @description Fired when an ad has started playing.
  24.  * @property {string} type
  25.  *   'ads-loaded'
  26.  * @property {number} loadTime
  27.  *    The time it takes to load ads.
  28.  * @exportDoc
  29.  */
  31. /**
  32.  * @event shaka.ads.AdManager.AdStartedEvent
  33.  * @description Fired when an ad has started playing.
  34.  * @property {string} type
  35.  *   'ad-started'
  36.  * @property {!shaka.extern.IAd} ad
  37.  *    The ad that has started playing.
  38.  * @property {Object} sdkAdObject
  39.  *    The ad object in the SDK format, if there is one.
  40.  * @property {Object} originalEvent
  41.  *    The native SDK event, if available.
  42.  * @exportDoc
  43.  */
  46. /**
  47.  * @event shaka.ads.AdManager.AdCompleteEvent
  48.  * @description Fired when an ad has played through.
  49.  * @property {string} type
  50.  *   'ad-complete'
  51.  * @property {Object} originalEvent
  52.  *    The native SDK event, if available.
  53.  * @exportDoc
  54.  */
  57. /**
  58.  * @event shaka.ads.AdManager.AdSkippedEvent
  59.  * @description Fired when an ad has been skipped.
  60.  * @property {string} type
  61.  *   'ad-skipped'
  62.  * @property {Object} originalEvent
  63.  *    The native SDK event, if available.
  64.  * @exportDoc
  65.  */
  68. /**
  69.  * @event shaka.ads.AdManager.AdFirstQuartileEvent
  70.  * @description Fired when an ad has played through the first 1/4.
  71.  * @property {string} type
  72.  *   'ad-first-quartile'
  73.  * @property {Object} originalEvent
  74.  *    The native SDK event, if available.
  75.  * @exportDoc
  76.  */
  79. /**
  80.  * @event shaka.ads.AdManager.AdMidpointEvent
  81.  * @description Fired when an ad has played through its midpoint.
  82.  * @property {string} type
  83.  *   'ad-midpoint'
  84.  * @property {Object} originalEvent
  85.  *    The native SDK event, if available.
  86.  * @exportDoc
  87.  */
  90. /**
  91.  * @event shaka.ads.AdManager.AdThirdQuartileEvent
  92.  * @description Fired when an ad has played through the third quartile.
  93.  * @property {string} type
  94.  *   'ad-third-quartile'
  95.  * @property {Object} originalEvent
  96.  *    The native SDK event, if available.
  97.  * @exportDoc
  98.  */
  101. /**
  102.  * @event shaka.ads.AdManager.AdStoppedEvent
  103.  * @description Fired when an ad has stopped playing, was skipped,
  104.  *   or was unable to proceed due to an error.
  105.  * @property {string} type
  106.  *   'ad-stopped'
  107.  * @property {Object} originalEvent
  108.  *    The native SDK event, if available.
  109.  * @exportDoc
  110.  */
  113. /**
  114.  * @event shaka.ads.AdManager.AdVolumeChangedEvent
  115.  * @description Fired when an ad's volume changed.
  116.  * @property {string} type
  117.  *   'ad-volume-changed'
  118.  * @property {Object} originalEvent
  119.  *    The native SDK event, if available.
  120.  * @exportDoc
  121.  */
  124. /**
  125.  * @event shaka.ads.AdManager.AdMutedEvent
  126.  * @description Fired when an ad was muted.
  127.  * @property {string} type
  128.  *   'ad-muted'
  129.  * @property {Object} originalEvent
  130.  *    The native SDK event, if available.
  131.  * @exportDoc
  132.  */
  135. /**
  136.  * @event shaka.ads.AdManager.AdPausedEvent
  137.  * @description Fired when an ad was paused.
  138.  * @property {string} type
  139.  *   'ad-paused'
  140.  * @property {Object} originalEvent
  141.  *    The native SDK event, if available.
  142.  * @exportDoc
  143.  */
  146. /**
  147.  * @event shaka.ads.AdManager.AdResumedEvent
  148.  * @description Fired when an ad was resumed after a pause.
  149.  * @property {string} type
  150.  *   'ad-resumed'
  151.  * @property {Object} originalEvent
  152.  *    The native SDK event, if available.
  153.  * @exportDoc
  154.  */
  157. /**
  158.  * @event shaka.ads.AdManager.AdSkipStateChangedEvent
  159.  * @description Fired when an ad's skip state changes (for example, when
  160.  *  it becomes possible to skip the ad).
  161.  * @property {string} type
  162.  *   'ad-skip-state-changed'
  163.  * @property {Object} originalEvent
  164.  *    The native SDK event, if available.
  165.  * @exportDoc
  166.  */
  169. /**
  170.  * @event shaka.ads.AdManager.AdResumedEvent
  171.  * @description Fired when the ad cue points change, signalling ad breaks
  172.  *  change.
  173.  * @property {string} type
  174.  *   'ad-cue-points-changed'
  175.  * @property {Object} originalEvent
  176.  *    The native SDK event, if available.
  177.  * @exportDoc
  178.  */
  181. /**
  182.  * @event shaka.ads.AdManager.AdProgressEvent
  183.  * @description Fired when there is an update to the current ad's progress.
  184.  * @property {string} type
  185.  *   'ad-progress'
  186.  * @property {Object} originalEvent
  187.  *    The native SDK event, if available.
  188.  * @exportDoc
  189.  */
  192. /**
  193.  * @event shaka.ads.AdManager.AdBufferingEvent
  194.  * @description Fired when the ad has stalled playback to buffer.
  195.  * @property {string} type
  196.  *   'ad-buffering'
  197.  * @property {Object} originalEvent
  198.  *    The native SDK event, if available.
  199.  * @exportDoc
  200.  */
  203. /**
  204.  * @event shaka.ads.AdManager.AdImpressionEvent
  205.  * @description Fired when the impression URL has been pinged.
  206.  * @property {string} type
  207.  *   'ad-impression'
  208.  * @property {Object} originalEvent
  209.  *    The native SDK event, if available.
  210.  * @exportDoc
  211.  */
  214. /**
  215.  * @event shaka.ads.AdManager.AdClickEvent
  216.  * @description Fired when the ad was clicked.
  217.  * @property {string} type
  218.  *   'ad-clicked'
  219.  * @property {Object} originalEvent
  220.  *    The native SDK event, if available.
  221.  * @exportDoc
  222.  */
  225. /**
  226.  * @event shaka.ads.AdManager.AdDurationChangedEvent
  227.  * @description Fired when the ad's duration changes.
  228.  * @property {string} type
  229.  *   'ad-duration-changed'
  230.  * @property {Object} originalEvent
  231.  *    The native SDK event, if available.
  232.  * @exportDoc
  233.  */
  236. /**
  237.  * @event shaka.ads.AdManager.AdClosedEvent
  238.  * @description Fired when the ad was closed by the user.
  239.  * @property {string} type
  240.  *   'ad-closed'
  241.  * @property {Object} originalEvent
  242.  *    The native SDK event, if available.
  243.  * @exportDoc
  244.  */
  247. /**
  248.  * @event shaka.ads.AdManager.AdLoadedEvent
  249.  * @description Fired when the ad data becomes available.
  250.  * @property {string} type
  251.  *   'ad-loaded'
  252.  * @property {Object} originalEvent
  253.  *    The native SDK event, if available.
  254.  * @exportDoc
  255.  */
  258. /**
  259.  * @event shaka.ads.AdManager.AllAdsCompletedEvent
  260.  * @description Fired when the ads manager is done playing all the ads.
  261.  * @property {string} type
  262.  *   'all-ads-completed'
  263.  * @property {Object} originalEvent
  264.  *    The native SDK event, if available.
  265.  * @exportDoc
  266.  */
  269. /**
  270.  * @event shaka.ads.AdManager.AdLinearChangedEvent
  271.  * @description Fired when the displayed ad changes from
  272.  *   linear to nonlinear, or vice versa.
  273.  * @property {string} type
  274.  *   'ad-linear-changed'
  275.  * @property {Object} originalEvent
  276.  *    The native SDK event, if available.
  277.  * @exportDoc
  278.  */
  281. /**
  282.  * @event shaka.ads.AdManager.AdMetadataEvent
  283.  * @description Fired when the ad's metadata becomes available.
  284.  * @property {string} type
  285.  *   'ad-metadata'
  286.  * @property {Object} originalEvent
  287.  *    The native SDK event, if available.
  288.  * @exportDoc
  289.  */
  292. /**
  293.  * @event shaka.ads.AdManager#AdBreakReadyEvent
  294.  * @description Fired when the client-side SDK is ready to play a
  295.  *   VPAID ad or an ad rule.
  296.  * @property {string} type
  297.  *   'ad-break-ready'
  298.  * @property {Object} originalEvent
  299.  *    The native SDK event, if available.
  300.  * @exportDoc
  301.  */
  304. /**
  305.  * @event shaka.ads.AdManager.AdRecoverableErrorEvent
  306.  * @description Fired when the a non-fatal error was encountered.
  307.  *   The presentation will continue with the same or next ad playback
  308.  *   depending on the error situation.
  309.  * @property {string} type
  310.  *   'ad-recoverable-error'
  311.  * @property {Object} originalEvent
  312.  *    The native SDK event, if available.
  313.  * @exportDoc
  314.  */
  317. /**
  318.  * @event shaka.ads.AdManager.AdInteractionEvent
  319.  * @description Fired when an ad triggers the interaction callback.
  320.  * @property {string} type
  321.  *   'ad-interaction'
  322.  * @property {Object} originalEvent
  323.  *    The native SDK event, if available.
  324.  * @exportDoc
  325.  */
  328. /**
  329.  * @event shaka.ads.AdManager#ImaAdManagerLoadedEvent
  330.  * @description Fired when the native IMA ad manager becomes available.
  331.  * @property {string} type
  332.  *   'ima-ad-manager-loaded'
  333.  * @property {!Object} imaAdManager
  334.  *    The native IMA ad manager.
  335.  * @exportDoc
  336.  */
  339. /**
  340.  * @event shaka.ads.AdManager#ImaStreamManagerLoadedEvent
  341.  * @description Fired when the native IMA stream manager becomes available.
  342.  * @property {string} type
  343.  *   'ima-stream-manager-loaded'
  344.  * @property {!Object} imaStreamManager
  345.  *    The native IMA stream manager.
  346.  * @exportDoc
  347.  */
  350. /**
  351.  * @event shaka.ads.AdManager.AdClickedEvent
  352.  * @description Fired when the ad was clicked.
  353.  * @property {string} type
  354.  *   'ad-clicked'
  355.  * @exportDoc
  356.  */
  359. /**
  360.  * A class responsible for ad-related interactions.
  361.  * @implements {shaka.extern.IAdManager}
  362.  * @implements {shaka.util.IReleasable}
  363.  * @export
  364.  */
  365. shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
  366.   /** */
  367.   constructor() {
  368.     super();
  369.     /** @private {shaka.ads.ClientSideAdManager} */
  370.     this.csAdManager_ = null;
  371.     /** @private {shaka.ads.ServerSideAdManager} */
  372.     this.ssAdManager_ = null;
  373.     /** @private {shaka.ads.AdsStats} */
  374.     this.stats_ = new shaka.ads.AdsStats();
  375.     /** @private {string} locale */
  376.     this.locale_ = navigator.language;
  377.   }
  380.   /**
  381.    * @override
  382.    * @export
  383.    */
  384.   setLocale(locale) {
  385.     this.locale_ = locale;
  386.   }
  389.   /**
  390.    * @override
  391.    * @export
  392.    */
  393.   initClientSide(adContainer, video) {
  394.     // Check that Client Side IMA SDK has been included
  395.     // NOTE: (window['google'] && google.ima) check for any
  396.     // IMA SDK, including SDK for Server Side ads.
  397.     // The 3rd check insures we have the right SDK:
  398.     // {google.ima.AdsLoader} is an object that's part of CS IMA SDK
  399.     // but not SS SDK.
  400.     if (!window['google'] || !google.ima || !google.ima.AdsLoader) {
  401.       throw new shaka.util.Error(
  402.           shaka.util.Error.Severity.CRITICAL,
  403.           shaka.util.Error.Category.ADS,
  404.           shaka.util.Error.Code.CS_IMA_SDK_MISSING);
  405.     }
  407.     if (this.csAdManager_) {
  408.       this.csAdManager_.release();
  409.     }
  411.     this.csAdManager_ = new shaka.ads.ClientSideAdManager(
  412.         adContainer, video, this.locale_,
  413.         (e) => {
  414.           const event = /** @type {!shaka.util.FakeEvent} */ (e);
  415.           if (event && event.type) {
  416.             switch (event.type) {
  417.               case shaka.ads.AdManager.ADS_LOADED: {
  418.                 const loadTime = (/** @type {!Object} */ (e))['loadTime'];
  419.                 this.stats_.addLoadTime(loadTime);
  420.                 break;
  421.               }
  422.               case shaka.ads.AdManager.AD_STARTED:
  423.                 this.stats_.incrementStarted();
  424.                 break;
  425.               case shaka.ads.AdManager.AD_COMPLETE:
  426.                 this.stats_.incrementPlayedCompletely();
  427.                 break;
  428.               case shaka.ads.AdManager.AD_SKIPPED:
  429.                 this.stats_.incrementSkipped();
  430.                 break;
  431.             }
  432.           }
  433.           this.dispatchEvent(event);
  434.         });
  435.   }
  438.   /**
  439.    * @override
  440.    * @export
  441.    */
  442.   release() {
  443.     if (this.csAdManager_) {
  444.       this.csAdManager_.release();
  445.       this.csAdManager_ = null;
  446.     }
  447.     if (this.ssAdManager_) {
  448.       this.ssAdManager_.release();
  449.       this.ssAdManager_ = null;
  450.     }
  451.     super.release();
  452.   }
  455.   /**
  456.   * @override
  457.   * @export
  458.   */
  459.   onAssetUnload() {
  460.     if (this.csAdManager_) {
  461.       this.csAdManager_.stop();
  462.     }
  463.     if (this.ssAdManager_) {
  464.       this.ssAdManager_.stop();
  465.     }
  467.     this.dispatchEvent(
  468.         new shaka.util.FakeEvent(shaka.ads.AdManager.AD_STOPPED));
  470.     this.stats_ = new shaka.ads.AdsStats();
  471.   }
  474.   /**
  475.    * @override
  476.    * @export
  477.    */
  478.   requestClientSideAds(imaRequest) {
  479.     if (!this.csAdManager_) {
  480.       throw new shaka.util.Error(
  481.           shaka.util.Error.Severity.RECOVERABLE,
  482.           shaka.util.Error.Category.ADS,
  483.           shaka.util.Error.Code.CS_AD_MANAGER_NOT_INITIALIZED);
  484.     }
  486.     this.csAdManager_.requestAds(imaRequest);
  487.   }
  490.   /**
  491.    * @override
  492.    * @export
  493.    */
  494.   initServerSide(adContainer, video) {
  495.     // Check that Client Side IMA SDK has been included
  496.     // NOTE: (window['google'] && google.ima) check for any
  497.     // IMA SDK, including SDK for Server Side ads.
  498.     // The 3rd check insures we have the right SDK:
  499.     // {google.ima.dai} is an object that's part of DAI IMA SDK
  500.     // but not SS SDK.
  501.     if (!window['google'] || !google.ima || !google.ima.dai) {
  502.       throw new shaka.util.Error(
  503.           shaka.util.Error.Severity.CRITICAL,
  504.           shaka.util.Error.Category.ADS,
  505.           shaka.util.Error.Code.SS_IMA_SDK_MISSING);
  506.     }
  508.     if (this.ssAdManager_) {
  509.       this.ssAdManager_.release();
  510.     }
  512.     this.ssAdManager_ = new shaka.ads.ServerSideAdManager(
  513.         adContainer, video, this.locale_,
  514.         (e) => {
  515.           const event = /** @type {!shaka.util.FakeEvent} */ (e);
  516.           if (event && event.type) {
  517.             switch (event.type) {
  518.               case shaka.ads.AdManager.ADS_LOADED: {
  519.                 const loadTime = (/** @type {!Object} */ (e))['loadTime'];
  520.                 this.stats_.addLoadTime(loadTime);
  521.                 break;
  522.               }
  523.               case shaka.ads.AdManager.AD_STARTED:
  524.                 this.stats_.incrementStarted();
  525.                 break;
  526.               case shaka.ads.AdManager.AD_COMPLETE:
  527.                 this.stats_.incrementPlayedCompletely();
  528.                 break;
  529.               case shaka.ads.AdManager.AD_SKIPPED:
  530.                 this.stats_.incrementSkipped();
  531.                 break;
  532.             }
  533.           }
  534.           this.dispatchEvent(event);
  535.         });
  536.   }
  539.   /**
  540.    * @param {!google.ima.dai.api.StreamRequest} imaRequest
  541.    * @param {string=} backupUrl
  542.    * @return {!Promise.<string>}
  543.    * @override
  544.    * @export
  545.    */
  546.   requestServerSideStream(imaRequest, backupUrl = '') {
  547.     if (!this.ssAdManager_) {
  548.       throw new shaka.util.Error(
  549.           shaka.util.Error.Severity.RECOVERABLE,
  550.           shaka.util.Error.Category.ADS,
  551.           shaka.util.Error.Code.SS_AD_MANAGER_NOT_INITIALIZED);
  552.     }
  554.     if (!imaRequest.adTagParameters) {
  555.       imaRequest.adTagParameters = {};
  556.     }
  557.     const adTagParams = imaRequest.adTagParameters;
  559.     if (adTagParams['mpt'] || adTagParams['mpv']) {
  560.       shaka.log.alwaysWarn('You have attempted to set "mpt" and/or "mpv" ' +
  561.         'parameters of the ad tag. Please note that those parameters are ' +
  562.         'used for Shaka adoption tracking and will be overriden.');
  563.     }
  565.     // Set player and version parameters for tracking
  566.     imaRequest.adTagParameters['mpt'] = 'shaka-player';
  567.     imaRequest.adTagParameters['mpv'] = shaka.Player.version;
  568.     return this.ssAdManager_.streamRequest(imaRequest, backupUrl);
  569.   }
  572.   /**
  573.    * @override
  574.    * @export
  575.    */
  576.   replaceServerSideAdTagParameters(adTagParameters) {
  577.     if (!this.ssAdManager_) {
  578.       throw new shaka.util.Error(
  579.           shaka.util.Error.Severity.RECOVERABLE,
  580.           shaka.util.Error.Category.ADS,
  581.           shaka.util.Error.Code.SS_AD_MANAGER_NOT_INITIALIZED);
  582.     }
  584.     if (adTagParameters['mpt'] || adTagParameters['mpv']) {
  585.       shaka.log.alwaysWarn('You have attempted to set "mpt" and/or "mpv" ' +
  586.         'parameters of the ad tag. Please note that those parameters are ' +
  587.         'used for Shaka adoption tracking and will be overriden.');
  588.     }
  590.     adTagParameters['mpt'] = 'Shaka Player';
  591.     adTagParameters['mpv'] = shaka.Player.version;
  593.     this.ssAdManager_.replaceAdTagParameters(adTagParameters);
  594.   }
  597.   /**
  598.    * @return {!Array.<!shaka.extern.AdCuePoint>}
  599.    * @override
  600.    * @export
  601.    */
  602.   getServerSideCuePoints() {
  603.     if (!this.ssAdManager_) {
  604.       throw new shaka.util.Error(
  605.           shaka.util.Error.Severity.RECOVERABLE,
  606.           shaka.util.Error.Category.ADS,
  607.           shaka.util.Error.Code.SS_AD_MANAGER_NOT_INITIALIZED);
  608.     }
  609.     return this.ssAdManager_.getCuePoints();
  610.   }
  613.   /**
  614.    * @return {shaka.extern.AdsStats}
  615.    * @override
  616.    * @export
  617.    */
  618.   getStats() {
  619.     return this.stats_.getBlob();
  620.   }
  622.   /**
  623.    * @override
  624.    * @export
  625.    */
  626.   onDashTimedMetadata(region) {
  627.     if (this.ssAdManager_ && region.schemeIdUri == 'urn:google:dai:2018') {
  628.       const type = region.schemeIdUri;
  629.       const data = region.eventElement ?
  630.           region.eventElement.getAttribute('messageData') : null;
  631.       const timestamp = region.startTime;
  632.       this.ssAdManager_.onTimedMetadata(type, data, timestamp);
  633.     }
  634.   }
  636.   /**
  637.    * @override
  638.    * @export
  639.    */
  640.   onHlsTimedMetadata(metadata, timestamp) {
  641.     if (this.ssAdManager_) {
  642.       this.ssAdManager_.onTimedMetadata('ID3', metadata['data'], timestamp);
  643.     } else {
  644.       shaka.log.warning('ID3 metadata processing was called without ' +
  645.         'initializing server side ad logic. Ad-related metadata will ' +
  646.         'not take effect');
  647.     }
  648.   }
  650.   /**
  651.    * @override
  652.    * @export
  653.    */
  654.   onCueMetadataChange(value) {
  655.     if (this.ssAdManager_) {
  656.       this.ssAdManager_.onCueMetadataChange(value);
  657.     } else {
  658.       shaka.log.warning('ID3 metadata processing was called without ' +
  659.         'initializing server side ad logic. Ad-related metadata will ' +
  660.         'not take effect');
  661.     }
  662.   }
  663. };
  665. /**
  666.  * The event name for when a sequence of ads has been loaded.
  667.  *
  668.  * @const {string}
  669.  * @export
  670.  */
  671. shaka.ads.AdManager.ADS_LOADED = 'ads-loaded';
  673. /**
  674.  * The event name for when an ad has started playing.
  675.  *
  676.  * @const {string}
  677.  * @export
  678.  */
  679. shaka.ads.AdManager.AD_STARTED = 'ad-started';
  682. /**
  683.  * The event name for when an ad playhead crosses first quartile.
  684.  *
  685.  * @const {string}
  686.  * @export
  687.  */
  688. shaka.ads.AdManager.AD_FIRST_QUARTILE = 'ad-first-quartile';
  691. /**
  692.  * The event name for when an ad playhead crosses midpoint.
  693.  *
  694.  * @const {string}
  695.  * @export
  696.  */
  697. shaka.ads.AdManager.AD_MIDPOINT = 'ad-midpoint';
  700. /**
  701.  * The event name for when an ad playhead crosses third quartile.
  702.  *
  703.  * @const {string}
  704.  * @export
  705.  */
  706. shaka.ads.AdManager.AD_THIRD_QUARTILE = 'ad-third-quartile';
  709. /**
  710.  * The event name for when an ad has completed playing.
  711.  *
  712.  * @const {string}
  713.  * @export
  714.  */
  715. shaka.ads.AdManager.AD_COMPLETE = 'ad-complete';
  718. /**
  719.  * The event name for when an ad has finished playing
  720.  * (played all the way through, was skipped, or was unable to proceed
  721.  * due to an error).
  722.  *
  723.  * @const {string}
  724.  * @export
  725.  */
  726. shaka.ads.AdManager.AD_STOPPED = 'ad-stopped';
  729. /**
  730.  * The event name for when an ad is skipped by the user..
  731.  *
  732.  * @const {string}
  733.  * @export
  734.  */
  735. shaka.ads.AdManager.AD_SKIPPED = 'ad-skipped';
  738. /**
  739.  * The event name for when the ad volume has changed.
  740.  *
  741.  * @const {string}
  742.  * @export
  743.  */
  744. shaka.ads.AdManager.AD_VOLUME_CHANGED = 'ad-volume-changed';
  747. /**
  748.  * The event name for when the ad was muted.
  749.  *
  750.  * @const {string}
  751.  * @export
  752.  */
  753. shaka.ads.AdManager.AD_MUTED = 'ad-muted';
  756. /**
  757.  * The event name for when the ad was paused.
  758.  *
  759.  * @const {string}
  760.  * @export
  761.  */
  762. shaka.ads.AdManager.AD_PAUSED = 'ad-paused';
  765. /**
  766.  * The event name for when the ad was resumed after a pause.
  767.  *
  768.  * @const {string}
  769.  * @export
  770.  */
  771. shaka.ads.AdManager.AD_RESUMED = 'ad-resumed';
  774. /**
  775.  * The event name for when the ad's skip status changes
  776.  * (usually it becomes skippable when it wasn't before).
  777.  *
  778.  * @const {string}
  779.  * @export
  780.  */
  781. shaka.ads.AdManager.AD_SKIP_STATE_CHANGED = 'ad-skip-state-changed';
  784. /**
  785.  * The event name for when the ad's cue points (start/end markers)
  786.  * have changed.
  787.  *
  788.  * @const {string}
  789.  * @export
  790.  */
  791. shaka.ads.AdManager.CUEPOINTS_CHANGED = 'ad-cue-points-changed';
  794. /**
  795.  * The event name for when the native IMA ad manager object has
  796.  * loaded and become available.
  797.  *
  798.  * @const {string}
  799.  * @export
  800.  */
  801. shaka.ads.AdManager.IMA_AD_MANAGER_LOADED = 'ima-ad-manager-loaded';
  804. /**
  805.  * The event name for when the native IMA stream manager object has
  806.  * loaded and become available.
  807.  *
  808.  * @const {string}
  809.  * @export
  810.  */
  811. shaka.ads.AdManager.IMA_STREAM_MANAGER_LOADED = 'ima-stream-manager-loaded';
  814. /**
  815.  * The event name for when the ad was clicked.
  816.  *
  817.  * @const {string}
  818.  * @export
  819.  */
  820. shaka.ads.AdManager.AD_CLICKED = 'ad-clicked';
  823. /**
  824.  * The event name for when there is an update to the current ad's progress.
  825.  *
  826.  * @const {string}
  827.  * @export
  828.  */
  829. shaka.ads.AdManager.AD_PROGRESS = 'ad-progress';
  832. /**
  833.  * The event name for when the ad is buffering.
  834.  *
  835.  * @const {string}
  836.  * @export
  837.  */
  838. shaka.ads.AdManager.AD_BUFFERING = 'ad-buffering';
  841. /**
  842.  * The event name for when the ad's URL was hit.
  843.  *
  844.  * @const {string}
  845.  * @export
  846.  */
  847. shaka.ads.AdManager.AD_IMPRESSION = 'ad-impression';
  850. /**
  851.  * The event name for when the ad's duration changed.
  852.  *
  853.  * @const {string}
  854.  * @export
  855.  */
  856. shaka.ads.AdManager.AD_DURATION_CHANGED = 'ad-duration-changed';
  859. /**
  860.  * The event name for when the ad was closed by the user.
  861.  *
  862.  * @const {string}
  863.  * @export
  864.  */
  865. shaka.ads.AdManager.AD_CLOSED = 'ad-closed';
  868. /**
  869.  * The event name for when the ad data becomes available.
  870.  *
  871.  * @const {string}
  872.  * @export
  873.  */
  874. shaka.ads.AdManager.AD_LOADED = 'ad-loaded';
  877. /**
  878.  * The event name for when all the ads were completed.
  879.  *
  880.  * @const {string}
  881.  * @export
  882.  */
  883. shaka.ads.AdManager.ALL_ADS_COMPLETED = 'all-ads-completed';
  886. /**
  887.  * The event name for when the ad changes from or to linear.
  888.  *
  889.  * @const {string}
  890.  * @export
  891.  */
  892. shaka.ads.AdManager.AD_LINEAR_CHANGED = 'ad-linear-changed';
  895. /**
  896.  * The event name for when the ad's metadata becomes available.
  897.  *
  898.  * @const {string}
  899.  * @export
  900.  */
  901. shaka.ads.AdManager.AD_METADATA = 'ad-metadata';
  904. /**
  905.  * The event name for when the ad display encountered a recoverable
  906.  * error.
  907.  *
  908.  * @const {string}
  909.  * @export
  910.  */
  911. shaka.ads.AdManager.AD_RECOVERABLE_ERROR = 'ad-recoverable-error';
  914. /**
  915.  * The event name for when the client side SDK signalled its readiness
  916.  * to play a VPAID ad or an ad rule.
  917.  *
  918.  * @const {string}
  919.  * @export
  920.  */
  921. shaka.ads.AdManager.AD_BREAK_READY = 'ad-break-ready';
  924. /**
  925.  * The event name for when the interaction callback for the ad was
  926.  * triggered.
  927.  *
  928.  * @const {string}
  929.  * @export
  930.  */
  931. shaka.ads.AdManager.AD_INTERACTION = 'ad-interaction';
  934. /**
  935.  * Set this is a default ad manager for the player.
  936.  * Apps can also set their own ad manager, if they'd like.
  937.  */
  938. shaka.Player.setAdManagerFactory(() => new shaka.ads.AdManager());