shaka-player 4.2.3 → 4.3.0

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

@@ -20,10 +20,14 @@ shaka.ads = {};
 /** @const */
 shaka.cast = {};
 /** @const */
+shaka.config = {};
+/** @const */
 shaka.dash = {};
 /** @const */
 shaka.hls = {};
 /** @const */
+shaka.lcevc = {};
+/** @const */
 shaka.media = {};
 /** @const */
 shaka.net = {};
@@ -213,6 +217,8 @@ 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,
   'EBML_OVERFLOW': 3002,
@@ -267,6 +273,7 @@ shaka.util.Error.Code = {
   'NO_WEB_CRYPTO_API': 4042,
   'HLS_AES_128_INVALID_IV_LENGTH': 4043,
   'HLS_AES_128_INVALID_KEY_LENGTH': 4044,
+  'CANNOT_ADD_EXTERNAL_THUMBNAILS_TO_LIVE_STREAM': 4045,
   'STREAMING_ENGINE_STARTUP_INVALID_STATE': 5006,
   'NO_RECOGNIZED_KEY_SYSTEMS': 6000,
   'REQUESTED_KEY_SYSTEM_CONFIG_UNAVAILABLE': 6001,
@@ -960,29 +967,6 @@ shaka.util.IDestroyable = class {
    */
   destroy() {}
 };
-/**
- */
-shaka.dependencies = class {
-  /**
-   * Registers a new dependency.
-   * @param {shaka.dependencies.Allowed} key which is used for retrieving a
-   *   dependency
-   * @param {?} dep a dependency
-   */
-  static add(key, dep) {}
-  /**
-   * Check if we have a dependency for the key.
-   * @param {shaka.dependencies.Allowed} key key
-   * @return {boolean}
-   */
-  static has(key) {}
-};
-/**
- * @enum {string}
- */
-shaka.dependencies.Allowed = {
-  muxjs: 'muxjs'
-};
 /**
  * A timer allows a single function to be executed at a later time or at
  * regular intervals.
@@ -1114,6 +1098,29 @@ shaka.util.Uint8ArrayUtils = class {
    */
   static concat(...varArgs) {}
 };
+/**
+ */
+shaka.dependencies = class {
+  /**
+   * Registers a new dependency.
+   * @param {shaka.dependencies.Allowed} key which is used for retrieving a
+   *   dependency
+   * @param {?} dep a dependency
+   */
+  static add(key, dep) {}
+  /**
+   * Check if we have a dependency for the key.
+   * @param {shaka.dependencies.Allowed} key key
+   * @return {boolean}
+   */
+  static has(key) {}
+};
+/**
+ * @enum {string}
+ */
+shaka.dependencies.Allowed = {
+  muxjs: 'muxjs'
+};
 /**
  * @summary A set of utility functions for dealing with MIME types.
  */
@@ -1219,6 +1226,15 @@ shaka.abr.SimpleAbrManager = class {
    */
   configure(config) {}
 };
+/**
+ * @enum {number}
+ */
+shaka.config.AutoShowText = {
+  'NEVER': 0,
+  'ALWAYS': 1,
+  'IF_PREFERRED_TEXT_LANGUAGE': 2,
+  'IF_SUBTITLES_MAY_BE_NEEDED': 3
+};
 /**
  * A utility to wrap abortable operations.  Note that these are not cancelable.
  * Cancelation implies undoing what has been done so far, whereas aborting only
@@ -1744,8 +1760,9 @@ shaka.media.InitSegmentReference = class {
    *   segment extends to the end of the resource.
    * @param {null|shaka.extern.MediaQualityInfo=} mediaQuality Information about
    *   the quality of the media associated with this init segment.
+   * @param {number=} timescale
    */
-  constructor(uris, startByte, endByte, mediaQuality) {}
+  constructor(uris, startByte, endByte, mediaQuality, timescale) {}
   /**
    * Returns the offset from the start of the resource to the
    * start of the segment.
@@ -1869,6 +1886,16 @@ shaka.media.SegmentReference = class {
    * Mark the reference as unavailable.
    */
   markAsUnavailable() {}
+  /**
+   * Set the segment's thumbnail sprite.
+   * @param {shaka.media.SegmentReference.ThumbnailSprite} thumbnailSprite
+   */
+  setThumbnailSprite(thumbnailSprite) {}
+  /**
+   * Returns the segment's thumbnail sprite.
+   * @return {?shaka.media.SegmentReference.ThumbnailSprite}
+   */
+  getThumbnailSprite() {}
 };
 /**
  * Rather than using booleans to communicate what the state of the reference,
@@ -1880,6 +1907,64 @@ shaka.media.SegmentReference.Status = {
   UNAVAILABLE: 1,
   MISSING: 2
 };
+/**
+ * @typedef {{
+ *   height: number,
+ *   positionX: number,
+ *   positionY: number,
+ *   width: number
+ * }}
+ * @property {number} height
+ *    The thumbnail height in px.
+ * @property {number} positionX
+ *    The thumbnail left position in px.
+ * @property {number} positionY
+ *    The thumbnail top position in px.
+ * @property {number} width
+ *    The thumbnail width in px.
+ */
+shaka.media.SegmentReference.ThumbnailSprite;
+/**
+ * @summary A set of Id3Utils utility functions.
+ */
+shaka.util.Id3Utils = class {
+  /**
+   * Returns an array of ID3 frames found in all the ID3 tags in the id3Data
+   * @param {Uint8Array} id3Data - The ID3 data containing one or more ID3 tags
+   * @return {!Array.<shaka.extern.MetadataFrame>}
+   */
+  static getID3Frames(id3Data) {}
+};
+/**
+ * @see https://en.wikipedia.org/wiki/MPEG_transport_stream
+ */
+shaka.util.TsParser = class {
+  /** */
+  constructor() {}
+};
+/**
+ * @summary
+ *  lcevcDil - (MPEG-5 Part 2 LCEVC - Decoder Integration Layer) provides
+ *  all the operations related to the enhancement and rendering
+ *  of LCEVC enabled streams and on to a canvas.
+ * @implements {shaka.util.IReleasable}
+ */
+shaka.lcevc.Dil = class {
+  /**
+   * @param {HTMLVideoElement} media The video element that will be attached to
+   * LCEVC Dil for input.
+   * @param {HTMLCanvasElement} canvas The canvas element that will be attached
+   * to LCEVC Dil to render the enhanced frames.
+   * @param {shaka.extern.LcevcConfiguration} dilConfig The LCEVC DIL
+   * config object to initialize the LCEVC DIL.
+   */
+  constructor(media, canvas, dilConfig) {}
+  /**
+   * Close LCEVC Dil.
+   * @override
+   */
+  release() {}
+};
 /**
  * PresentationTimeline.
  */
