shaka-player 4.9.13 → 4.10.1

package/dist/shaka-player.ui.debug.externs.js

@@ -1799,7 +1799,8 @@ shaka.net.NetworkingEngine.AdvancedRequestType = {
   'MEDIA_PLAYLIST': 2,
   'MASTER_PLAYLIST': 3,
   'MPD': 4,
-  'MSS': 5
+  'MSS': 5,
+  'MPD_PATCH': 6
 };
 /**
  * Priority level for network scheme plugins.
@@ -2586,6 +2587,11 @@ shaka.media.PresentationTimeline = class {
    * @param {!Array.<!shaka.media.SegmentReference>} references
    */
   notifySegments(references) {}
+  /**
+   * Gets the end time of the last available segment.
+   * @return {?number}
+   */
+  getMaxSegmentEndTime() {}
   /**
    * Lock the presentation timeline's start time.  After this is called, no
    * further adjustments to presentationStartTime_ will be permitted.
@@ -2700,6 +2706,12 @@ shaka.media.PresentationTimeline = class {
    * @param {number} offset
    */
   setAvailabilityTimeOffset(offset) {}
+  /**
+   * Gets the presentation's segment availability time offset. This should be
+   * only configured for Low Latency Dash.
+   * @return {number} availabilityTimeOffset parameter
+   */
+  getAvailabilityTimeOffset() {}
 };
 /**
  * @typedef {{
@@ -3075,11 +3087,10 @@ shaka.media.PreloadManager = class extends shaka.util.FakeEventTarget {
   /**
    * @param {string} assetUri
    * @param {?string} mimeType
-   * @param {number} startTimeOfLoad
    * @param {?number} startTime
    * @param {*} playerInterface
    */
-  constructor(assetUri, mimeType, startTimeOfLoad, startTime, playerInterface) {}
+  constructor(assetUri, mimeType, startTime, playerInterface) {}
   /**
    * Waits for the loading to be finished (or to fail with an error).
    * @return {!Promise}
@@ -3377,9 +3388,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * Leaves the player in a state where it cannot play media, until it has been
    * attached to something else.
    * @param {boolean=} keepAdManager
+   * @param {boolean=} saveLivePosition
    * @return {!Promise.<?shaka.media.PreloadManager>}
    */
-  detachAndSavePreload(keepAdManager) {}
+  detachAndSavePreload(keepAdManager, saveLivePosition) {}
   /**
    * Starts to preload a given asset, and returns a PreloadManager object that
    * represents that preloading process.
@@ -3402,6 +3414,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * @return {!Promise.<?shaka.media.PreloadManager>}
    */
   preload(assetUri, startTime, mimeType) {}
+  /**
+   * Calls |destroy| on each PreloadManager object this player has created.
+   */
+  destroyAllPreloads() {}
   /**
    * Releases all of the mutexes of the player. Meant for use by the tests.
    */
@@ -3520,6 +3536,11 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * Go to live in a live stream.
    */
   goToLive() {}
+  /**
+   * Indicates if the player has fully loaded the stream.
+   * @return {boolean}
+   */
+  isFullyLoaded() {}
   /**
    * Get the key system currently used by EME. If EME is not being used, this
    * will return an empty string. If the player has not loaded content, this
@@ -3692,8 +3713,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * @param {string=} role
    * @param {number=} channelsCount
    * @param {number=} safeMargin
+   * @param {string=} codec
    */
-  selectAudioLanguage(language, role, channelsCount, safeMargin) {}
+  selectAudioLanguage(language, role, channelsCount, safeMargin, codec) {}
   /**
    * Sets the current text language and current text role to the selected
    * language and role, and chooses a new variant if need be. If the player has
@@ -3999,6 +4021,321 @@ shaka.ads.ClientSideAd = class {
    */
   release() {}
 };
