Source: lib/media/segment_reference.js

  1. /**
  2.  * @license
  3.  * Copyright 2016 Google Inc.
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  18. goog.provide('shaka.media.InitSegmentReference');
  19. goog.provide('shaka.media.SegmentReference');
  21. goog.require('goog.asserts');
  25. /**
  26.  * Creates an InitSegmentReference, which provides the location to an
  27.  * initialization segment.
  28.  *
  29.  * @param {function():!Array.<string>} uris
  30.  *   A function that creates the URIs of the resource containing the segment.
  31.  * @param {number} startByte The offset from the start of the resource to the
  32.  *   start of the segment.
  33.  * @param {?number} endByte The offset from the start of the resource to the
  34.  *   end of the segment, inclusive. null indicates that the segment extends
  35.  *   to the end of the resource.
  36.  *
  37.  * @constructor
  38.  * @struct
  39.  * @export
  40.  */
  41. shaka.media.InitSegmentReference = function(uris, startByte, endByte) {
  42.   /** @type {function():!Array.<string>} */
  43.   this.getUris = uris;
  45.   /** @const {number} */
  46.   this.startByte = startByte;
  48.   /** @const {?number} */
  49.   this.endByte = endByte;
  50. };
  54. /**
  55.  * Creates a SegmentReference, which provides the start time, end time, and
  56.  * location to a media segment.
  57.  *
  58.  * @param {number} position The segment's position within a particular Period.
  59.  *   The following should hold true between any two SegmentReferences from the
  60.  *   same Period, r1 and r2:
  61.  *   IF r2.position > r1.position THEN
  62.  *     [ (r2.startTime > r1.startTime) OR
  63.  *       (r2.startTime == r1.startTime AND r2.endTime >= r1.endTime) ]
  64.  * @param {number} startTime The segment's start time in seconds, relative to
  65.  *   the start of a particular Period.
  66.  * @param {number} endTime The segment's end time in seconds, relative to
  67.  *   the start of a particular Period. The segment ends the instant before
  68.  *   this time, so |endTime| must be strictly greater than |startTime|.
  69.  * @param {function():!Array.<string>} uris
  70.  *   A function that creates the URIs of the resource containing the segment.
  71.  * @param {number} startByte The offset from the start of the resource to the
  72.  *   start of the segment.
  73.  * @param {?number} endByte The offset from the start of the resource to the
  74.  *   end of the segment, inclusive. null indicates that the segment extends
  75.  *   to the end of the resource.
  76.  *
  77.  * @constructor
  78.  * @struct
  79.  * @export
  80.  */
  81. shaka.media.SegmentReference = function(
  82.     position, startTime, endTime, uris, startByte, endByte) {
  83.   goog.asserts.assert(startTime < endTime,
  84.                       'startTime must be less than endTime');
  85.   goog.asserts.assert((startByte < endByte) || (endByte == null),
  86.                       'startByte must be < endByte');
  87.   /** @const {number} */
  88.   this.position = position;
  90.   /** @const {number} */
  91.   this.startTime = startTime;
  93.   /** @const {number} */
  94.   this.endTime = endTime;
  96.   /** @type {function():!Array.<string>} */
  97.   this.getUris = uris;
  99.   /** @const {number} */
  100.   this.startByte = startByte;
  102.   /** @const {?number} */
  103.   this.endByte = endByte;
  104. };