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.  *   averageLoadTime: number,
  16.  *   started: number,
  17.  *   playedCompletely: number,
  18.  *   skipped: number,
  19.  *   errors: number
  20.  * }}
  21.  *
  22.  * @description
  23.  * Contains statistics and information about the current state of the player.
  24.  *
  25.  * @property {number} loadTimes
  26.  *   The set of amounts of time it took to get the final manifest.
  27.  * @property {number} averageLoadTime
  28.  *   The average time it took to get the final manifest.
  29.  * @property {number} started
  30.  *   The number of ads started.
  31.  * @property {number} playedCompletely
  32.  *   The number of ads played completely.
  33.  * @property {number} skipped
  34.  *   The number of ads skipped.
  35.  * @property {number} errors
  36.  *   The number of ads with errors.
  37.  * @exportDoc
  38.  */
  39. shaka.extern.AdsStats;
  42. /**
  43.  * @typedef {{
  44.  *   start: number,
  45.  *   end: ?number
  46.  * }}
  47.  *
  48.  * @description
  49.  * Contains the times of a range of an Ad.
  50.  *
  51.  * @property {number} start
  52.  *   The start time of the range, in milliseconds.
  53.  * @property {number} end
  54.  *   The end time of the range, in milliseconds.
  55.  * @exportDoc
  56.  */
  57. shaka.extern.AdCuePoint;
  60. /**
  61.  * @typedef {{
  62.  *   id: ?string,
  63.  *   startTime: number,
  64.  *   endTime: ?number,
  65.  *   uri: string,
  66.  *   isSkippable: boolean,
  67.  *   skipOffset: ?number,
  68.  *   canJump: boolean,
  69.  *   resumeOffset: ?number,
  70.  *   playoutLimit: ?number,
  71.  *   once: boolean,
  72.  *   pre: boolean,
  73.  *   post: boolean,
  74.  *   timelineRange: boolean
  75.  * }}
  76.  *
  77.  * @description
  78.  * Contains the ad interstitial info.
  79.  *
  80.  * @property {?string} id
  81.  *   The id of the interstitial.
  82.  * @property {number} startTime
  83.  *   The start time of the interstitial.
  84.  * @property {?number} endTime
  85.  *   The end time of the interstitial.
  86.  * @property {string} uri
  87.  *   The uri of the interstitial, can be any type that
  88.  *   ShakaPlayer supports (either in MSE or src=)
  89.  * @property {boolean} isSkippable
  90.  *   Indicate if the interstitial is skippable.
  91.  * @property {?number} skipOffset
  92.  *   Time value that identifies when skip controls are made available to the
  93.  *   end user.
  94.  * @property {boolean} canJump
  95.  *   Indicate if the interstitial is jumpable.
  96.  * @property {?number} resumeOffset
  97.  *   Indicates where the primary playback will resume after the interstitial
  98.  *   plays. It is expressed as a time lag from when interstitial playback was
  99.  *   scheduled on the primary player's timeline. For live ad replacement it
  100.  *   must be null.
  101.  * @property {?number} playoutLimit
  102.  *   Indicate a limit for the playout time of the entire interstitial.
  103.  * @property {boolean} once
  104.  *   Indicates that the interstitial should only be played once.
  105.  * @property {boolean} pre
  106.  *   Indicates that an action is to be triggered before playback of the
  107.  *   primary asset begins, regardless of where playback begins in the primary
  108.  *   asset.
  109.  * @property {boolean} post
  110.  *   Indicates that an action is to be triggered after the primary asset has
  111.  *   been played to its end without error.
  112.  * @property {boolean} timelineRange
  113.  *   Indicates whether the  interstitial should be presented in a timeline UI
  114.  *   as a single point or as a range.
  115.  */
  116. shaka.extern.AdInterstitial;
  119. /**
  120.  * An object that's responsible for all the ad-related logic
  121.  * in the player.
  122.  *
  123.  * @interface
  124.  * @exportDoc
  125.  */
  126. shaka.extern.IAdManager = class extends EventTarget {
  127.   /**
  128.    * @param {string} locale
  129.    */
  130.   setLocale(locale) {}
  132.   /**
  133.    * Called by the Player to provide an updated configuration any time it
  134.    * changes.
  135.    * Must be called at least once before init*().
  136.    *
  137.    * @param {shaka.extern.AdsConfiguration} config
  138.    */
  139.   configure(config) {}
  141.   release() {}
  143.   onAssetUnload() {}
  145.   /**
  146.    * @param {?HTMLElement} adContainer
  147.    * @param {!shaka.Player} basePlayer
  148.    * @param {!HTMLMediaElement} baseVideo
  149.    */
  150.   initInterstitial(adContainer, basePlayer, baseVideo) {}
  152.   /**
  153.    * @param {!HTMLElement} adContainer
  154.    * @param {!HTMLMediaElement} video
  155.    * @param {?google.ima.AdsRenderingSettings} adsRenderingSettings
  156.    */
  157.   initClientSide(adContainer, video, adsRenderingSettings) {}
  159.   /**
  160.    * @param {!google.ima.AdsRequest} imaRequest
  161.    */
  162.   requestClientSideAds(imaRequest) {}
  164.   /**
  165.    * @param {!google.ima.AdsRenderingSettings} adsRenderingSettings
  166.    */
  167.   updateClientSideAdsRenderingSettings(adsRenderingSettings) {}
  169.   /**
  170.    * @param {!HTMLElement} adContainer
  171.    * @param {!shaka.net.NetworkingEngine} networkingEngine
  172.    * @param {!HTMLMediaElement} video
  173.    */
  174.   initMediaTailor(adContainer, networkingEngine, video) {}
  176.   /**
  177.    * @param {string} url
  178.    * @param {Object} adsParams
  179.    * @param {string=} backupUrl
  180.    * @return {!Promise.<string>}
  181.    */
  182.   requestMediaTailorStream(url, adsParams, backupUrl) {}
  184.   /**
  185.    * @param {string} url
  186.    */
  187.   addMediaTailorTrackingUrl(url) {}
  189.   /**
  190.    * @param {!HTMLElement} adContainer
  191.    * @param {!HTMLMediaElement} video
  192.    */
  193.   initServerSide(adContainer, video) {}
  195.   /**
  196.    * @param {!google.ima.dai.api.StreamRequest} imaRequest
  197.    * @param {string=} backupUrl
  198.    * @return {!Promise.<string>}
  199.    */
  200.   requestServerSideStream(imaRequest, backupUrl) {}
  202.   /**
  203.    * @param {Object} adTagParameters
  204.    */
  205.   replaceServerSideAdTagParameters(adTagParameters) {}
  207.   /**
  208.    * @return {!Array.<!shaka.extern.AdCuePoint>}
  209.    */
  210.   getServerSideCuePoints() {}
  212.   /**
  213.    * @return {!Array.<!shaka.extern.AdCuePoint>}
  214.    */
  215.   getCuePoints() {}
  217.   /**
  218.    * Get statistics for the current playback session. If the player is not
  219.    * playing content, this will return an empty stats object.
  220.    */
  221.   getStats() {}
  223.   /**
  224.    * @param {shaka.extern.TimelineRegionInfo} region
  225.    */
  226.   onDashTimedMetadata(region) {}
  228.   /**
  229.    * Fired when the manifest is updated.
  230.    *
  231.    * @param {boolean} isLive
  232.    */
  233.   onManifestUpdated(isLive) {}
  235.   /**
  236.    * @param {shaka.extern.ID3Metadata} metadata
  237.    * @param {number} timestampOffset
  238.    */
  239.   onHlsTimedMetadata(metadata, timestampOffset) {}
  241.   /**
  242.    * @param {shaka.extern.MetadataFrame} value
  243.    */
  244.   onCueMetadataChange(value) {}
  246.   /**
  247.    * @param {!shaka.Player} basePlayer
  248.    * @param {!HTMLMediaElement} baseVideo
  249.    * @param {shaka.extern.HLSInterstitial} interstitial
  250.    */
  251.   onHLSInterstitialMetadata(basePlayer, baseVideo, interstitial) {}
  253.   /**
  254.    * @param {!shaka.Player} basePlayer
  255.    * @param {!HTMLMediaElement} baseVideo
  256.    * @param {shaka.extern.TimelineRegionInfo} region
  257.    */
  258.   onDASHInterstitialMetadata(basePlayer, baseVideo, region) {}
  260.   /**
  261.    * @param {shaka.extern.AdInterstitial} interstitial
  262.    */
  263.   addCustomInterstitial(interstitial) {}
  265.   /**
  266.    * @param {string} url
  267.    * @return {!Promise}
  268.    */
  269.   addAdUrlInterstitial(url) {}
  270. };
  273. /**
  274.  * A factory for creating the ad manager.
  275.  *
  276.  * @typedef {function():!shaka.extern.IAdManager}
  277.  * @exportDoc
  278.  */
  279. shaka.extern.IAdManager.Factory;
  282. /**
  283.  * Interface for Ad objects.
  284.  *
  285.  * @extends {shaka.util.IReleasable}
  286.  * @interface
  287.  * @exportDoc
  288.  */
  289. shaka.extern.IAd = class {
  290.   /**
  291.    * @return {boolean}
  292.    */
  293.   needsSkipUI() {}
  295.   /**
  296.    * @return {number}
  297.    */
  298.   getDuration() {}
  300.   /**
  301.    * Gets the minimum suggested duration.  Defaults to being equivalent to
  302.    * getDuration() for server-side ads.
  303.    * @see http://bit.ly/3q3U6hI
  304.    * @return {number}
  305.    */
  306.   getMinSuggestedDuration() {}
  308.   /**
  309.    * @return {number}
  310.    */
  311.   getRemainingTime() {}
  313.   /**
  314.    * @return {number}
  315.    */
  316.   getTimeUntilSkippable() {}
  318.   /**
  319.    * @return {boolean}
  320.    */
  321.   isPaused() {}
  323.   /**
  324.    * @return {boolean}
  325.    */
  326.   isSkippable() {}
  328.   /**
  329.    * @return {boolean}
  330.    */
  331.   canSkipNow() {}
  333.   skip() {}
  335.   play() {}
  337.   pause() {}
  339.   /**
  340.    * @return {number}
  341.    */
  342.   getVolume() {}
  344.   /**
  345.    * @param {number} volume
  346.    */
  347.   setVolume(volume) {}
  349.   /**
  350.    * @return {boolean}
  351.    */
  352.   isMuted() {}
  354.   /**
  355.    * @param {boolean} muted
  356.    */
  357.   setMuted(muted) {}
  359.   /**
  360.    * @return {boolean}
  361.    */
  362.   isLinear() {}
  364.   /**
  365.    * @param {number} width
  366.    * @param {number} height
  367.    */
  368.   resize(width, height) {}
  370.   /**
  371.    * @return {number}
  372.    */
  373.   getSequenceLength() {}
  375.   /**
  376.    * @return {number}
  377.    */
  378.   getPositionInSequence() {}
  380.   /**
  381.    * @return {string}
  382.    */
  383.   getTitle() {}
  385.   /**
  386.    * @return {string}
  387.    */
  388.   getDescription() {}
  390.   /**
  391.    * @return {number}
  392.    */
  393.   getVastMediaBitrate() {}
  395.   /**
  396.    * @return {number}
  397.    */
  398.   getVastMediaHeight() {}
  400.   /**
  401.    * @return {number}
  402.    */
  403.   getVastMediaWidth() {}
  405.   /**
  406.    * @return {string}
  407.    */
  408.   getAdId() {}
  410.   /**
  411.    * @return {string}
  412.    */
  413.   getCreativeAdId() {}
  415.   /**
  416.    * @return {string}
  417.    */
  418.   getAdvertiserName() {}
  420.   /**
  421.    * @return {?string}
  422.    */
  423.   getMediaUrl() {}
  425.   /**
  426.    * @return {number}
  427.    */
  428.   getTimeOffset() {}
  430.   /**
  431.    * @return {number}
  432.    */
  433.   getPodIndex() {}
  434. };