shaka-player 2.5.1 → 2.5.5

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

@@ -59,7 +59,7 @@ shaka.util.Timer = class {
    */
   tickNow() {}
   /**
-   * Have the timer call |onTick| after |seconds| has elasped unless |stop| is
+   * Have the timer call |onTick| after |seconds| has elapsed unless |stop| is
    * called first.
    * @param {number} seconds
    * @return {!shaka.util.Timer}
@@ -216,6 +216,8 @@ shaka.util.Error.Code = {
   'NO_LICENSE_SERVER_GIVEN': 6012,
   'OFFLINE_SESSION_REMOVED': 6013,
   'EXPIRED': 6014,
+  'SERVER_CERTIFICATE_REQUIRED': 6015,
+  'INIT_DATA_TRANSFORM_ERROR': 6016,
   'LOAD_INTERRUPTED': 7000,
   'OPERATION_ABORTED': 7001,
   'NO_VIDEO_ELEMENT': 7002,
@@ -226,6 +228,7 @@ shaka.util.Error.Code = {
   'CAST_CANCELED_BY_USER': 8004,
   'CAST_CONNECTION_TIMED_OUT': 8005,
   'CAST_RECEIVER_APP_UNAVAILABLE': 8006,
+  'CAST_RECEIVER_APP_ID_MISSING': 8007,
   'STORAGE_NOT_SUPPORTED': 9000,
   'INDEXED_DB_ERROR': 9001,
   'DEPRECATED_OPERATION_ABORTED': 9002,
@@ -506,6 +509,99 @@ shaka.net.NetworkingEngine.PendingRequest = class extends shaka.util.AbortableOp
    */
   constructor(promise,onAbort,numBytesRemainingObj) {}
 };
+/**
+ * An interface to standardize how objects release internal references
+ * synchronously. If an object needs to asynchronously release references, then
+ * it should use 'shaka.util.IDestroyable'.
+ * @interface
+ */
+shaka.util.IReleasable = class {
+  /**
+   * Request that this object release all internal references.
+   */
+  release() {}
+};
+/**
+ * @summary
+ * An EventManager maintains a collection of "event
+ * bindings" between event targets and event listeners.
+ * @implements {shaka.util.IReleasable}
+ */
+shaka.util.EventManager = class {
+  constructor() {}
+  /**
+   * Detaches all event listeners.
+   * @override
+   */
+  release() {}
+  /**
+   * Attaches an event listener to an event target.
+   * @param {EventTarget} target The event target.
+   * @param {string} type The event type.
+   * @param {shaka.util.EventManager.ListenerType} listener The event listener.
+   * @param {(boolean|!AddEventListenerOptions)=} options An object that
+   *    specifies characteristics about the event listener.
+   *    The passive option, if true, indicates that this function will never
+   *    call preventDefault(), which improves scrolling performance.
+   */
+  listen(target,type,listener,options) {}
+  /**
+   * Attaches an event listener to an event target.  The listener will be
+   * removed when the first instance of the event is fired.
+   * @param {EventTarget} target The event target.
+   * @param {string} type The event type.
+   * @param {shaka.util.EventManager.ListenerType} listener The event listener.
+   * @param {(boolean|!AddEventListenerOptions)=} options An object that
+   *    specifies characteristics about the event listener.
+   *    The passive option, if true, indicates that this function will never
+   *    call preventDefault(), which improves scrolling performance.
+   */
+  listenOnce(target,type,listener,options) {}
+  /**
+   * Detaches an event listener from an event target.
+   * @param {EventTarget} target The event target.
+   * @param {string} type The event type.
+   * @param {shaka.util.EventManager.ListenerType=} listener The event listener.
+   */
+  unlisten(target,type,listener) {}
+  /**
+   * Detaches all event listeners from all targets.
+   */
+  removeAll() {}
+};
+/**
+ * @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) {}
+};
 /**
  * Creates a string from the given buffer as UTF-8 encoding.
  * @param {?BufferSource} data
@@ -992,6 +1088,10 @@ shaka.cast.CastProxy.prototype.setAppData = function(appData) {};
  * Show a dialog where user can choose to disconnect from the cast connection.
  */
 shaka.cast.CastProxy.prototype.suggestDisconnect = function() {};
+/**
+ * @param {string} newAppId
+ */
+shaka.cast.CastProxy.prototype.changeReceiverId = function(newAppId) {};
 /**
  * Force the receiver app to shut down by disconnecting.
  */
