shaka-player 3.3.2 → 4.0.0

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

@@ -248,14 +248,12 @@ shaka.util.Error.Code = {
   'HLS_INVALID_PLAYLIST_HIERARCHY': 4017,
   'DASH_DUPLICATE_REPRESENTATION_ID': 4018,
   'HLS_MULTIPLE_MEDIA_INIT_SECTIONS_FOUND': 4020,
-  'HLS_MASTER_PLAYLIST_NOT_PROVIDED': 4022,
   'HLS_REQUIRED_ATTRIBUTE_MISSING': 4023,
   'HLS_REQUIRED_TAG_MISSING': 4024,
   'HLS_COULD_NOT_GUESS_CODECS': 4025,
   'HLS_KEYFORMATS_NOT_SUPPORTED': 4026,
   'DASH_UNSUPPORTED_XLINK_ACTUATE': 4027,
   'DASH_XLINK_DEPTH_LIMIT': 4028,
-  'HLS_COULD_NOT_PARSE_SEGMENT_START_TIME': 4030,
   'CONTENT_UNSUPPORTED_BY_BROWSER': 4032,
   'CANNOT_ADD_EXTERNAL_TEXT_TO_LIVE_STREAM': 4033,
   'HLS_AES_128_ENCRYPTION_NOT_SUPPORTED': 4034,
@@ -264,6 +262,7 @@ shaka.util.Error.Code = {
   'PERIOD_FLATTENING_FAILED': 4037,
   'INCONSISTENT_DRM_ACROSS_PERIODS': 4038,
   'HLS_VARIABLE_NOT_FOUND': 4039,
+  'HLS_MSE_ENCRYPTED_MP2T_NOT_SUPPORTED': 4040,
   'STREAMING_ENGINE_STARTUP_INVALID_STATE': 5006,
   'NO_RECOGNIZED_KEY_SYSTEMS': 6000,
   'REQUESTED_KEY_SYSTEM_CONFIG_UNAVAILABLE': 6001,
@@ -711,10 +710,6 @@ shaka.text.Cue.prototype.isContainer;
      * @override
      */
 shaka.text.Cue.prototype.lineBreak;
-/**
-     * @override
-     */
-shaka.text.Cue.prototype.spacer;
 /**
      * @override
      */
@@ -1031,14 +1026,6 @@ shaka.util.StringUtils = class {
  * @summary A set of Uint8Array utility functions.
  */
 shaka.util.Uint8ArrayUtils = class {
-  /**
-   * Compare two Uint8Arrays for equality.
-   * @param {Uint8Array} arr1
-   * @param {Uint8Array} arr2
-   * @return {boolean}
-   * @deprecated
-   */
-  static equal(arr1, arr2) {}
   /**
    * Convert a buffer to a base64 string. The output will be standard
    * alphabet as opposed to base64url safe alphabet.
@@ -1081,6 +1068,19 @@ shaka.util.Uint8ArrayUtils = class {
    */
   static concat(...varArgs) {}
 };
+/**
+ * @summary A set of utility functions for dealing with MIME types.
+ */
+shaka.util.MimeUtils = class {
+  /**
+   * Takes a MIME type and optional codecs string and produces the full MIME
+   * type.
+   * @param {string} mimeType
+   * @param {string=} codecs
+   * @return {string}
+   */
+  static getFullType(mimeType, codecs) {}
+};
 /**
  * @summary Manages text parsers and cues.
  * @implements {shaka.util.IDestroyable}
@@ -1521,35 +1521,6 @@ shaka.util.EventManager = class {
  * @typedef {function(!Event)}
  */
 shaka.util.EventManager.ListenerType;
-/**
- * @summary A set of FairPlay utility functions.
- */
-shaka.util.FairPlayUtils = class {
-  /**
-   * Using the default method, extract a content ID from the init data.  This is
-   * based on the FairPlay example documentation.
-   * @param {!BufferSource} initData
-   * @return {string}
-   */
-  static defaultGetContentId(initData) {}
-  /**
-   * Transforms the init data buffer using the given data.  The format is:
-   * <pre>
-   * [4 bytes] initDataSize
-   * [initDataSize bytes] initData
-   * [4 bytes] contentIdSize
-   * [contentIdSize bytes] contentId
-   * [4 bytes] certSize
-   * [certSize bytes] cert
-   * </pre>
-   * @param {!BufferSource} initData
-   * @param {!BufferSource|string} contentId
-   * @param {?BufferSource} cert  The server certificate; this will throw if not
-   *   provided.
-   * @return {!Uint8Array}
-   */
-  static initDataTransform(initData, contentId, cert) {}
-};
 /**
  * @summary An interface to register manifest parsers.
  */
@@ -1825,8 +1796,14 @@ shaka.media.SegmentReference = class {
    *  The explicit duration of an individual tile within the tiles grid.
    *  If not provided, the duration should be automatically calculated based on
    *  the duration of the reference.
+   * @param {?number=} syncTime
+   *  A time value, expressed in the same scale as the start and end time, which
+   *  is used to synchronize between streams.
+   * @param {shaka.media.SegmentReference.Status=} status
+   *  The segment status is used to indicate that a segment does not exist or is
+   *  not available.
    */
-  constructor(startTime, endTime, uris, startByte, endByte, initSegmentReference, timestampOffset, appendWindowStart, appendWindowEnd, partialReferences, tilesLayout, tileDuration) {}
+  constructor(startTime, endTime, uris, startByte, endByte, initSegmentReference, timestampOffset, appendWindowStart, appendWindowEnd, partialReferences, tilesLayout, tileDuration, syncTime, status) {}
   /**
    * Creates and returns the URIs of the resource containing the segment.
    * @return {!Array.<string>}
@@ -1866,6 +1843,25 @@ shaka.media.SegmentReference = class {
    * @return {?number}
    */
   getTileDuration() {}
+  /**
+   * Returns the segment's status.
+   * @return {shaka.media.SegmentReference.Status}
+   */
+  getStatus() {}
+  /**
+   * Mark the reference as unavailable.
+   */
+  markAsUnavailable() {}
+};
+/**
+ * Rather than using booleans to communicate what the state of the reference,
+ * we have this enum.
+ * @enum {number}
+ */
+shaka.media.SegmentReference.Status = {
+  AVAILABLE: 0,
+  UNAVAILABLE: 1,
+  MISSING: 2
 };
 /**
  * PresentationTimeline.
@@ -1986,8 +1982,9 @@ shaka.media.PresentationTimeline = class {
    * Gets the presentation's current segment availability end time.  Segments
    * starting after this time should be assumed to be unavailable.
    * @return {number} The current segment availability end time, in seconds,
-   *   relative to the start of the presentation.  Always returns the
-   *   presentation's duration for video-on-demand.
+   *   relative to the start of the presentation.  For VOD, the availability
+   *   end time is the content's duration.  If the Player's playRangeEnd
+   *   configuration is used, this can override the duration.
    */
   getSegmentAvailabilityEnd() {}
   /**
@@ -2040,13 +2037,6 @@ shaka.media.SegmentIndex = class {
    *   (ascending) and second by their end times (ascending).
    */
   constructor(references) {}
-  /**
-   * SegmentIndex used to be an IDestroyable.  Now it is an IReleasable.
-   * This method is provided for backward compatibility.
-   * @deprecated
-   * @return {!Promise}
-   */
-  destroy() {}
   /**
    * @override
    */
@@ -2081,20 +2071,6 @@ shaka.media.SegmentIndex = class {
    *   times.
    */
   offset(offset) {}
-  /**
-   * Merges the given SegmentReferences.  Supports extending the original
-   * references only.  Will replace old references with equivalent new ones, and
-   * keep any unique old ones.
-   * Used, for example, by the DASH and HLS parser, where manifests may not list
-   * all available references, so we must keep available references in memory to
-   * fill the availability window.
-   * @param {!Array.<!shaka.media.SegmentReference>} references The list of
-   *   SegmentReferences, which must be sorted first by their start times
-   *   (ascending) and second by their end times (ascending).
-   * @deprecated Not used directly by our own parsers, so will become private in
-   *   v4.  Use mergeAndEvict() instead.
-   */
-  merge(references) {}
   /**
    * Merges the given SegmentReferences and evicts the ones that end before the
    * given time.  Supports extending the original references only.
@@ -2163,13 +2139,6 @@ shaka.media.SegmentIterator = class {
    * @param {number} partialSegmentIndex
    */
   constructor(segmentIndex, index, partialSegmentIndex) {}
-  /**
-   * Move the iterator to a given timestamp in the underlying SegmentIndex.
-   * @param {number} time
-   * @return {shaka.media.SegmentReference}
-   * @deprecated Use SegmentIndex.getIteratorForTime instead
-   */
-  seek(time) {}
   /**
    * @return {shaka.media.SegmentReference}
    */
@@ -2369,6 +2338,10 @@ shaka.util.ConfigUtils = class {
  * @final
  */
 shaka.util.PlayerConfiguration = class {
+  /**
+   * @return {shaka.extern.PlayerConfiguration}
+   */
+  static createDefault() {}
   /**
    * Merges the given configuration changes into the given destination.  This
    * uses the default Player configurations as the template.
@@ -2831,21 +2804,6 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    * @return {shaka.extern.Stats}
    */
   getStats() {}
-  /**
-   * Adds the given text 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 selected by the
-   * application.  The track will not be automatically selected.
-   * @param {string} uri
-   * @param {string} language
-   * @param {string} kind
-   * @param {string=} mimeType
-   * @param {string=} codec
-   * @param {string=} label
-   * @param {boolean=} forced
-   * @return {shaka.extern.Track}
-   */
-  addTextTrack(uri, language, kind, mimeType, codec, label, forced) {}
   /**
    * Adds the given text track to the loaded manifest.  <code>load()</code> must
    * resolve before calling.  The presentation must have a duration.
@@ -2943,8 +2901,9 @@ shaka.ads.ClientSideAd = class {
   /**
    * @param {!google.ima.Ad} imaAd
    * @param {!google.ima.AdsManager} imaAdManager
+   * @param {HTMLMediaElement} video
    */
-  constructor(imaAd, imaAdManager) {}
+  constructor(imaAd, imaAdManager, video) {}
   /**
    * @override
    */
@@ -3721,12 +3680,6 @@ shaka.offline.Storage = class {
    *   AbortableOperation.
    */
   store(uri, appMetadata, mimeType) {}
-  /**
-   * Returns true if an asset is currently downloading.
-   * @return {boolean}
-   * @deprecated
-   */
-  getStoreInProgress() {}
   /**
    * Removes the given stored content.  This will also attempt to release the
    * licenses, if any.
@@ -3793,7 +3746,7 @@ shaka.polyfill.Aria = class {
  * @summary A polyfill to add support for EncryptionScheme queries in EME.
  * @see https://wicg.github.io/encrypted-media-encryption-scheme/
  * @see https://github.com/w3c/encrypted-media/pull/457
- * @see https://github.com/google/eme-encryption-scheme-polyfill
+ * @see https://github.com/shaka-project/eme-encryption-scheme-polyfill
  */
 shaka.polyfill.EncryptionScheme = class {
   /**
@@ -3814,16 +3767,6 @@ shaka.polyfill.Fullscreen = class {
    */
   static install() {}
 };
-/**
- * @summary A polyfill to patch math round bug on some browsers.
- * @see https://stackoverflow.com/q/12830742
- */
-shaka.polyfill.MathRound = class {
-  /**
-   * Install the polyfill if needed.
-   */
-  static install() {}
-};
 /**
  * @summary A polyfill to provide navigator.mediaCapabilities on all browsers.
  * This is necessary for Tizen 3, Xbox One and possibly others we have yet to
@@ -3863,28 +3806,6 @@ shaka.polyfill.Orientation = class {
    */
   static install() {}
 };
-/**
- * @summary A polyfill to implement modern, standardized EME on top of Apple's
- * prefixed EME in Safari.
- */
-shaka.polyfill.PatchedMediaKeysApple = class {
-  /**
-   * Installs the polyfill if needed.
-   */
-  static install() {}
-};
-/**
- * @summary A polyfill to implement
- * {@link https://bit.ly/EmeMar15 EME draft 12 March 2015}
- * on top of ms-prefixed
- * {@link https://www.w3.org/TR/2014/WD-encrypted-media-20140218/ EME v20140218}
- */
-shaka.polyfill.PatchedMediaKeysMs = class {
-  /**
-   * Installs the polyfill if needed.
-   */
-  static install() {}
-};
 /**
  * @summary A polyfill to stub out
  * {@link https://bit.ly/EmeMar15 EME draft 12 March 2015} on browsers without
@@ -3938,6 +3859,16 @@ shaka.polyfill.StorageEstimate = class {
    */
   static install() {}
 };
+/**
+ * @summary A polyfill to provide Symbol.prototype.description in all browsers.
+ * See: https://caniuse.com/mdn-javascript_builtins_symbol_description
+ */
+shaka.polyfill.Symbol = class {
+  /**
+   * Install the polyfill if needed.
+   */
+  static install() {}
+};
 /**
  * @summary A polyfill to silence the play() Promise in HTML5 video.
  */
@@ -3976,6 +3907,10 @@ shaka.text.LrcTextParser = class {
    * @override
    */
   parseInit(data) {}
+  /**
+   * @override
+   */
+  setSequenceMode(sequenceMode) {}
   /**
    * @override
    */
@@ -3989,6 +3924,10 @@ shaka.text.TtmlTextParser = class {
    * @override
    */
   parseInit(data) {}
+  /**
+   * @override
+   */
+  setSequenceMode(sequenceMode) {}
   /**
    * @override
    */
@@ -4004,6 +3943,10 @@ shaka.text.Mp4TtmlParser = class {
    * @override
    */
   parseInit(data) {}
+  /**
+   * @override
+   */
+  setSequenceMode(sequenceMode) {}
   /**
    * @override
    */
@@ -4013,10 +3956,16 @@ shaka.text.Mp4TtmlParser = class {
  * @implements {shaka.extern.TextParser}
  */
 shaka.text.VttTextParser = class {
+  /** Constructs a VTT parser. */
+  constructor() {}
   /**
    * @override
    */
   parseInit(data) {}
+  /**
+   * @override
+   */
+  setSequenceMode(sequenceMode) {}
   /**
    * @override
    */
@@ -4032,6 +3981,10 @@ shaka.text.Mp4VttParser = class {
    * @override
    */
   parseInit(data) {}
+  /**
+   * @override
+   */
+  setSequenceMode(sequenceMode) {}
   /**
    * @override
    */
@@ -4045,6 +3998,10 @@ shaka.text.SbvTextParser = class {
    * @override
    */
   parseInit(data) {}
+  /**
+   * @override
+   */
+  setSequenceMode(sequenceMode) {}
   /**
    * @override
    */
@@ -4060,6 +4017,10 @@ shaka.text.SrtTextParser = class {
    * @override
    */
   parseInit(data) {}
+  /**
+   * @override
+   */
+  setSequenceMode(sequenceMode) {}
   /**
    * @override
    */
@@ -4081,11 +4042,61 @@ shaka.text.SsaTextParser = class {
    * @override
    */
   parseInit(data) {}
+  /**
+   * @override
+   */
+  setSequenceMode(sequenceMode) {}
   /**
    * @override
    */
   parseMedia(data, time) {}
 };
+/**
+ * @summary A set of FairPlay utility functions.
+ */
+shaka.util.FairPlayUtils = class {
+  /**
+   * Check if FairPlay is supported.
+   * @return {!Promise.<boolean>}
+   */
+  static isFairPlaySupported() {}
+  /**
+   * Using the default method, extract a content ID from the init data.  This is
+   * based on the FairPlay example documentation.
+   * @param {!BufferSource} initData
+   * @return {string}
+   */
+  static defaultGetContentId(initData) {}
+  /**
+   * Transforms the init data buffer using the given data.  The format is:
+   * <pre>
+   * [4 bytes] initDataSize
+   * [initDataSize bytes] initData
+   * [4 bytes] contentIdSize
+   * [contentIdSize bytes] contentId
+   * [4 bytes] certSize
+   * [certSize bytes] cert
+   * </pre>
+   * @param {!BufferSource} initData
+   * @param {!BufferSource|string} contentId
+   * @param {?BufferSource} cert  The server certificate; this will throw if not
+   *   provided.
+   * @return {!Uint8Array}
+   */
+  static initDataTransform(initData, contentId, cert) {}
+  /**
+   * SPC FairPlay request.
+   * @param {shaka.net.NetworkingEngine.RequestType} type
+   * @param {shaka.extern.Request} request
+   */
+  static spcFairPlayRequest(type, request) {}
+  /**
+   * Common FairPlay response transform for some DRMs providers.
+   * @param {shaka.net.NetworkingEngine.RequestType} type
+   * @param {shaka.extern.Response} response
+   */
+  static commonFairPlayResponse(type, response) {}
+};
 /**
  * @implements {shaka.extern.IUIElement}
  * @abstract
@@ -4390,6 +4401,14 @@ shaka.ui.Controls = class extends shaka.util.FakeEventTarget {
   anySettingsMenusAreOpen() {}
   /**  */
   hideSettingsMenus() {}
+  /**
+   * @return {boolean}
+   */
+  isFullScreenSupported() {}
+  /**
+   * @return {boolean}
+   */
+  isFullScreenEnabled() {}
   /**  */
   toggleFullScreen() {}
   /**  */