Source: externs/shaka/ads.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. /**
  9.  * @externs
  10.  */
  12. /**
  13.  * @typedef {{
  14.  *   loadTimes: !Array.<number>,
  15.  *   started: number,
  16.  *   playedCompletely: number,
  17.  *   skipped: number
  18.  * }}
  19.  *
  20.  * @description
  21.  * Contains statistics and information about the current state of the player.
  22.  *
  23.  * @property {number} loadTimes
  24.  *   The set of amounts of time it took to get the final manifest.
  25.  * @property {number} started
  26.  *   The number of ads started.
  27.  * @property {number} playedCompletely
  28.  *   The number of ads played completely.
  29.  * @property {number} skipped
  30.  *   The number of ads skipped.
  31.  * @exportDoc
  32.  */
  33. shaka.extern.AdsStats;
  36. /**
  37.  * An object that's responsible for all the ad-related logic
  38.  * in the player.
  39.  *
  40.  * @interface
  41.  * @exportDoc
  42.  */
  43. shaka.extern.IAdManager = class extends EventTarget {
  44.   /**
  45.    * @param {string} locale
  46.    */
  47.   setLocale(locale) {}
  49.   release() {}
  51.   onAssetUnload() {}
  53.   /**
  54.    * @param {!HTMLElement} adContainer
  55.    * @param {!HTMLMediaElement} video
  56.    */
  57.   initClientSide(adContainer, video) {}
  59.   /**
  60.    * @param {!google.ima.AdsRequest} imaRequest
  61.    */
  62.   requestClientSideAds(imaRequest) {}
  64.   /**
  65.    * @param {!HTMLElement} adContainer
  66.    * @param {!HTMLMediaElement} video
  67.    */
  68.   initServerSide(adContainer, video) {}
  70.   /**
  71.    * @param {!google.ima.dai.api.StreamRequest} imaRequest
  72.    * @param {string=} backupUrl
  73.    * @return {!Promise.<!string>}
  74.    */
  75.   requestServerSideStream(imaRequest, backupUrl) {}
  77.   /**
  78.    * @param {Object} adTagParameters
  79.    */
  80.   replaceServerSideAdTagParameters(adTagParameters) {}
  82.   /**
  83.    * Get statistics for the current playback session. If the player is not
  84.    * playing content, this will return an empty stats object.
  85.    */
  86.   getStats() {}
  88.   /**
  89.    * @param {shaka.extern.TimelineRegionInfo} region
  90.    */
  91.   onDashTimedMetadata(region) {}
  93.   /**
  94.    * @param {shaka.extern.ID3Metadata} metadata
  95.    * @param {number} timestampOffset
  96.    */
  97.   onHlsTimedMetadata(metadata, timestampOffset) {}
  99.   /**
  100.    * @param {shaka.extern.ID3Metadata} value
  101.    */
  102.   onCueMetadataChange(value) {}
  103. };
  106. /**
  107.  * A factory for creating the ad manager.
  108.  *
  109.  * @typedef {function():!shaka.extern.IAdManager}
  110.  * @exportDoc
  111.  */
  112. shaka.extern.IAdManager.Factory;
  115. /**
  116.  * Interface for Ad objects.
  117.  *
  118.  * @extends {shaka.util.IReleasable}
  119.  * @interface
  120.  * @exportDoc
  121.  */
  122. shaka.extern.IAd = class {
  123.   /**
  124.    * @return {number}
  125.    */
  126.   getDuration() {}
  128.   /**
  129.    * Gets the minimum suggested duration.  Defaults to being equivalent to
  130.    * getDuration() for server-side ads.
  131.    * @see http://bit.ly/3q3U6hI
  132.    * @return {number}
  133.    */
  134.   getMinSuggestedDuration() {}
  136.   /**
  137.    * @return {number}
  138.    */
  139.   getRemainingTime() {}
  141.   /**
  142.    * @return {number}
  143.    */
  144.   getTimeUntilSkippable() {}
  146.   /**
  147.    * @return {boolean}
  148.    */
  149.   isPaused() {}
  151.   /**
  152.    * @return {boolean}
  153.    */
  154.   isSkippable() {}
  156.   /**
  157.    * @return {boolean}
  158.    */
  159.   canSkipNow() {}
  161.   skip() {}
  163.   play() {}
  165.   pause() {}
  167.   /**
  168.    * @return {number}
  169.    */
  170.   getVolume() {}
  172.   /**
  173.    * @param {number} volume
  174.    */
  175.   setVolume(volume) {}
  177.   /**
  178.    * @return {boolean}
  179.    */
  180.   isMuted() {}
  182.   /**
  183.    * @param {boolean} muted
  184.    */
  185.   setMuted(muted) {}
  187.   /**
  188.    * @param {number} width
  189.    * @param {number} height
  190.    */
  191.   resize(width, height) {}
  193.   /**
  194.    * @return {number}
  195.    */
  196.   getSequenceLength() {}
  198.   /**
  199.    * @return {number}
  200.    */
  201.   getPositionInSequence() {}
  202. };