@@ -1005,7 +1105,10 @@ shaka.cast.CastProxy.prototype.forceDisconnect = function() {};
  *   local Player instance.
  * @param {!shaka.Player} player A local Player instance.
  * @param {function(Object)=} appDataCallback A callback to handle
- *   application-specific data passed from the sender.
+ *   application-specific data passed from the sender.  This can come either
+ *   from a Shaka-based sender through CastProxy.setAppData, or from a
+ *   sender using the customData field of the LOAD message of the standard
+ *   Cast message namespace.  It can also be null if no such data is sent.
   * @param {function(string):string=} contentIdCallback A callback to
  *   retrieve manifest URI from the provided content id.
  * @implements {shaka.util.IDestroyable}
@@ -1026,98 +1129,6 @@ shaka.cast.CastReceiver.prototype.isIdle = function() {};
  * @override
  */
 shaka.cast.CastReceiver.prototype.destroy = function() {};
-/**
- * Creates an InitSegmentReference, which provides the location to an
- * initialization segment.
- * @param {function():!Array.<string>} uris A function that creates the URIs of
- *   the resource containing the segment.
- * @param {number} startByte The offset from the start of the resource to the
- *   start of the segment.
- * @param {?number} endByte The offset from the start of the resource to the
- *   end of the segment, inclusive.  A value of null indicates that the segment
- *   extends to the end of the resource.
- * @constructor
- * @struct
- */
-shaka.media.InitSegmentReference = function(uris, startByte, endByte) {};
-/**
- * Creates the URIs of the resource containing the segment.
- * @return {!Array.<string>}
- */
-shaka.media.InitSegmentReference.prototype.createUris = function() {};
-/**
- * Returns the offset from the start of the resource to the
- * start of the segment.
- * @return {number}
- */
-shaka.media.InitSegmentReference.prototype.getStartByte = function() {};
-/**
- * Returns the offset from the start of the resource to the end of the segment,
- * inclusive.  A value of null indicates that the segment extends to the end of
- * the resource.
- * @return {?number}
- */
-shaka.media.InitSegmentReference.prototype.getEndByte = function() {};
-/**
- * Creates a SegmentReference, which provides the start time, end time, and
- * location to a media segment.
- * @param {number} position The segment's position within a particular Period.
- *   The following should hold true between any two SegmentReferences from the
- *   same Period, r1 and r2:
- *   IF r2.position > r1.position THEN
- *     [ (r2.startTime > r1.startTime) OR
- *       (r2.startTime == r1.startTime AND r2.endTime >= r1.endTime) ]
- * @param {number} startTime The segment's start time in seconds, relative to
- *   the start of a particular Period.
- * @param {number} endTime The segment's end time in seconds, relative to
- *   the start of a particular Period.  The segment ends the instant before
- *   this time, so |endTime| must be strictly greater than |startTime|.
- * @param {function():!Array.<string>} uris
- *   A function that creates the URIs of the resource containing the segment.
- * @param {number} startByte The offset from the start of the resource to the
- *   start of the segment.
- * @param {?number} endByte The offset from the start of the resource to the
- *   end of the segment, inclusive.  A value of null indicates that the segment
- *   extends to the end of the resource.
- * @constructor
- * @struct
- */
-shaka.media.SegmentReference = function(position, startTime, endTime, uris, startByte, endByte) {};
-/**
- * Returns the segment's position within a particular Period.
- * @return {number} The segment's position.
- */
-shaka.media.SegmentReference.prototype.getPosition = function() {};
-/**
- * Returns the segment's start time in seconds, relative to
- * the start of a particular Period.
- * @return {number}
- */
-shaka.media.SegmentReference.prototype.getStartTime = function() {};
-/**
- * Returns the segment's end time in seconds, relative to
- * the start of a particular Period.
- * @return {number}
- */
-shaka.media.SegmentReference.prototype.getEndTime = function() {};
-/**
- * Creates the URIs of the resource containing the segment.
- * @return {!Array.<string>}
- */
-shaka.media.SegmentReference.prototype.createUris = function() {};
-/**
- * Returns the offset from the start of the resource to the
- * start of the segment.
- * @return {number}
- */
-shaka.media.SegmentReference.prototype.getStartByte = function() {};
-/**
- * Returns the offset from the start of the resource to the end of the segment,
- * inclusive.  A value of null indicates that the segment extends to the end of
- * the resource.
- * @return {?number}
- */
-shaka.media.SegmentReference.prototype.getEndByte = function() {};
 /**
  * Creates a DataViewReader, which abstracts a DataView object.
  * @param {!DataView} dataView The DataView.
@@ -1286,6 +1297,98 @@ shaka.util.Mp4Parser.allData = function(callback) {};
  * @return {string}
  */
 shaka.util.Mp4Parser.typeToString = function(type) {};