+/**
+ * A class responsible for ad utils.
+ */
+shaka.ads.Utils = class {
+};
+/**
+ * The event name for when a sequence of ads has been loaded.
+ * @const {string}
+ */
+shaka.ads.Utils.ADS_LOADED;
+/**
+ * The event name for when an ad has started playing.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_STARTED;
+/**
+ * The event name for when an ad playhead crosses first quartile.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_FIRST_QUARTILE;
+/**
+ * The event name for when an ad playhead crosses midpoint.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_MIDPOINT;
+/**
+ * The event name for when an ad playhead crosses third quartile.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_THIRD_QUARTILE;
+/**
+ * The event name for when an ad has completed playing.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_COMPLETE;
+/**
+ * The event name for when an ad has finished playing
+ * (played all the way through, was skipped, or was unable to proceed
+ * due to an error).
+ * @const {string}
+ */
+shaka.ads.Utils.AD_STOPPED;
+/**
+ * The event name for when an ad is skipped by the user..
+ * @const {string}
+ */
+shaka.ads.Utils.AD_SKIPPED;
+/**
+ * The event name for when the ad volume has changed.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_VOLUME_CHANGED;
+/**
+ * The event name for when the ad was muted.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_MUTED;
+/**
+ * The event name for when the ad was paused.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_PAUSED;
+/**
+ * The event name for when the ad was resumed after a pause.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_RESUMED;
+/**
+ * The event name for when the ad's skip status changes
+ * (usually it becomes skippable when it wasn't before).
+ * @const {string}
+ */
+shaka.ads.Utils.AD_SKIP_STATE_CHANGED;
+/**
+ * The event name for when the ad's cue points (start/end markers)
+ * have changed.
+ * @const {string}
+ */
+shaka.ads.Utils.CUEPOINTS_CHANGED;
+/**
+ * The event name for when the native IMA ad manager object has
+ * loaded and become available.
+ * @const {string}
+ */
+shaka.ads.Utils.IMA_AD_MANAGER_LOADED;
+/**
+ * The event name for when the native IMA stream manager object has
+ * loaded and become available.
+ * @const {string}
+ */
+shaka.ads.Utils.IMA_STREAM_MANAGER_LOADED;
+/**
+ * The event name for when the ad was clicked.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_CLICKED;
+/**
+ * The event name for when there is an update to the current ad's progress.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_PROGRESS;
+/**
+ * The event name for when the ad is buffering.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_BUFFERING;
+/**
+ * The event name for when the ad's URL was hit.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_IMPRESSION;
+/**
+ * The event name for when the ad's duration changed.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_DURATION_CHANGED;
+/**
+ * The event name for when the ad was closed by the user.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_CLOSED;
+/**
+ * The event name for when the ad data becomes available.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_LOADED;
+/**
+ * The event name for when all the ads were completed.
+ * @const {string}
+ */
+shaka.ads.Utils.ALL_ADS_COMPLETED;
+/**
+ * The event name for when the ad changes from or to linear.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_LINEAR_CHANGED;
+/**
+ * The event name for when the ad's metadata becomes available.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_METADATA;
+/**
+ * The event name for when the ad display encountered a recoverable
+ * error.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_RECOVERABLE_ERROR;
+/**
+ * The event name for when the ad manager dispatch errors.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_ERROR;
+/**
+ * The event name for when the client side SDK signalled its readiness
+ * to play a VPAID ad or an ad rule.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_BREAK_READY;
+/**
+ * The event name for when the interaction callback for the ad was
+ * triggered.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_INTERACTION;
+/**
+ * The name of the event for when an ad requires the main content to be paused.
+ * Fired when the platform does not support multiple media elements.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_CONTENT_PAUSE_REQUESTED;
+/**
+ * The name of the event for when an ad requires the main content to be resumed.
+ * Fired when the platform does not support multiple media elements.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_CONTENT_RESUME_REQUESTED;
+/**
+ * The name of the event for when an ad requires the video of the main content
+ * to be attached.
+ * @const {string}
+ */
+shaka.ads.Utils.AD_CONTENT_ATTACH_REQUESTED;
+/**
+ * @implements {shaka.extern.IAd}
+ */
+shaka.ads.InterstitialAd = class {
+  /**
+   * @param {HTMLMediaElement} video
+   * @param {boolean} isSkippable
+   * @param {function()} onSkip
+   * @param {number} sequenceLength
+   * @param {number} adPosition
+   */
+  constructor(video, isSkippable, onSkip, sequenceLength, adPosition) {}
+  /**
+   * @override
+   */
+  getDuration() {}
+  /**
+   * @override
+   */
+  getMinSuggestedDuration() {}
+  /**
+   * @override
+   */
+  getRemainingTime() {}
+  /**
+   * @override
+   */
+  isPaused() {}
+  /**
+   * @override
+   */
+  isSkippable() {}
+  /**
+   * @override
+   */
+  getTimeUntilSkippable() {}
+  /**
+   * @override
+   */
+  canSkipNow() {}
+  /**
+   * @override
+   */
+  skip() {}
+  /**
+   * @override
+   */
+  pause() {}
+  /**
+   * @override
+   */
+  play() {}
+  /**
+   * @override
+   */
+  getVolume() {}
+  /**
+   * @override
+   */
+  setVolume(volume) {}
+  /**
+   * @override
+   */
+  isMuted() {}
+  /**
+   * @override
+   */
+  isLinear() {}
+  /**
+   * @override
+   */
+  resize(width, height) {}
+  /**
+   * @override
+   */
+  setMuted(muted) {}
+  /**
+   * @override
+   */
+  getSequenceLength() {}
+  /**
+   * @override
+   */
+  getPositionInSequence() {}
+  /**
+   * @override
+   */
+  getTitle() {}
+  /**
+   * @override
+   */
+  getDescription() {}
+  /**
+   * @override
+   */
+  getVastMediaBitrate() {}
+  /**
+   * @override
+   */
+  getVastMediaHeight() {}
+  /**
+   * @override
+   */
+  getVastMediaWidth() {}
+  /**
+   * @override
+   */
+  getAdId() {}
+  /**
+   * @override
+   */
+  getCreativeAdId() {}
+  /**
+   * @override
+   */
+  getAdvertiserName() {}
+  /**
+   * @override
+   */
+  getMediaUrl() {}
+  /**
+   * @override
+   */
+  getTimeOffset() {}
+  /**
+   * @override
+   */
+  getPodIndex() {}
+  /**
+   * @override
+   */
+  release() {}
+};
 /**
  * @implements {shaka.extern.IAd}
  */
