shaka-player 4.3.10 → 4.4.0

package/externs/shaka/manifest.js

@@ -18,7 +18,10 @@
  *   imageStreams: !Array.<shaka.extern.Stream>,
  *   offlineSessionIds: !Array.<string>,
  *   minBufferTime: number,
- *   sequenceMode: boolean
+ *   sequenceMode: boolean,
+ *   ignoreManifestTimestampsInSegmentsMode: boolean,
+ *   type: string,
+ *   serviceDescription: ?shaka.extern.ServiceDescription
  * }}
  *
  * @description
@@ -76,12 +79,53 @@
  * @property {boolean} sequenceMode
  *   If true, we will append the media segments using sequence mode; that is to
  *   say, ignoring any timestamps inside the media files.
+ * @property {boolean} ignoreManifestTimestampsInSegmentsMode
+ *   If true, don't adjust the timestamp offset to account for manifest
+ *   segment durations being out of sync with segment durations. In other
+ *   words, assume that there are no gaps in the segments when appending
+ *   to the SourceBuffer, even if the manifest and segment times disagree.
+ *   Only applies when sequenceMode is <code>false</code>, and only for HLS
+ *   streams.
+ *   <i>Defaults to <code>false</code>.</i>
+ * @property {string} type
+ *   Indicates the type of the manifest. It can be <code>'HLS'</code> or
+ *   <code>'DASH'</code>.
+ * @property {?shaka.extern.ServiceDescription} serviceDescription
+ *   The service description for the manifest. Used to adapt playbackRate to
+ *   decrease latency.
  *
  * @exportDoc
  */
 shaka.extern.Manifest;
 
 
+/**
+ * @typedef {{
+*   id: string,
+*   audioStreams: !Array.<shaka.extern.Stream>,
+*   videoStreams: !Array.<shaka.extern.Stream>,
+*   textStreams: !Array.<shaka.extern.Stream>,
+*   imageStreams: !Array.<shaka.extern.Stream>
+* }}
+*
+* @description Contains the streams from one DASH period.
+* For use in {@link shaka.util.PeriodCombiner}.
+*
+* @property {string} id
+*   The Period ID.
+* @property {!Array.<shaka.extern.Stream>} audioStreams
+*   The audio streams from one Period.
+* @property {!Array.<shaka.extern.Stream>} videoStreams
+*   The video streams from one Period.
+* @property {!Array.<shaka.extern.Stream>} textStreams
+*   The text streams from one Period.
+* @property {!Array.<shaka.extern.Stream>} imageStreams
+*   The image streams from one Period.
+*
+* @exportDoc
+*/
+shaka.extern.Period;
+
 /**
  * @typedef {{
  *   initData: !Uint8Array,
@@ -105,6 +149,26 @@ shaka.extern.Manifest;
  */
 shaka.extern.InitDataOverride;
 