+/**
+ * Creates an InitSegmentReference, which provides the location to an
+ * initialization segment.
+ * @param {function():!Array.<string>} uris A function that creates the URIs of
+ *   the resource containing the segment.
+ * @param {number} startByte The offset from the start of the resource to the
+ *   start of the segment.
+ * @param {?number} endByte The offset from the start of the resource to the
+ *   end of the segment, inclusive.  A value of null indicates that the segment
+ *   extends to the end of the resource.
+ * @constructor
+ * @struct
+ */
+shaka.media.InitSegmentReference = function(uris, startByte, endByte) {};
+/**
+ * Creates the URIs of the resource containing the segment.
+ * @return {!Array.<string>}
+ */
+shaka.media.InitSegmentReference.prototype.createUris = function() {};
+/**
+ * Returns the offset from the start of the resource to the
+ * start of the segment.
+ * @return {number}
+ */
+shaka.media.InitSegmentReference.prototype.getStartByte = function() {};
+/**
+ * Returns the offset from the start of the resource to the end of the segment,
+ * inclusive.  A value of null indicates that the segment extends to the end of
+ * the resource.
+ * @return {?number}
+ */
+shaka.media.InitSegmentReference.prototype.getEndByte = function() {};
+/**
+ * Creates a SegmentReference, which provides the start time, end time, and
+ * location to a media segment.
+ * @param {number} position The segment's position within a particular Period.
+ *   The following should hold true between any two SegmentReferences from the
+ *   same Period, r1 and r2:
+ *   IF r2.position > r1.position THEN
+ *     [ (r2.startTime > r1.startTime) OR
+ *       (r2.startTime == r1.startTime AND r2.endTime >= r1.endTime) ]
+ * @param {number} startTime The segment's start time in seconds, relative to
+ *   the start of a particular Period.
+ * @param {number} endTime The segment's end time in seconds, relative to
+ *   the start of a particular Period.  The segment ends the instant before
+ *   this time, so |endTime| must be strictly greater than |startTime|.
+ * @param {function():!Array.<string>} uris
+ *   A function that creates the URIs of the resource containing the segment.
+ * @param {number} startByte The offset from the start of the resource to the
+ *   start of the segment.
+ * @param {?number} endByte The offset from the start of the resource to the
+ *   end of the segment, inclusive.  A value of null indicates that the segment
+ *   extends to the end of the resource.
+ * @constructor
+ * @struct
+ */
+shaka.media.SegmentReference = function(position, startTime, endTime, uris, startByte, endByte) {};
+/**
+ * Returns the segment's position within a particular Period.
+ * @return {number} The segment's position.
+ */
+shaka.media.SegmentReference.prototype.getPosition = function() {};
+/**
+ * Returns the segment's start time in seconds, relative to
+ * the start of a particular Period.
+ * @return {number}
+ */
+shaka.media.SegmentReference.prototype.getStartTime = function() {};
+/**
+ * Returns the segment's end time in seconds, relative to
+ * the start of a particular Period.
+ * @return {number}
+ */
+shaka.media.SegmentReference.prototype.getEndTime = function() {};
+/**
+ * Creates the URIs of the resource containing the segment.
+ * @return {!Array.<string>}
+ */
+shaka.media.SegmentReference.prototype.createUris = function() {};
+/**
+ * Returns the offset from the start of the resource to the
+ * start of the segment.
+ * @return {number}
+ */
+shaka.media.SegmentReference.prototype.getStartByte = function() {};
+/**
+ * Returns the offset from the start of the resource to the end of the segment,
+ * inclusive.  A value of null indicates that the segment extends to the end of
+ * the resource.
+ * @return {?number}
+ */
+shaka.media.SegmentReference.prototype.getEndByte = function() {};
 /**
  * Creates a SegmentIndex.
  * @param {!Array.<!shaka.media.SegmentReference>} references The list of
@@ -1531,10 +1634,12 @@ shaka.dash.DashParser.prototype.onExpirationUpdated = function(sessionId, expira
  * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/data_URIs
  * @param {string} uri
  * @param {shaka.extern.Request} request
- * @param {shaka.net.NetworkingEngine.RequestType=} requestType
+ * @param {shaka.net.NetworkingEngine.RequestType} requestType
+ * @param {shaka.extern.ProgressUpdated} progressUpdated Called when a
+ *   progress event happened.
  * @return {!shaka.extern.IAbortableOperation.<shaka.extern.Response>}
  */
