Source: lib/offline/download_info.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. goog.provide('shaka.offline.DownloadInfo');
  9. goog.require('shaka.util.Networking');
  10. goog.requireType('shaka.media.InitSegmentReference');
  11. goog.requireType('shaka.media.SegmentReference');
  14. /**
  15.  * An object that represents a single segment, that the storage system will soon
  16.  * download, but has not yet started downloading.
  17.  */
  18. shaka.offline.DownloadInfo = class {
  19.   /**
  20.    * @param {shaka.media.SegmentReference|shaka.media.InitSegmentReference} ref
  21.    * @param {number} estimateId
  22.    * @param {number} groupId
  23.    * @param {boolean} isInitSegment
  24.    */
  25.   constructor(ref, estimateId, groupId, isInitSegment) {
  26.     /** @type {shaka.media.SegmentReference|shaka.media.InitSegmentReference} */
  27.     this.ref = ref;
  29.     /** @type {number} */
  30.     this.estimateId = estimateId;
  32.     /** @type {number} */
  33.     this.groupId = groupId;
  35.     /** @type {boolean} */
  36.     this.isInitSegment = isInitSegment;
  37.   }
  39.   /**
  40.    * Creates an ID that encapsulates all important information in the ref, which
  41.    * can then be used to check for equality.
  42.    * @param {shaka.media.SegmentReference|shaka.media.InitSegmentReference} ref
  43.    * @return {string}
  44.    */
  45.   static idForSegmentRef(ref) {
  46.     // Escape the URIs using encodeURI, to make sure that a weirdly formed URI
  47.     // cannot cause two unrelated refs to be considered equivalent.
  48.     return ref.getUris().map((uri) => '{' + encodeURI(uri) + '}').join('') +
  49.         ':' + ref.startByte + ':' + ref.endByte;
  50.   }
  52.   /** @return {string} */
  53.   getRefId() {
  54.     return shaka.offline.DownloadInfo.idForSegmentRef(this.ref);
  55.   }
  57.   /**
  58.    * @param {shaka.extern.PlayerConfiguration} config
  59.    * @return {!shaka.extern.Request}
  60.    */
  61.   makeSegmentRequest(config) {
  62.     return shaka.util.Networking.createSegmentRequest(
  63.         this.ref.getUris(),
  64.         this.ref.startByte,
  65.         this.ref.endByte,
  66.         config.streaming.retryParameters);
  67.   }
  68. };