+/**
+ * @typedef {{
+ *   maxLatency: ?number,
+ *   maxPlaybackRate: ?number
+ * }}
+ *
+ * @description
+ * Maximum latency and playback rate for a manifest. When max latency is reached
+ * playbackrate is updated to maxPlaybackRate to decrease 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.
+ *
+ * @exportDoc
+ */
+shaka.extern.ServiceDescription;
+
 
 /**
  * @typedef {{
@@ -307,12 +371,14 @@ shaka.extern.FetchCryptoKeysFunction;
  *   drmInfos: !Array.<shaka.extern.DrmInfo>,
  *   keyIds: !Set.<string>,
  *   language: string,
+ *   originalLanguage: ?string,
  *   label: ?string,
  *   type: string,
  *   primary: boolean,
  *   trickModeVideo: ?shaka.extern.Stream,
  *   emsgSchemeIdUris: ?Array.<string>,
  *   roles: !Array.<string>,
+ *   accessibilityPurpose: ?shaka.media.ManifestParser.AccessibilityPurpose,
  *   forced: boolean,
  *   channelsCount: ?number,
  *   audioSamplingRate: ?number,
@@ -322,6 +388,7 @@ shaka.extern.FetchCryptoKeysFunction;
  *   matchedStreams:
  *      (!Array.<shaka.extern.Stream>|!Array.<shaka.extern.StreamDB>|
  *      undefined),
+ *   mssPrivateData: (shaka.extern.MssPrivateData|undefined),
  *   external: boolean
  * }}
  *
@@ -391,6 +458,9 @@ shaka.extern.FetchCryptoKeysFunction;
  *   The Stream's language, specified as a language code. <br>
  *   Audio stream's language must be identical to the language of the containing
  *   Variant.
+ * @property {?string} originalLanguage
+ *   <i>Optional.</i> <br>
+ *   The original language, if any, that appeared in the manifest.
  * @property {?string} label
  *   The Stream's label, unique text that should describe the audio/text track.
  * @property {string} type
@@ -411,6 +481,9 @@ shaka.extern.FetchCryptoKeysFunction;
  * @property {!Array.<string>} roles
  *   The roles of the stream as they appear on the manifest,
  *   e.g. 'main', 'caption', or 'commentary'.
+ * @property {?shaka.media.ManifestParser.AccessibilityPurpose}
+ *     accessibilityPurpose
+ *   The DASH accessibility descriptor, if one was provided for this stream.
  * @property {boolean} forced
  *   <i>Defaults to false.</i> <br>
  *   Whether the stream set was forced
@@ -435,6 +508,9 @@ shaka.extern.FetchCryptoKeysFunction;
  * @property {(!Array.<shaka.extern.Stream>|!Array.<shaka.extern.StreamDB>|
  *   undefined)} matchedStreams
  *   The streams in all periods which match the stream. Used for Dash.
+ * @property {(shaka.extern.MssPrivateData|undefined)} mssPrivateData
+ *   <i>Microsoft Smooth Streaming only.</i> <br>
+ *   Private MSS data that is necessary to be able to do transmuxing.
  * @property {boolean} external
  *   Indicate if the stream was added externally.
  *   Eg: external text tracks.
@@ -442,3 +518,27 @@ shaka.extern.FetchCryptoKeysFunction;
  * @exportDoc
  */
 shaka.extern.Stream;
+
+
+/**
+ * @typedef {{
+ *   duration: number,
+ *   timescale: number,
+ *   codecPrivateData: ?string
+ * }}
+ *
+ * @description
+ * Private MSS data that is necessary to be able to do transmuxing.
+ *
+ * @property {number} duration
+ *   <i>Required.</i> <br>
+ *   MSS Stream duration.
+ * @property {number} timescale
+ *   <i>Required.</i> <br>
+ *   MSS timescale.
+ * @property {?string} codecPrivateData
+ *   MSS codecPrivateData.
+ *
+ * @exportDoc
+ */
+shaka.extern.MssPrivateData;

package/externs/shaka/manifest_parser.js