@@ -1904,6 +1989,12 @@ shaka.media.PresentationTimeline = class {
    * @return {number} The presentation's max segment duration in seconds.
    */
   getMaxSegmentDuration() {}
+  /**
+   * Sets the presentation's start time.
+   * @param {number} presentationStartTime The wall-clock time, in seconds,
+   *   when the presentation started or will start. Only required for live.
+   */
+  setPresentationStartTime(presentationStartTime) {}
   /**
    * Sets the presentation's duration.
    * @param {number} duration The presentation's duration in seconds.
@@ -1945,10 +2036,10 @@ shaka.media.PresentationTimeline = class {
    */
   getDelay() {}
   /**
-   * Gives PresentationTimeline a Stream's segments so it can size and position
+   * Gives PresentationTimeline an array of segments so it can size and position
    * the segment availability window, and account for missing segment
-   * information.  This function should be called once for each Stream (no more,
-   * no less).
+   * information.  These segments do not necessarily need to all be from the
+   * same stream.
    * @param {!Array.<!shaka.media.SegmentReference>} references
    */
   notifySegments(references) {}
@@ -2451,6 +2542,12 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * @return {!Promise}
    */
   attach(mediaElement, initializeMediaSource) {}
+  /**
+   * Calling <code>attachCanvas</code> will tell the player to set canvas
+   * element for LCEVC decoding.
+   * @param {HTMLCanvasElement} canvas
+   */
+  attachCanvas(canvas) {}
   /**
    * Tell the player to stop using its current media element. If the player is:
    * <ul>
@@ -2765,12 +2862,13 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
   getTextLanguages() {}
   /**
    * Sets the current audio language and current variant role to the selected
-   * language and role, and chooses a new variant if need be. If the player has
-   * not loaded any content, this will be a no-op.
+   * language, role and channel count, and chooses a new variant if need be.
+   * If the player has not loaded any content, this will be a no-op.
    * @param {string} language
    * @param {string=} role
+   * @param {number=} channelsCount
    */
-  selectAudioLanguage(language, role) {}
+  selectAudioLanguage(language, role, channelsCount) {}
   /**
    * 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
@@ -2851,6 +2949,17 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * @return {!Promise.<shaka.extern.Track>}
    */
   addTextTrackAsync(uri, language, kind, mimeType, codec, label, forced) {}
+  /**
+   * Adds the given thumbnails track to the loaded manifest.
+   * <code>load()</code> must resolve before calling.  The presentation must
+   * have a duration.
+   * This returns the created track, which can immediately be used by the
+   * application.
+   * @param {string} uri
+   * @param {string=} mimeType
+   * @return {!Promise.<shaka.extern.Track>}
+   */
+  addThumbnailsTrack(uri, mimeType) {}
   /**
    * Adds the given chapters track to the loaded manifest.  <code>load()</code>
    * must resolve before calling.  The presentation must have a duration.
@@ -2879,9 +2988,10 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * <p>
    * If the player has loaded content, and streaming seen an error, but the
    * could not resume streaming, this will return <code>false</code>.
+   * @param {number=} retryDelaySeconds
    * @return {boolean}
    */
-  retryStreaming() {}
+  retryStreaming(retryDelaySeconds) {}
   /**
    * Get the manifest that the player has loaded. If the player has not loaded
    * any content, this will return <code>null</code>.
@@ -3008,6 +3118,14 @@ shaka.ads.ClientSideAd = class {
    * @override
    */
   getPositionInSequence() {}
+  /**
+   * @override
+   */
+  getTitle() {}
+  /**
+   * @override
+   */
+  getDescription() {}
   /**
    * @override
    */
@@ -3094,6 +3212,14 @@ shaka.ads.ServerSideAd = class {
    * @override
    */
   getPositionInSequence() {}
+  /**
+   * @override
+   */
+  getTitle() {}
+  /**
+   * @override
+   */
+  getDescription() {}
   /**
    * @override
    */
@@ -3848,8 +3974,13 @@ shaka.polyfill.Orientation = class {
 shaka.polyfill.PatchedMediaKeysApple = class {
   /**
    * Installs the polyfill if needed.
+   * @param {boolean} enableUninstall enables uninstalling the polyfill
    */
-  static install() {}
+  static install(enableUninstall) {}
+  /**
+   * Uninstalls the polyfill if needed and enabled.
+   */
+  static uninstall() {}
 };
 /**
  * @summary A polyfill to stub out