shaka-player 4.4.3 → 4.6.0

package/externs/lcevc.js

@@ -1,25 +1,27 @@
 /**
-* @fileoverview Externs for LcevcDil
+* @fileoverview Externs for LcevcDec
 * compiler.
 *
 * @externs
 */
 
-// This empty namespace is declared to check if LcevcDil libraries are loaded.
+// This empty namespace is declared to check if LcevcDec libraries are loaded.
+/** @const */
 var libDPIModule = {};
-var LcevcDil = {};
+/** @const */
+var LCEVCdec = {};
 
 /**
-* LCEVC DIL constructor
+* LCEVC Dec constructor
 * @constructor
 */
-LcevcDil.LcevcDIL = class {
+LCEVCdec.LCEVCdec = class {
   /**
    * @param {HTMLVideoElement} media
    * @param {HTMLCanvasElement} canvas
-   * @param {shaka.extern.LcevcConfiguration} dilConfig
+   * @param {shaka.extern.LcevcConfiguration} lcevcConfig
    */
-  constructor(media, canvas, dilConfig) {
+  constructor(media, canvas, lcevcConfig) {
   }
 
   /**
@@ -30,13 +32,14 @@ LcevcDil.LcevcDIL = class {
    * @param {!BufferSource} data Video Buffer Data.
    * @param {string} type Type of Video Buffer Data.
    * @param {number} variantId Variant that the fragment belongs to.
+   * @param {number} timestampOffset Timestamp offset for appended segments
    */
-  appendBuffer(data, type, variantId) {}
+  appendBuffer(data, type, variantId, timestampOffset) {}
 
   /**
    * Set current variant as variantId to the LCEVC decoder
    * @param {!number} variantId
-   * @param {!boolean} autoBufferSwitch is lcevcDil mode that switches variant
+   * @param {!boolean} autoBufferSwitch is lcevcDec mode that switches variant
    * when the downloaded buffer from last variant has finished playing and
    * buffers from the new variant starts to play.
    */
@@ -49,15 +52,28 @@ LcevcDil.LcevcDIL = class {
   setContainerFormat(containerFormat) {}
 
   /**
-   * Close LCEVC DIL
+   * Set streaming Format for LCEVC Data Parsing.
+   * @param {!number} streamingFormat container type of the stream.
+   */
+  setStreamingFormat(streamingFormat) {}
+
+  /**
+   * Close LCEVC DEC
    */
   close() {}
 };
 
+/**
+ * The older module interface, for backward compatibility.
+ * Typed to the same interface, but under a different name.
+ * @type {typeof LCEVCdec.LCEVCdec}
+ */
+LCEVCdec.LcevcDil;
+
 /**
  * LCEVC Support Check
  */
-LcevcDil.SupportObject = {
+LCEVCdec.SupportObject = {
 
   /**
    * Check if canvas has WebGL support
@@ -72,10 +88,18 @@ LcevcDil.SupportObject = {
  * LCEVC Support Checklist Result
  * @type {boolean}
  */
-LcevcDil.SupportObject.SupportStatus;
+LCEVCdec.SupportObject.SupportStatus;
 
 /**
  * LCEVC Support CheckList Error if any.
  * @type {string}
  */
-LcevcDil.SupportObject.SupportError;
+LCEVCdec.SupportObject.SupportError;
+
+/**
+ * Typedef for the module interface.  Both LCEVCdec (new module) and LcevcDil
+ * (old module) implement roughly the same interface.
+ *
+ * @typedef {typeof LCEVCdec}
+ */
+var LCEVCmodule;

package/externs/managedmediasource.js

@@ -0,0 +1,24 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Externs for ManagedMediaSource which were missing in the
+ * Closure compiler.
+ *
+ * @externs
+ */
+
+/**
+ * @constructor
+ * @extends {MediaSource}
+ */
+function ManagedMediaSource() {}
+
+/**
+ * @param {string} type
+ * @return {boolean}
+ */
+ManagedMediaSource.isTypeSupported = function(type) {};

package/externs/media_remote.js

@@ -0,0 +1,68 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Externs for HTMLMediaElement which were missing in the
+ * Closure compiler.
+ *
+ * @externs
+ */
+
+
+/**
+ * @constructor
+ * @implements {EventTarget}
+ */
+function RemotePlayback() {}
+
+
+/**
+ * Represents the RemotePlayback connection's state.
+ * @type {string}
+ */
+RemotePlayback.prototype.state;
+
+
+/**
+ * The watchAvailability() method of the RemotePlayback interface watches
+ * the list of available remote playback devices and returns a Promise that
+ * resolves with the callbackId of a remote playback device.
+ *
+ * @param {!function(boolean)} callback
+ * @return {!Promise}
+ */
+RemotePlayback.prototype.watchAvailability = function(callback) {};
+
+
+/**
+ * The cancelWatchAvailability() method of the RemotePlayback interface
+ * cancels the request to watch for one or all available devices.
+ *
+ * @param {number} id
+ * @return {!Promise}
+ */
+RemotePlayback.prototype.cancelWatchAvailability = function(id) {};
+
+
+/**
+ * The prompt() method of the RemotePlayback interface prompts the user
+ * to select an available remote playback device and give permission
+ * for the current media to be played using that device.
+ *
+ * If the user gives permission, the state will be set to connecting and
+ * the user agent will connect to the device to initiate playback.
+ *
+ * If the user chooses to instead disconnect from the device, the state will
+ * be set to disconnected and user agent will disconnect from this device.
+ *
+ * @return {!Promise}
+ */
+RemotePlayback.prototype.prompt = function() {};
+
+
+/** @type {RemotePlayback} */
+HTMLMediaElement.prototype.remote;
+

package/externs/mediatailor.js

@@ -0,0 +1,193 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Externs for Media Tailor.
+ * @externs
+ */
+
+
+/** @const */
+var mediaTailor = {};
+
+
+/**
+ * @typedef {{
+ *   manifestUrl: ?string,
+ *   trackingUrl: ?string
+ * }}
+ *
+ * @property {?string} manifestUrl
+ * @property {?string} trackingUrl
+ * @exportDoc
+ */
+mediaTailor.SessionResponse;
+
+
+/**
+ * @typedef {{
+ *   avails: !Array.<mediaTailor.AdBreak>
+ * }}
+ *
+ * @property {!Array.<mediaTailor.AdBreak>} avails
+ * @exportDoc
+ */
+mediaTailor.TrackingResponse;
+
+
+/**
+ * @typedef {{
+ *   adBreakTrackingEvents: !Array.<mediaTailor.TrackingEvent>,
+ *   ads: !Array.<mediaTailor.Ad>,
+ *   durationInSeconds: number,
+ *   nonLinearAdsList: !Array.<mediaTailor.Ad>,
+ *   startTimeInSeconds: number
+ * }}
+ *
+ * @property {!Array.<mediaTailor.TrackingEvent>} adBreakTrackingEvents
+ * @property {!Array.<mediaTailor.Ad>} ads
+ * @property {number} durationInSeconds
+ * @property {!Array.<mediaTailor.Ad>} nonLinearAdsList
+ * @property {number} startTimeInSeconds
+ * @exportDoc
+ */
+mediaTailor.AdBreak;
+
+
+/**
+ * @typedef {{
+ *   adId: string,
+ *   adParameters: string,
+ *   adSystem: string,
+ *   adTitle: string,
+ *   creativeId: string,
+ *   creativeSequence: string,
+ *   durationInSeconds: number,
+ *   skipOffset: ?number,
+ *   startTimeInSeconds: number,
+ *   nonLinearAdList: !Array.<mediaTailor.NonLinearAd>,
+ *   trackingEvents: !Array.<mediaTailor.TrackingEvent>
+ * }}
+ *
+ * @property {string} adId
+ * @property {string} adParameters
+ * @property {string} adSystem
+ * @property {string} adTitle
+ * @property {string} creativeId
+ * @property {string} creativeSequence
+ * @property {number} durationInSeconds
+ * @property {?number} skipOffset
+ * @property {number} startTimeInSeconds
+ * @property {!Array.<mediaTailor.NonLinearAd>} nonLinearAdList
+ * @property {!Array.<mediaTailor.TrackingEvent>} trackingEvents
+ * @exportDoc
+ */
+mediaTailor.Ad;
+
+
+/**
+ * @typedef {{
+ *   adId: string,
+ *   adParameters: string,
+ *   adSystem: string,
+ *   adTitle: string,
+ *   creativeAdId: string,
+ *   creativeId: string,
+ *   creativeSequence: string,
+ *   height: ?number,
+ *   width: ?number,
+ *   staticResource: string
+ * }}
+ *
+ * @property {string} adId
+ * @property {string} adParameters
+ * @property {string} adSystem
+ * @property {string} adTitle
+ * @property {string} creativeAdId
+ * @property {string} creativeId
+ * @property {string} creativeSequence
+ * @property {?number} height
+ * @property {?number} width
+ * @property {string} staticResource
+ * @exportDoc
+ */
+mediaTailor.NonLinearAd;
+
+
+/**
+ * @typedef {{
+ *   beaconUrls: !Array.<string>,
+ *   eventType: string
+ * }}
+ *
+ * @property {!Array.<string>} beaconUrls
+ * @property {string} eventType
+ * @exportDoc
+ */
+mediaTailor.TrackingEvent;
+
+
+/** @const */
+var mediaTailorExternalResource = {};
+
+
+/**
+ * @typedef {{
+ *   apps: !Array.<mediaTailorExternalResource.App>
+ * }}
+ *
+ * @property {!Array.<mediaTailorExternalResource.App>} apps
+ * @exportDoc
+ */
+mediaTailorExternalResource.Response;
+
+
+/**
+ * @typedef {{
+ *   placeholder: mediaTailorExternalResource.AppPlaceholder,
+ *   data: mediaTailorExternalResource.AppData
+ * }}
+ *
+ * @property {mediaTailorExternalResource.AppPlaceholder} placeholder
+ * @property {mediaTailorExternalResource.AppData} data
+ * @exportDoc
+ */
+mediaTailorExternalResource.App;
+
+
+/**
+ * @typedef {{
+ *   left: number,
+ *   top: number
+ * }}
+ *
+ * @property {number} left
+ * @property {number} top
+ * @exportDoc
+ */
+mediaTailorExternalResource.AppPlaceholder;
+
+
+/**
+ * @typedef {{
+ *   source: !Array.<mediaTailorExternalResource.AppDataSource>
+ * }}
+ *
+ * @property {!Array.<mediaTailorExternalResource.AppDataSource>} source
+ * @exportDoc
+ */
+mediaTailorExternalResource.AppData;
+
+
+/**
+ * @typedef {{
+ *   url: string
+ * }}
+ *
+ * @property {string} url
+ * @exportDoc
+ */
+mediaTailorExternalResource.AppDataSource;

package/externs/pictureinpicture.js

@@ -97,3 +97,14 @@ DocumentPictureInPicture.prototype.dispatchEvent = function(event) {};
  * @type {!DocumentPictureInPicture}
  */
 Window.prototype.documentPictureInPicture;
+
+
+/**
+ * @constructor
+ * @extends {Event}
+ */
+function DocumentPictureInPictureEvent() {}
+
+
+/** @type {Window} */
+DocumentPictureInPictureEvent.prototype.window;

package/externs/shaka/abr_manager.js

@@ -60,10 +60,12 @@ shaka.extern.AbrManager = class {
 
   /**
    * Chooses one variant to switch to.  Called by the Player.
+   * @param {boolean=} preferFastSwitching If not provided meant "avoid fast
+   *                                       switching if possible".
    * @return {shaka.extern.Variant}
    * @exportDoc
    */
-  chooseVariant() {}
+  chooseVariant(preferFastSwitching) {}
 
   /**
    * Enables automatic Variant choices from the last ones passed to setVariants.
@@ -88,9 +90,11 @@ shaka.extern.AbrManager = class {
    * @param {number} deltaTimeMs The duration, in milliseconds, that the request
    *     took to complete.
    * @param {number} numBytes The total number of bytes transferred.
+   * @param {boolean} allowSwitch Indicate if the segment is allowed to switch
+   *     to another stream.
    * @exportDoc
    */
-  segmentDownloaded(deltaTimeMs, numBytes) {}
+  segmentDownloaded(deltaTimeMs, numBytes, allowSwitch) {}
 
   /**
    * Gets an estimate of the current bandwidth in bit/sec.  This is used by the

package/externs/shaka/ads.js

@@ -94,6 +94,21 @@ shaka.extern.IAdManager = class extends EventTarget {
    */
   updateClientSideAdsRenderingSettings(adsRenderingSettings) {}
 
+  /**
+   * @param {!HTMLElement} adContainer
+   * @param {!shaka.net.NetworkingEngine} networkingEngine
+   * @param {!HTMLMediaElement} video
+   */
+  initMediaTailor(adContainer, networkingEngine, video) {}
+
+  /**
+   * @param {string} url
+   * @param {Object} adsParams
+   * @param {string=} backupUrl
+   * @return {!Promise.<string>}
+   */
+  requestMediaTailorStream(url, adsParams, backupUrl) {}
+
   /**
    * @param {!HTMLElement} adContainer
    * @param {!HTMLMediaElement} video
@@ -117,6 +132,11 @@ shaka.extern.IAdManager = class extends EventTarget {
    */
   getServerSideCuePoints() {}
 
+  /**
+   * @return {!Array.<!shaka.extern.AdCuePoint>}
+   */
+  getCuePoints() {}
+
   /**
    * Get statistics for the current playback session. If the player is not
    * playing content, this will return an empty stats object.
@@ -128,6 +148,13 @@ shaka.extern.IAdManager = class extends EventTarget {
    */
   onDashTimedMetadata(region) {}
 
+  /**
+   * Fired when the manifest is updated.
+   *
+   * @param {boolean} isLive
+   */
+  onManifestUpdated(isLive) {}
+
   /**
    * @param {shaka.extern.ID3Metadata} metadata
    * @param {number} timestampOffset

package/externs/shaka/cea.js

@@ -84,6 +84,13 @@ shaka.extern.ICaptionDecoder = class {
    * @exportDoc
    */
   clear() {}
+
+  /**
+   * Returns the streams that the CEA decoder found.
+   * @return {!Array.<string>}
+   * @exportDoc
+   */
+  getStreams() {}
 };
 
 /**

package/externs/shaka/codecs.js

@@ -1,16 +1,18 @@
 /**
  * @typedef {{
- *   data: Uint8Array,
+ *   data: !Uint8Array,
  *   packetLength: number,
  *   pts: ?number,
- *   dts: ?number
+ *   dts: ?number,
+ *   nalus: !Array.<!shaka.extern.VideoNalu>
  * }}
  *
  * @summary MPEG_PES.
- * @property {Uint8Array} data
+ * @property {!Uint8Array} data
  * @property {number} packetLength
  * @property {?number} pts
  * @property {?number} dts
+ * @property {!Array.<!shaka.extern.VideoNalu>} nalus
  */
 shaka.extern.MPEG_PES;
 

package/externs/shaka/manifest.js

@@ -152,18 +152,26 @@ shaka.extern.InitDataOverride;
 /**
  * @typedef {{
  *   maxLatency: ?number,
- *   maxPlaybackRate: ?number
+ *   maxPlaybackRate: ?number,
+ *   minLatency: ?number,
+ *   minPlaybackRate: ?number
  * }}
  *
  * @description
- * Maximum latency and playback rate for a manifest. When max latency is reached
- * playbackrate is updated to maxPlaybackRate to decrease latency.
+ * Maximum and minimun latency and playback rate for a manifest. When max
+ * latency is reached playbackrate is updated to maxPlaybackRate to decrease
+ * latency. When min  latency is reached playbackrate is updated to
+ * minPlaybackRate to increase  latency.
  * More information {@link https://dashif.org/docs/CR-Low-Latency-Live-r8.pdf here}.
  *
  * @property {?number} maxLatency
  *  Maximum latency in seconds.
  * @property {?number} maxPlaybackRate
  *  Maximum playback rate.
+ * @property {?number} minLatency
+ *  Minimun latency in seconds.
+ * @property {?number} minPlaybackRate
+ *  Minimun playback rate.
  *
  * @exportDoc
  */
@@ -318,10 +326,10 @@ shaka.extern.CreateSegmentIndexFunction;
  * }}
  *
  * @description
- * AES-128 key and iv info from the HLS manifest.
+ * AES-128 key and iv info from the manifest.
  *
  * @property {string} method
- *   The key method defined in the HLS manifest.
+ *   The key method defined in the manifest.
  * @property {webCrypto.CryptoKey|undefined} cryptoKey
  *   Web crypto key object of the AES-128 CBC key. If unset, the "fetchKey"
  *   property should be provided.
@@ -330,15 +338,15 @@ shaka.extern.CreateSegmentIndexFunction;
  *   Should be provided if the "cryptoKey" property is unset.
  *   Should update this object in-place, to set "cryptoKey".
  * @property {(!Uint8Array|undefined)} iv
- *   The IV in the HLS manifest, if defined. See HLS RFC 8216 Section 5.2 for
- *   handling undefined IV.
+ *   The IV in the manifest, if defined. For HLS see HLS RFC 8216 Section 5.2
+ *   for handling undefined IV.
  * @property {number} firstMediaSequenceNumber
  *   The starting Media Sequence Number of the playlist, used when IV is
  *   undefined.
  *
  * @exportDoc
  */
-shaka.extern.HlsAes128Key;
+shaka.extern.aes128Key;
 
 
 /**
@@ -355,6 +363,7 @@ shaka.extern.FetchCryptoKeysFunction;
  * @typedef {{
  *   id: number,
  *   originalId: ?string,
+ *   groupId: ?string,
  *   createSegmentIndex: shaka.extern.CreateSegmentIndexFunction,
  *   closeSegmentIndex: (function()|undefined),
  *   segmentIndex: shaka.media.SegmentIndex,
@@ -363,6 +372,7 @@ shaka.extern.FetchCryptoKeysFunction;
  *   frameRate: (number|undefined),
  *   pixelAspectRatio: (string|undefined),
  *   hdr: (string|undefined),
+ *   videoLayout: (string|undefined),
  *   bandwidth: (number|undefined),
  *   width: (number|undefined),
  *   height: (number|undefined),
@@ -389,7 +399,8 @@ shaka.extern.FetchCryptoKeysFunction;
  *      (!Array.<shaka.extern.Stream>|!Array.<shaka.extern.StreamDB>|
  *      undefined),
  *   mssPrivateData: (shaka.extern.MssPrivateData|undefined),
- *   external: boolean
+ *   external: boolean,
+ *   fastSwitching: boolean
  * }}
  *
  * @description
@@ -403,6 +414,10 @@ shaka.extern.FetchCryptoKeysFunction;
  *   The original ID, if any, that appeared in the manifest.  For example, in
  *   DASH, this is the "id" attribute of the Representation element.  In HLS,
  *   this is the "NAME" attribute.
+ * @property {?string} groupId
+ *   <i>Optional.</i> <br>
+ *   The ID of the stream's parent element. In DASH, this will be a unique
+ *   ID that represents the representation's parent adaptation element
  * @property {shaka.extern.CreateSegmentIndexFunction} createSegmentIndex
  *   <i>Required.</i> <br>
  *   Creates the Stream's segmentIndex (asynchronously).
@@ -429,6 +444,9 @@ shaka.extern.FetchCryptoKeysFunction;
  * @property {(string|undefined)} hdr
  *   <i>Video streams only.</i> <br>
  *   The Stream's HDR info
+ * @property {(string|undefined)} videoLayout
+ *   <i>Video streams only.</i> <br>
+ *   The Stream's video layout info.
  * @property {(number|undefined)} bandwidth
  *   <i>Audio and video streams only.</i> <br>
  *   The stream's required bandwidth in bits per second.
@@ -498,7 +516,8 @@ shaka.extern.FetchCryptoKeysFunction;
  *   A map containing the description of closed captions, with the caption
  *   channel number (CC1 | CC2 | CC3 | CC4) as the key and the language code
  *   as the value. If the channel number is not provided by the description,
- *   we'll set an 0-based index as the key.
+ *   we'll set a 0-based index as the key. If the language code is not
+ *   provided by the description we'll set the same value as channel number.
  *   Example: {'CC1': 'eng'; 'CC3': 'swe'}, or {'1', 'eng'; '2': 'swe'}, etc.
  * @property {(string|undefined)} tilesLayout
  *   <i>Image streams only.</i> <br>
@@ -514,6 +533,8 @@ shaka.extern.FetchCryptoKeysFunction;
  * @property {boolean} external
  *   Indicate if the stream was added externally.
  *   Eg: external text tracks.
+ * @property {boolean} fastSwitching
+ *   Indicate if the stream should be used for fast switching.
  *
  * @exportDoc
  */

package/externs/shaka/manifest_parser.js

@@ -94,6 +94,23 @@ shaka.extern.ManifestParser = class {
    * @exportDoc
    */
   onExpirationUpdated(sessionId, expiration) {}
+
+  /**
+   * Tells the parser that the initial variant has been chosen.
+   *
+   * @param {shaka.extern.Variant} variant
+   * @exportDoc
+   */
+  onInitialVariantChosen(variant) {}
+
+  /**
+   * Tells the parser that a location should be banned. This is called on
+   * retry.
+   *
+   * @param {string} uri
+   * @exportDoc
+   */
+  banLocation(uri) {}
 };
 
 
@@ -109,7 +126,9 @@ shaka.extern.ManifestParser = class {
  *   isAutoLowLatencyMode: function():boolean,
  *   enableLowLatencyMode: function(),
  *   updateDuration: function(),
- *   newDrmInfo: function(shaka.extern.Stream)
+ *   newDrmInfo: function(shaka.extern.Stream),
+ *   onManifestUpdated: function(),
+ *   getBandwidthEstimate: function():number
  * }}
  *
  * @description
@@ -144,6 +163,10 @@ shaka.extern.ManifestParser = class {
  * @property {function(shaka.extern.Stream)} newDrmInfo
  *   Inform the player of new DRM info that needs to be processed for the given
  *   stream.
+ * @property {function()} onManifestUpdated
+ *   Should be called when the manifest is updated.
+ * @property {function():number} getBandwidthEstimate
+ *   Get the estimated bandwidth in bits per second.
  * @exportDoc
  */
 shaka.extern.ManifestParser.PlayerInterface;