-shaka.net.DataUriPlugin = function(uri, request, requestType) {};
+shaka.net.DataUriPlugin = function(uri, request, requestType, progressUpdated) {};
 /**
  * Creates a new HLS parser.
  * @struct
@@ -1568,8 +1673,8 @@ shaka.hls.HlsParser.prototype.onExpirationUpdated = function(sessionId, expirati
  * @param {string} uri
  * @param {shaka.extern.Request} request
  * @param {shaka.net.NetworkingEngine.RequestType} requestType
- * @param {shaka.extern.ProgressUpdated=} progressUpdated Called when a progress
- *        event happened.
+ * @param {shaka.extern.ProgressUpdated} progressUpdated Called when a progress
+ *   event happened.
  * @return {!shaka.extern.IAbortableOperation.<shaka.extern.Response>}
  */
 shaka.net.HttpFetchPlugin = function(uri, request, requestType, progressUpdated) {};
@@ -1586,8 +1691,8 @@ shaka.net.HttpFetchPlugin.isSupported = function() {};
  * @param {string} uri
  * @param {shaka.extern.Request} request
  * @param {shaka.net.NetworkingEngine.RequestType} requestType
- * @param {shaka.extern.ProgressUpdated=} progressUpdated Called when a
- *        progress event happened.
+ * @param {shaka.extern.ProgressUpdated} progressUpdated Called when a
+ *   progress event happened.
  * @return {!shaka.extern.IAbortableOperation.<shaka.extern.Response>}
  */
 shaka.net.HttpXHRPlugin = function(uri, request, requestType, progressUpdated) {};
@@ -1596,10 +1701,12 @@ shaka.net.HttpXHRPlugin = function(uri, request, requestType, progressUpdated) {
  * @summary A plugin that handles requests for offline content.
  * @param {string} uri
  * @param {shaka.extern.Request} request
- * @param {shaka.net.NetworkingEngine.RequestType=} requestType
+ * @param {shaka.net.NetworkingEngine.RequestType} requestType
+ * @param {shaka.extern.ProgressUpdated} progressUpdated Called when a
+ *   progress event happened.
  * @return {!shaka.extern.IAbortableOperation.<shaka.extern.Response>}
  */
-shaka.offline.OfflineScheme = function(uri, request, requestType) {};
+shaka.offline.OfflineScheme = function(uri, request, requestType, progressUpdated) {};
 /**
  * <p>
  * This defines the default text displayer plugin. An instance of this
@@ -1647,6 +1754,29 @@ shaka.text.SimpleTextDisplayer.prototype.setTextVisibility = function(on) {};
  * @return {boolean}
  */
 shaka.util.ConfigUtils.mergeConfigObjects = function(destination, source, template, overrides, path) {};
+/**
+ * Convert config from ('fieldName', value) format to a partial config object.
+ * E. g. from ('manifest.retryParameters.maxAttempts', 1) to
+ * { manifest: { retryParameters: { maxAttempts: 1 }}}.
+ * @param {string} fieldName
+ * @param {*} value
+ * @return {!Object}
+ */
+shaka.util.ConfigUtils.convertToConfigObject = function(fieldName, value) {};
+/**
+ * @final
+ */
+shaka.util.PlayerConfiguration = class {
+  /**
+   * Merges the given configuration changes into the given destination.  This
+   * uses the default Player configurations as the template.
+   * @param {shaka.extern.PlayerConfiguration} destination
+   * @param {!Object} updates
+   * @param {shaka.extern.PlayerConfiguration=} template
+   * @return {boolean}
+   */
+  static mergeConfigObjects(destination,updates,template) {}
+};
 /**
  * Construct a Player.
  * @param {HTMLMediaElement=} mediaElement