Files
shaka-player/lib/media/segment_reference.js
T
Timothy Drews 0f7069588a Change 'segmentNumber' to 'id' in SegmentReference.
* The segmentNumber member in SegmentReference is used as an ID,
  so rename it and update the doc string.
* Tidy up SegmentIndex unit tests.

Change-Id: I888b8cbfd6a198bab09f6ab846cbdbf70cfcaa5a
2015-03-26 19:09:50 +00:00

83 lines
2.4 KiB
JavaScript

/**
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* @fileoverview Implements a segment reference structure.
*/
goog.provide('shaka.media.SegmentReference');
goog.require('goog.Uri');
/**
* Creates a SegmentReference, which is a reference to some media segment.
*
* @param {number} id The segment's ID.
* @param {number} startTime The time, in seconds, that the segment begins.
* @param {?number} endTime The time, in seconds, that the segment ends. The
* segment ends immediately before this time. A null value indicates that
* the segment continues to the end of the stream's period.
* @param {number} startByte The position of the segment's first byte.
* @param {?number} endByte The position of the segment's last byte, inclusive.
* A null value indicates that the segment continues to the end of the
* file located at |url|.
* @param {!goog.Uri} url The segment's location.
* @constructor
* @struct
*/
shaka.media.SegmentReference = function(
id, startTime, endTime, startByte, endByte, url) {
/**
* The segment's ID.
* @const {number}
*/
this.id = id;
/**
* The time, in seconds, that the segment begins.
* @type {number}
*/
this.startTime = startTime;
/**
* The time, in seconds, that the segment ends. The segment ends immediately
* before this time. A null value indicates that the segment continues to the
* end of the stream.
* @type {?number}
*/
this.endTime = endTime;
/**
* The position of the segment's first byte.
* @const {number}
*/
this.startByte = startByte;
/**
* The position of the segment's last byte, inclusive. A null value indicates
* that the segment continues to the end of the file located at |url|.
* @const {?number}
*/
this.endByte = endByte;
/**
* The segment's location.
* @const {!goog.Uri}
*/
this.url = url;
};