@@ -4277,6 +4614,10 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
    * @override
    */
   configure(config) {}
+  /**
+   * @override
+   */
+  initInterstitial(adContainer, basePlayer, baseVideo) {}
   /**
    * @override
    */
@@ -4360,166 +4701,254 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
    * @override
    */
   onCueMetadataChange(value) {}
+  /**
+   * @override
+   */
+  onInterstitialMetadata(basePlayer, baseVideo, interstitial) {}
 };
 /**
  * The event name for when a sequence of ads has been loaded.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.ADS_LOADED;
 /**
  * The event name for when an ad has started playing.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_STARTED;
 /**
  * The event name for when an ad playhead crosses first quartile.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_FIRST_QUARTILE;
 /**
  * The event name for when an ad playhead crosses midpoint.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_MIDPOINT;
 /**
  * The event name for when an ad playhead crosses third quartile.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_THIRD_QUARTILE;
 /**
  * The event name for when an ad has completed playing.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_COMPLETE;
 /**
  * The event name for when an ad has finished playing
  * (played all the way through, was skipped, or was unable to proceed
  * due to an error).
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_STOPPED;
 /**
- * The event name for when an ad is skipped by the user..
+ * The event name for when an ad is skipped by the user.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_SKIPPED;
 /**
  * The event name for when the ad volume has changed.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_VOLUME_CHANGED;
 /**
  * The event name for when the ad was muted.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_MUTED;
 /**
  * The event name for when the ad was paused.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_PAUSED;
 /**
  * The event name for when the ad was resumed after a pause.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_RESUMED;
 /**
  * The event name for when the ad's skip status changes
  * (usually it becomes skippable when it wasn't before).
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_SKIP_STATE_CHANGED;
 /**
  * The event name for when the ad's cue points (start/end markers)
  * have changed.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.CUEPOINTS_CHANGED;
 /**
  * The event name for when the native IMA ad manager object has
  * loaded and become available.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.IMA_AD_MANAGER_LOADED;
 /**
  * The event name for when the native IMA stream manager object has
  * loaded and become available.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.IMA_STREAM_MANAGER_LOADED;
 /**
  * The event name for when the ad was clicked.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_CLICKED;
 /**
  * The event name for when there is an update to the current ad's progress.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_PROGRESS;
 /**
  * The event name for when the ad is buffering.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_BUFFERING;
 /**
  * The event name for when the ad's URL was hit.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_IMPRESSION;
 /**
  * The event name for when the ad's duration changed.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_DURATION_CHANGED;
 /**
  * The event name for when the ad was closed by the user.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_CLOSED;
 /**
  * The event name for when the ad data becomes available.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_LOADED;
 /**
  * The event name for when all the ads were completed.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.ALL_ADS_COMPLETED;
 /**
  * The event name for when the ad changes from or to linear.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_LINEAR_CHANGED;
 /**
  * The event name for when the ad's metadata becomes available.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_METADATA;
 /**
  * The event name for when the ad display encountered a recoverable
  * error.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_RECOVERABLE_ERROR;
 /**
  * The event name for when the ad manager dispatch errors.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_ERROR;
 /**
  * The event name for when the client side SDK signalled its readiness
  * to play a VPAID ad or an ad rule.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_BREAK_READY;
 /**
  * The event name for when the interaction callback for the ad was
  * triggered.
+ * Deprecated, please use {@link shaka.ads.Utils}
  * @const {string}
+ * @deprecated
  */
 shaka.ads.AdManager.AD_INTERACTION;
