Source: lib/ads/ad_utils.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. goog.provide('shaka.ads.Utils');
  11. /**
  12.  * A class responsible for ad utils.
  13.  * @export
  14.  */
  15. shaka.ads.Utils = class {
  17. };
  19. /**
  20.  * The event name for when a sequence of ads has been loaded.
  21.  *
  22.  * @const {string}
  23.  * @export
  24.  */
  25. shaka.ads.Utils.ADS_LOADED = 'ads-loaded';
  27. /**
  28.  * The event name for when an ad has started playing.
  29.  *
  30.  * @const {string}
  31.  * @export
  32.  */
  33. shaka.ads.Utils.AD_STARTED = 'ad-started';
  36. /**
  37.  * The event name for when an ad playhead crosses first quartile.
  38.  *
  39.  * @const {string}
  40.  * @export
  41.  */
  42. shaka.ads.Utils.AD_FIRST_QUARTILE = 'ad-first-quartile';
  45. /**
  46.  * The event name for when an ad playhead crosses midpoint.
  47.  *
  48.  * @const {string}
  49.  * @export
  50.  */
  51. shaka.ads.Utils.AD_MIDPOINT = 'ad-midpoint';
  54. /**
  55.  * The event name for when an ad playhead crosses third quartile.
  56.  *
  57.  * @const {string}
  58.  * @export
  59.  */
  60. shaka.ads.Utils.AD_THIRD_QUARTILE = 'ad-third-quartile';
  63. /**
  64.  * The event name for when an ad has completed playing.
  65.  *
  66.  * @const {string}
  67.  * @export
  68.  */
  69. shaka.ads.Utils.AD_COMPLETE = 'ad-complete';
  72. /**
  73.  * The event name for when an ad has finished playing
  74.  * (played all the way through, was skipped, or was unable to proceed
  75.  * due to an error).
  76.  *
  77.  * @const {string}
  78.  * @export
  79.  */
  80. shaka.ads.Utils.AD_STOPPED = 'ad-stopped';
  83. /**
  84.  * The event name for when an ad is skipped by the user..
  85.  *
  86.  * @const {string}
  87.  * @export
  88.  */
  89. shaka.ads.Utils.AD_SKIPPED = 'ad-skipped';
  92. /**
  93.  * The event name for when the ad volume has changed.
  94.  *
  95.  * @const {string}
  96.  * @export
  97.  */
  98. shaka.ads.Utils.AD_VOLUME_CHANGED = 'ad-volume-changed';
  101. /**
  102.  * The event name for when the ad was muted.
  103.  *
  104.  * @const {string}
  105.  * @export
  106.  */
  107. shaka.ads.Utils.AD_MUTED = 'ad-muted';
  110. /**
  111.  * The event name for when the ad was paused.
  112.  *
  113.  * @const {string}
  114.  * @export
  115.  */
  116. shaka.ads.Utils.AD_PAUSED = 'ad-paused';
  119. /**
  120.  * The event name for when the ad was resumed after a pause.
  121.  *
  122.  * @const {string}
  123.  * @export
  124.  */
  125. shaka.ads.Utils.AD_RESUMED = 'ad-resumed';
  128. /**
  129.  * The event name for when the ad's skip status changes
  130.  * (usually it becomes skippable when it wasn't before).
  131.  *
  132.  * @const {string}
  133.  * @export
  134.  */
  135. shaka.ads.Utils.AD_SKIP_STATE_CHANGED = 'ad-skip-state-changed';
  138. /**
  139.  * The event name for when the ad's cue points (start/end markers)
  140.  * have changed.
  141.  *
  142.  * @const {string}
  143.  * @export
  144.  */
  145. shaka.ads.Utils.CUEPOINTS_CHANGED = 'ad-cue-points-changed';
  148. /**
  149.  * The event name for when the native IMA ad manager object has
  150.  * loaded and become available.
  151.  *
  152.  * @const {string}
  153.  * @export
  154.  */
  155. shaka.ads.Utils.IMA_AD_MANAGER_LOADED = 'ima-ad-manager-loaded';
  158. /**
  159.  * The event name for when the native IMA stream manager object has
  160.  * loaded and become available.
  161.  *
  162.  * @const {string}
  163.  * @export
  164.  */
  165. shaka.ads.Utils.IMA_STREAM_MANAGER_LOADED = 'ima-stream-manager-loaded';
  168. /**
  169.  * The event name for when the ad was clicked.
  170.  *
  171.  * @const {string}
  172.  * @export
  173.  */
  174. shaka.ads.Utils.AD_CLICKED = 'ad-clicked';
  177. /**
  178.  * The event name for when there is an update to the current ad's progress.
  179.  *
  180.  * @const {string}
  181.  * @export
  182.  */
  183. shaka.ads.Utils.AD_PROGRESS = 'ad-progress';
  186. /**
  187.  * The event name for when the ad is buffering.
  188.  *
  189.  * @const {string}
  190.  * @export
  191.  */
  192. shaka.ads.Utils.AD_BUFFERING = 'ad-buffering';
  195. /**
  196.  * The event name for when the ad's URL was hit.
  197.  *
  198.  * @const {string}
  199.  * @export
  200.  */
  201. shaka.ads.Utils.AD_IMPRESSION = 'ad-impression';
  204. /**
  205.  * The event name for when the ad's duration changed.
  206.  *
  207.  * @const {string}
  208.  * @export
  209.  */
  210. shaka.ads.Utils.AD_DURATION_CHANGED = 'ad-duration-changed';
  213. /**
  214.  * The event name for when the ad was closed by the user.
  215.  *
  216.  * @const {string}
  217.  * @export
  218.  */
  219. shaka.ads.Utils.AD_CLOSED = 'ad-closed';
  222. /**
  223.  * The event name for when the ad data becomes available.
  224.  *
  225.  * @const {string}
  226.  * @export
  227.  */
  228. shaka.ads.Utils.AD_LOADED = 'ad-loaded';
  231. /**
  232.  * The event name for when all the ads were completed.
  233.  *
  234.  * @const {string}
  235.  * @export
  236.  */
  237. shaka.ads.Utils.ALL_ADS_COMPLETED = 'all-ads-completed';
  240. /**
  241.  * The event name for when the ad changes from or to linear.
  242.  *
  243.  * @const {string}
  244.  * @export
  245.  */
  246. shaka.ads.Utils.AD_LINEAR_CHANGED = 'ad-linear-changed';
  249. /**
  250.  * The event name for when the ad's metadata becomes available.
  251.  *
  252.  * @const {string}
  253.  * @export
  254.  */
  255. shaka.ads.Utils.AD_METADATA = 'ad-metadata';
  258. /**
  259.  * The event name for when the ad display encountered a recoverable
  260.  * error.
  261.  *
  262.  * @const {string}
  263.  * @export
  264.  */
  265. shaka.ads.Utils.AD_RECOVERABLE_ERROR = 'ad-recoverable-error';
  267. /**
  268.  * The event name for when the ad manager dispatch errors.
  269.  *
  270.  * @const {string}
  271.  * @export
  272.  */
  273. shaka.ads.Utils.AD_ERROR = 'ad-error';
  275. /**
  276.  * The event name for when the client side SDK signalled its readiness
  277.  * to play a VPAID ad or an ad rule.
  278.  *
  279.  * @const {string}
  280.  * @export
  281.  */
  282. shaka.ads.Utils.AD_BREAK_READY = 'ad-break-ready';
  285. /**
  286.  * The event name for when the interaction callback for the ad was
  287.  * triggered.
  288.  *
  289.  * @const {string}
  290.  * @export
  291.  */
  292. shaka.ads.Utils.AD_INTERACTION = 'ad-interaction';
  295. /**
  296.  * The name of the event for when an ad requires the main content to be paused.
  297.  * Fired when the platform does not support multiple media elements.
  298.  *
  299.  * @const {string}
  300.  * @export
  301.  */
  302. shaka.ads.Utils.AD_CONTENT_PAUSE_REQUESTED = 'ad-content-pause-requested';
  305. /**
  306.  * The name of the event for when an ad requires the main content to be resumed.
  307.  * Fired when the platform does not support multiple media elements.
  308.  *
  309.  * @const {string}
  310.  * @export
  311.  */
  312. shaka.ads.Utils.AD_CONTENT_RESUME_REQUESTED = 'ad-content-resume-requested';
  315. /**
  316.  * The name of the event for when an ad requires the video of the main content
  317.  * to be attached.
  318.  *
  319.  * @const {string}
  320.  * @export
  321.  */
  322. shaka.ads.Utils.AD_CONTENT_ATTACH_REQUESTED = 'ad-content-attach-requested';