shaka-player 4.5.0 → 4.6.0

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

@@ -60,13 +60,6 @@ shaka.util.IReleasable = class {
    */
   release() {}
 };
-/**
- * @enum {string}
- */
-shaka.config.CodecSwitchingStrategy = {
-  RELOAD: 'reload',
-  SMOOTH: 'smooth'
-};
 /**
  * @summary A set of BufferSource utility functions.
  */
@@ -100,6 +93,18 @@ shaka.util.BufferUtils = class {
    * @return {!Uint8Array}
    */
   static toUint8(data, offset, length) {}
+  /**
+   * Creates a new Uint16Array view on the same buffer.  This clamps the values
+   * to be within the same view (i.e. you can't use this to move past the end
+   * of the view, even if the underlying buffer is larger).  However, you can
+   * pass a negative offset to access the data before the view.
+   * @param {BufferSource} data
+   * @param {number=} offset The offset from the beginning of this data's view
+   *   to start the new view at.
+   * @param {number=} length The byte length of the new view.
+   * @return {!Uint16Array}
+   */
+  static toUint16(data, offset, length) {}
   /**
    * Creates a DataView over the given buffer.
    * @see toUint8
@@ -745,7 +750,6 @@ shaka.util.Error.Code = {
   'TEXT_ONLY_WEBVTT_SRC_EQUALS': 2013,
   'MISSING_TEXT_PLUGIN': 2014,
   'CHAPTERS_TRACK_FAILED': 2015,
-  'CANNOT_ADD_EXTERNAL_THUMBNAILS_TO_SRC_EQUALS': 2016,
   'UNSUPPORTED_EXTERNAL_THUMBNAILS_URI': 2017,
   'BUFFER_READ_OUT_OF_BOUNDS': 3000,
   'JS_INTEGER_OVERFLOW': 3001,
@@ -1140,9 +1144,11 @@ shaka.abr.SimpleAbrManager = class {
    */
   init(switchCallback) {}
   /**
+   * @param {boolean=} preferFastSwitching
+   * @return {shaka.extern.Variant}
    * @override
    */
-  chooseVariant() {}
+  chooseVariant(preferFastSwitching) {}
   /**
    * @override
    */
@@ -1154,7 +1160,7 @@ shaka.abr.SimpleAbrManager = class {
   /**
    * @override
    */
-  segmentDownloaded(deltaTimeMs, numBytes) {}
+  segmentDownloaded(deltaTimeMs, numBytes, allowSwitch) {}
   /**
    * @override
    */
@@ -1185,6 +1191,13 @@ shaka.config.AutoShowText = {
   'IF_PREFERRED_TEXT_LANGUAGE': 2,
   'IF_SUBTITLES_MAY_BE_NEEDED': 3
 };
+/**
+ * @enum {string}
+ */
+shaka.config.CodecSwitchingStrategy = {
+  RELOAD: 'reload',
+  SMOOTH: 'smooth'
+};
 /**
  * A utility to wrap abortable operations.  Note that these are not cancelable.
  * Cancelation implies undoing what has been done so far, whereas aborting only
@@ -1344,17 +1357,20 @@ shaka.util.FakeEventTarget.ListenerType;
  */
 shaka.net.NetworkingEngine = class extends shaka.util.FakeEventTarget {
   /**
-   * @param {function(number, number)=} onProgressUpdated Called when a progress
-   *   event is triggered. Passed the duration, in milliseconds, that the
-   *   request took, and the number of bytes transferred.
+   * @param {function(number, number, boolean)=} onProgressUpdated Called when
+   *   a progress event is triggered. Passed the duration, in milliseconds,
+   *   that the request took, the number of bytes transferred, and the boolean
+   *   of whether the switching is allowed.
    * @param {shaka.net.NetworkingEngine.OnHeadersReceived=} onHeadersReceived
    *   Called when the headers are received for a download.
    * @param {shaka.net.NetworkingEngine.OnDownloadFailed=} onDownloadFailed
    *   Called when a download fails, for any reason.
    * @param {shaka.net.NetworkingEngine.OnRequest=} onRequest
    *   Called when a request is made
+   * @param {shaka.net.NetworkingEngine.OnRetry=} onRetry
+   *   Called when a request retry is made
    */
-  constructor(onProgressUpdated, onHeadersReceived, onDownloadFailed, onRequest) {}
+  constructor(onProgressUpdated, onHeadersReceived, onDownloadFailed, onRequest, onRetry) {}
   /**
    * @param {boolean} forceHTTPS
    */
@@ -1483,7 +1499,8 @@ shaka.net.NetworkingEngine.RequestType = {
   'TIMING': 4,
   'SERVER_CERTIFICATE': 5,
   'KEY': 6,
-  'ADS': 7
+  'ADS': 7,
+  'CONTENT_STEERING': 8
 };
 /**
  * A more advanced form of the RequestType structure, meant to describe
@@ -1542,6 +1559,17 @@ shaka.net.NetworkingEngine.OnDownloadFailed;
  * A callback function called on every request
  */
 shaka.net.NetworkingEngine.OnRequest;
+/**
+ * @typedef {function(
+ *    !shaka.net.NetworkingEngine.RequestType,
+ *    (shaka.extern.RequestContext|undefined),
+ *    string,
+ *    string)}
+ * @description
+ * A callback function called on every request retry. The first string is the
+ * new URI and the second string is the old URI.
+ */
+shaka.net.NetworkingEngine.OnRetry;
 /**
  * @summary
  * An EventManager maintains a collection of "event
@@ -1993,8 +2021,10 @@ shaka.media.SegmentReference = class {
    *  not available.
    * @param {?shaka.extern.aes128Key=} aes128Key
    *  The segment's AES-128-CBC full segment encryption key and iv.
+   * @param {boolean=} allPartialSegments
+   *  Indicate if the segment has all partial segments
    */
-  constructor(startTime, endTime, uris, startByte, endByte, initSegmentReference, timestampOffset, appendWindowStart, appendWindowEnd, partialReferences, tilesLayout, tileDuration, syncTime, status, aes128Key) {}
+  constructor(startTime, endTime, uris, startByte, endByte, initSegmentReference, timestampOffset, appendWindowStart, appendWindowEnd, partialReferences, tilesLayout, tileDuration, syncTime, status, aes128Key, allPartialSegments) {}
   /**
    * Creates and returns the URIs of the resource containing the segment.
    * @return {!Array.<string>}
@@ -2061,6 +2091,24 @@ shaka.media.SegmentReference = class {
    * @return {boolean}
    */
   isIndependent() {}
+  /**
+   * Mark the reference as partial.
+   */
+  markAsPartial() {}
+  /**
+   * Returns true if the segment is partial.
+   * @return {boolean}
+   */
+  isPartial() {}
+  /**
+   * Mark the reference as being the last part of the full segment
+   */
+  markAsLastPartial() {}
+  /**
+   * Returns true if reference as being the last part of the full segment.
+   * @return {boolean}
+   */
+  isLastPartial() {}
   /**
    * Mark the reference as byterange optimization.
    * The "byterange optimization" means that it is playable using MP4 low
@@ -2184,11 +2232,10 @@ shaka.util.TsParser = class {
    * The code is based on hls.js
    * Credit to https://github.com/video-dev/hls.js/blob/master/src/demux/tsdemuxer.ts
    * @param {shaka.extern.MPEG_PES} pes
-   * @param {?shaka.extern.MPEG_PES=} nextPes
    * @param {?shaka.extern.VideoNalu=} lastNalu
    * @return {!Array.<shaka.extern.VideoNalu>}
    */
-  parseNalus(pes, nextPes, lastNalu) {}
+  parseNalus(pes, lastNalu) {}
   /**
    * Return the ID3 metadata
    * @return {!Array.<shaka.extern.ID3Metadata>}
@@ -2201,14 +2248,16 @@ shaka.util.TsParser = class {
   getAudioData() {}
   /**
    * Return the audio data
+   * @param {boolean=} naluProcessing
    * @return {!Array.<shaka.extern.MPEG_PES>}
    */
-  getVideoData() {}
+  getVideoData(naluProcessing) {}
   /**
    * Return the start time for the audio and video
-   * @return {{audio: ?number, video: ?number}}
+   * @param {string} contentType
+   * @return {?number}
    */
-  getStartTime() {}
+  getStartTime(contentType) {}
   /**
    * Return the audio and video codecs
    * @return {{audio: ?string, video: ?string}}
@@ -2460,7 +2509,9 @@ shaka.media.PresentationTimeline = class {
  * @typedef {{
  *   start: number,
  *   unscaledStart: number,
- *   end: number
+ *   end: number,
+ *   partialSegments: number,
+ *   segmentPosition: number
  * }}
  * @description
  * Defines a time range of a media segment.  Times are in seconds.
@@ -2470,6 +2521,10 @@ shaka.media.PresentationTimeline = class {
  *   The start time of the range in representation timescale units.
  * @property {number} end
  *   The end time (exclusive) of the range.
+ * @property {number} partialSegments
+ *   The number of partial segments
+ * @property {number} segmentPosition
+ *   The segment position of the timeline entry as it appears in the manifest
  */
 shaka.media.PresentationTimeline.TimeRange;
 /**
@@ -2689,6 +2744,32 @@ shaka.text.SimpleTextDisplayer = class {
    */
   setTextVisibility(on) {}
 };
+/**
+* A stub text displayer plugin that does nothing
+* @implements {shaka.extern.TextDisplayer}
+*/
+shaka.text.StubTextDisplayer = class {
+  /**
+   * @override
+   */
+  remove(start, end) {}
+  /**
+   * @override
+   */
+  append(cues) {}
+  /**
+   * @override
+   */
+  destroy() {}
+  /**
+   * @override
+   */
+  isTextVisible() {}
+  /**
+   * @override
+   */
+  setTextVisibility(on) {}
+};
 /**  */
 shaka.util.Dom = class {
   /**
@@ -2936,16 +3017,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    */
   static probeSupport(promptsOkay) {}
   /**
-   * Tell the player to use <code>mediaElement</code> for all <code>load</code>
-   * requests until <code>detach</code> or <code>destroy</code> are called.
-   * <p>
-   * Calling <code>attach</code> with <code>initializedMediaSource=true</code>
-   * will tell the player to take the initial load step and initialize media
-   * source.
-   * <p>
-   * Calls to <code>attach</code> will interrupt any in-progress calls to
-   * <code>load</code> but cannot interrupt calls to <code>attach</code>,
-   * <code>detach</code>, or <code>unload</code>.
+   * Attaches the player to a media element.
+   * If the player was already attached to a media element, first detaches from
+   * that media element.
    * @param {!HTMLMediaElement} mediaElement
    * @param {boolean=} initializeMediaSource
    * @return {!Promise}
@@ -2958,35 +3032,15 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    */
   attachCanvas(canvas) {}
   /**
-   * Tell the player to stop using its current media element. If the player is:
-   * <ul>
-   *  <li>detached, this will do nothing,
-   *  <li>attached, this will release the media element,
-   *  <li>loading, this will abort loading, unload, and release the media
-   *      element,
-   *  <li>playing content, this will stop playback, unload, and release the
-   *      media element.
-   * </ul>
-   * <p>
-   * Calls to <code>detach</code> will interrupt any in-progress calls to
-   * <code>load</code> but cannot interrupt calls to <code>attach</code>,
-   * <code>detach</code>, or <code>unload</code>.
+   * Detach the player from the current media element. Leaves the player in a
+   * state where it cannot play media, until it has been attached to something
+   * else.
+   * @param {boolean=} keepAdManager
    * @return {!Promise}
    */
-  detach() {}
+  detach(keepAdManager) {}
   /**
-   * Tell the player to either return to:
-   * <ul>
-   *   <li>detached (when it does not have a media element),
-   *   <li>attached (when it has a media element and
-   *     <code>initializedMediaSource=false</code>)
-   *   <li>media source initialized (when it has a media element and
-   *     <code>initializedMediaSource=true</code>)
-   * </ul>
-   * <p>
-   * Calls to <code>unload</code> will interrupt any in-progress calls to
-   * <code>load</code> but cannot interrupt calls to <code>attach</code>,
-   * <code>detach</code>, or <code>unload</code>.
+   * Unloads the currently playing stream, if any.
    * @param {boolean=} initializeMediaSource
    * @param {boolean=} keepAdManager
    * @return {!Promise}
@@ -3001,22 +3055,21 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    */
   updateStartTime(startTime) {}
   /**
-   * Tell the player to load the content at <code>assetUri</code> and start
-   * playback at <code>startTime</code>. Before calling <code>load</code>,
-   * a call to <code>attach</code> must have succeeded.
-   * <p>
-   * Calls to <code>load</code> will interrupt any in-progress calls to
-   * <code>load</code> but cannot interrupt calls to <code>attach</code>,
-   * <code>detach</code>, or <code>unload</code>.
+   * Loads a new stream.
+   * If another stream was already playing, first unloads that stream.
    * @param {string} assetUri
    * @param {?number=} startTime
    *    When <code>startTime</code> is <code>null</code> or
    *    <code>undefined</code>, playback will start at the default start time (0
    *    for VOD and liveEdge for LIVE).
-   * @param {string=} mimeType
+   * @param {?string=} mimeType
    * @return {!Promise}
    */
   load(assetUri, startTime, mimeType) {}
+  /**
+   * Releases all of the mutexes of the player. Meant for use by the tests.
+   */
+  releaseAllMutexes() {}
   /**
    * Changes configuration settings on the Player.  This checks the names of
    * keys and the types of values to avoid coding errors.  If there are errors,
@@ -3115,7 +3168,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
   isAudioOnly() {}
   /**
    * Get the range of time (in seconds) that seeking is allowed. If the player
-   * has not loaded content, this will return a range from 0 to 0.
+   * has not loaded content and the manifest is HLS, this will return a range
+   * from 0 to 0.
    * @return {{start: number, end: number}}
    */
   seekRange() {}
@@ -3213,6 +3267,13 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * @return {!Array.<shaka.extern.Track>}
    */
   getImageTracks() {}
+  /**
+   * Returns Thumbnail objects for each thumbnail for a given image track ID.
+   * If the player has not loaded content, this will return a null.
+   * @param {number} trackId
+   * @return {!Promise.<?Array<!shaka.extern.Thumbnail>>}
+   */
+  getAllThumbnails(trackId) {}
   /**
    * Return a Thumbnail object from a image track Id and time.
    * If the player has not loaded content, this will return a null.
@@ -4337,6 +4398,14 @@ shaka.dash.DashParser = class {
    * @override
    */
   onExpirationUpdated(sessionId, expiration) {}
+  /**
+   * @override
+   */
+  onInitialVariantChosen(variant) {}
+  /**
+   * @override
+   */
+  banLocation(uri) {}
 };
 /**
  */
@@ -4406,6 +4475,14 @@ shaka.hls.HlsParser = class {
    * @override
    */
   onExpirationUpdated(sessionId, expiration) {}
+  /**
+   * @override
+   */
+  onInitialVariantChosen(variant) {}
+  /**
+   * @override
+   */
+  banLocation(uri) {}
 };
 /**
  * Creates a new MSS parser.
@@ -4434,6 +4511,14 @@ shaka.mss.MssParser = class {
    * @override
    */
   onExpirationUpdated(sessionId, expiration) {}
+  /**
+   * @override
+   */
+  onInitialVariantChosen(variant) {}
+  /**
+   * @override
+   */
+  banLocation(uri) {}
 };
 /**
  * @summary A networking plugin to handle http and https URIs via the Fetch API.
@@ -4906,7 +4991,7 @@ shaka.text.TtmlTextParser = class {
   /**
    * @override
    */
-  parseMedia(data, time) {}
+  parseMedia(data, time, uri) {}
 };
 /**
  * @implements {shaka.extern.TextParser}
@@ -4929,7 +5014,7 @@ shaka.text.Mp4TtmlParser = class {
   /**
    * @override
    */