+/**
+ * The name of the event for when an ad requires the main content to be paused.
+ * Fired when the platform does not support multiple media elements.
+ * Deprecated, please use {@link shaka.ads.Utils}
+ * @const {string}
+ * @deprecated
+ */
+shaka.ads.AdManager.AD_CONTENT_PAUSE_REQUESTED;
+/**
+ * The name of the event for when an ad requires the main content to be resumed.
+ * Fired when the platform does not support multiple media elements.
+ * Deprecated, please use {@link shaka.ads.Utils}
+ * @const {string}
+ * @deprecated
+ */
+shaka.ads.AdManager.AD_CONTENT_RESUME_REQUESTED;
+/**
+ * The name of the event for when an ad requires the video of the main content
+ * to be attached.
+ * Deprecated, please use {@link shaka.ads.Utils}
+ * @const {string}
+ * @deprecated
+ */
+shaka.ads.AdManager.AD_CONTENT_ATTACH_REQUESTED;
 /**
  * @summary A proxy to switch between local and remote playback for Chromecast
  * in a way that is transparent to the app's controls.
@@ -4766,6 +5195,10 @@ shaka.dash.DashParser = class {
    * @override
    */
   banLocation(uri) {}
+  /**
+   * @override
+   */
+  setMediaElement(mediaElement) {}
 };
 /**
  */
@@ -4843,6 +5276,10 @@ shaka.hls.HlsParser = class {
    * @override
    */
   banLocation(uri) {}
+  /**
+   * @override
+   */
+  setMediaElement(mediaElement) {}
 };
 /**
  * Creates a new MSS parser.
@@ -5795,20 +6232,25 @@ shaka.ui.AdPosition = class extends shaka.ui.Element {
 };
 /**
  * @extends {shaka.ui.Element}
- * @implements {shaka.extern.IUIPlayButton}
+ * @final
  */
-shaka.ui.PlayButton = class extends shaka.ui.Element {
+shaka.ui.ContextMenu = class extends shaka.ui.Element {
   /**
    * @param {!HTMLElement} parent
    * @param {!shaka.ui.Controls} controls
    */
   constructor(parent, controls) {}
+  /**
+   * @param {string} name
+   * @param {!shaka.extern.IUIElement.Factory} factory
+   */
+  static registerElement(name, factory) {}
 };
 /**
- * @extends {shaka.ui.PlayButton}
- * @final
+ * @extends {shaka.ui.Element}
+ * @implements {shaka.extern.IUIPlayButton}
  */
-shaka.ui.BigPlayButton = class extends shaka.ui.PlayButton {
+shaka.ui.PlayButton = class extends shaka.ui.Element {
   /**
    * @param {!HTMLElement} parent
    * @param {!shaka.ui.Controls} controls
@@ -5816,20 +6258,15 @@ shaka.ui.BigPlayButton = class extends shaka.ui.PlayButton {
   constructor(parent, controls) {}
 };
 /**
- * @extends {shaka.ui.Element}
+ * @extends {shaka.ui.PlayButton}
  * @final
  */
-shaka.ui.ContextMenu = class extends shaka.ui.Element {
+shaka.ui.BigPlayButton = class extends shaka.ui.PlayButton {
   /**
    * @param {!HTMLElement} parent
    * @param {!shaka.ui.Controls} controls
    */
   constructor(parent, controls) {}
-  /**
-   * @param {string} name
-   * @param {!shaka.extern.IUIElement.Factory} factory
-   */
-  static registerElement(name, factory) {}
 };
 /**
  * @extends {shaka.ui.Element}
@@ -6172,6 +6609,17 @@ shaka.ui.OverflowMenu = class extends shaka.ui.Element {
    */
   static registerElement(name, factory) {}
 };
+/**
+ * @extends {shaka.ui.Element}
+ * @final
+ */
+shaka.ui.AdStatisticsButton = class extends shaka.ui.Element {
+  /**
+   * @param {!HTMLElement} parent
+   * @param {!shaka.ui.Controls} controls
+   */
+  constructor(parent, controls) {}
+};
 /**
  * @extends {shaka.ui.Element}
  * @final
@@ -6400,6 +6848,17 @@ shaka.ui.RewindButton = class extends shaka.ui.Element {
    */
   constructor(parent, controls) {}
 };
+/**
+ * @extends {shaka.ui.Element}
+ * @final
+ */
+shaka.ui.SaveVideoFrameButton = class extends shaka.ui.Element {
+  /**
+   * @param {!HTMLElement} parent
+   * @param {!shaka.ui.Controls} controls
+   */
+  constructor(parent, controls) {}
+};
 /**
  * @extends {shaka.ui.PlayButton}
  * @final