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