@@ -100,10 +100,6 @@ shaka.extern.ManifestParser = class {
 /**
  * @typedef {{
  *   networkingEngine: !shaka.net.NetworkingEngine,
- *   modifyManifestRequest: function(!shaka.extern.Request,
- *      shaka.util.CmcdManager.ManifestInfo),
- *   modifySegmentRequest: function(!shaka.extern.Request,
- *      shaka.util.CmcdManager.SegmentInfo),
  *   filter: function(shaka.extern.Manifest):!Promise,
  *   makeTextStreamsForClosedCaptions: function(shaka.extern.Manifest),
  *   onTimelineRegionAdded: function(shaka.extern.TimelineRegionInfo),
@@ -124,12 +120,6 @@ shaka.extern.ManifestParser = class {
  *
  * @property {!shaka.net.NetworkingEngine} networkingEngine
  *   The networking engine to use for network requests.
- * @property {function(!shaka.extern.Request,
- *    shaka.util.CmcdManager.ManifestInfo)} modifyManifestRequest
- *   Modify a manifest request
- * @property {function(!shaka.extern.Request,
- *   shaka.util.CmcdManager.SegmentInfo)} modifySegmentRequest
- *   Modify a segment request
  * @property {function(shaka.extern.Manifest):!Promise} filter
  *   Should be called when new variants or text streams are added to the
  *   Manifest.  Note that this operation is asynchronous.

package/externs/shaka/net.js

@@ -200,15 +200,40 @@ shaka.extern.ProgressUpdated;
 shaka.extern.HeadersReceived;
 
 
+/**
+ * @typedef {{
+ *   type: (shaka.net.NetworkingEngine.AdvancedRequestType|undefined),
+ *   stream: (shaka.extern.Stream|undefined),
+ *   segment: (shaka.media.SegmentReference|undefined)
+ * }}
+ *
+ * @description
+ * Defines contextual data about a request
+ *
+ * @property {shaka.net.NetworkingEngine.AdvancedRequestType=} type
+ *   The advanced type
+ * @property {shaka.extern.Stream=} stream
+ *   The duration of the segment in seconds
+ * @property {shaka.media.SegmentReference=} segment
+ *   The request's segment reference
+ * @exportDoc
+ */
+shaka.extern.RequestContext;
+
+
 /**
  * Defines a filter for requests.  This filter takes the request and modifies
  * it before it is sent to the scheme plugin.
- * A request filter can run asynchronously by returning a promise; in this case,
- * the request will not be sent until the promise is resolved.
+ * The RequestType describes the basic type of the request (manifest, segment,
+ * etc). The optional RequestContext will be provided where applicable to
+ * provide additional infomation about the request. A request filter can run
+ * asynchronously by returning a promise; in this case, the request will not be
+ * sent until the promise is resolved.
  *
  * @typedef {!function(shaka.net.NetworkingEngine.RequestType,
- *                     shaka.extern.Request):
-             (Promise|undefined)}
+ *                     shaka.extern.Request,
+ *                     shaka.extern.RequestContext=):
+ *           (Promise|undefined)}
  * @exportDoc
  */
 shaka.extern.RequestFilter;
@@ -217,11 +242,15 @@ shaka.extern.RequestFilter;
 /**
  * Defines a filter for responses.  This filter takes the response and modifies
  * it before it is returned.
- * A response filter can run asynchronously by returning a promise.
+ * The RequestType describes the basic type of the request (manifest, segment,
+ * etc). The optional RequestContext will be provided where applicable to
+ * provide additional infomation about the request. A response filter can run
+ * asynchronously by returning a promise.
  *
  * @typedef {!function(shaka.net.NetworkingEngine.RequestType,
- *                     shaka.extern.Response):
-              (Promise|undefined)}
+ *                     shaka.extern.Response,
+ *                     shaka.extern.RequestContext=):
+ *            (Promise|undefined)}
  * @exportDoc
  */
 shaka.extern.ResponseFilter;

package/externs/shaka/offline.js

@@ -74,7 +74,8 @@ shaka.extern.StoredContent;
  *   drmInfo: ?shaka.extern.DrmInfo,
  *   appMetadata: Object,
  *   isIncomplete: (boolean|undefined),
- *   sequenceMode: (boolean|undefined)
+ *   sequenceMode: (boolean|undefined),
+ *   type: (string|undefined)
  * }}
  *
  * @property {number} creationTime
@@ -102,6 +103,9 @@ shaka.extern.StoredContent;
  * @property {(boolean|undefined)} sequenceMode
  *   If true, we will append the media segments using sequence mode; that is to
  *   say, ignoring any timestamps inside the media files.
+ * @property {(string|undefined)} type
+ *   Indicates the type of the manifest. It can be <code>'HLS'</code> or
+ *   <code>'DASH'</code>.
  */
 shaka.extern.ManifestDB;
 
@@ -119,6 +123,7 @@ shaka.extern.ManifestDB;
  *   hdr: (string|undefined),
  *   kind: (string|undefined),
  *   language: string,
+ *   originalLanguage: (?string|undefined),
  *   label: ?string,
  *   width: ?number,
  *   height: ?number,
@@ -159,6 +164,8 @@ shaka.extern.ManifestDB;
  *   The kind of text stream; undefined for audio/video.
  * @property {string} language
  *   The language of the stream; '' for video.
+ * @property {(?string|undefined)} originalLanguage
+ *   The original language, if any, that appeared in the manifest.
  * @property {?string} label
  *   The label of the stream; '' for video.
  * @property {?number} width