-  parseMedia(data, time) {}
+  parseMedia(data, time, uri) {}
 };
 /**
  * @implements {shaka.extern.TextParser}
@@ -5019,7 +5104,7 @@ shaka.text.SrtTextParser = class {
   /**
    * @override
    */
-  parseMedia(data, time) {}
+  parseMedia(data, time, uri) {}
   /**
    * Convert a SRT format to WebVTT
    * @param {string} data
@@ -5077,7 +5162,7 @@ shaka.transmuxer.AacTransmuxer = class {
   /**
    * @override
    */
-  getOrginalMimeType() {}
+  getOriginalMimeType() {}
   /**
    * @override
    */
@@ -5110,7 +5195,7 @@ shaka.transmuxer.Ac3Transmuxer = class {
   /**
    * @override
    */
-  getOrginalMimeType() {}
+  getOriginalMimeType() {}
   /**
    * @override
    */
@@ -5143,7 +5228,7 @@ shaka.transmuxer.Ec3Transmuxer = class {
   /**
    * @override
    */
-  getOrginalMimeType() {}
+  getOriginalMimeType() {}
   /**
    * @override
    */
@@ -5176,7 +5261,7 @@ shaka.transmuxer.Mp3Transmuxer = class {
   /**
    * @override
    */
-  getOrginalMimeType() {}
+  getOriginalMimeType() {}
   /**
    * @override
    */
@@ -5209,7 +5294,7 @@ shaka.transmuxer.MpegTsTransmuxer = class {
   /**
    * @override
    */
-  getOrginalMimeType() {}
+  getOriginalMimeType() {}
   /**
    * @override
    */
@@ -5242,7 +5327,7 @@ shaka.transmuxer.MssTransmuxer = class {
   /**
    * @override
    */
-  getOrginalMimeType() {}
+  getOriginalMimeType() {}
   /**
    * @override
    */
@@ -5275,7 +5360,7 @@ shaka.transmuxer.TsTransmuxer = class {
   /**
    * @override
    */
-  getOrginalMimeType() {}
+  getOriginalMimeType() {}
   /**
    * @override
    */