Class: shaka.media.SegmentIndex

Constructor

new SegmentIndex(referencesnon-null)

Parameters:
Name Type Description
references Array.<!shaka.media.SegmentReference> The list of SegmentReferences, which must be sorted first by their start times (ascending) and second by their end times (ascending).
Implements:
Source:

Members

numEvicted :number

The number of references that have been removed from the front of the array. Used to create stable positions in the find/get APIs.
Type:
  • number
Source:

references :Array.<!shaka.media.SegmentReference>

Type:
Source:

timer_ :shaka.util.Timer

Type:
Source:

Methods

assertCorrectReferences_(referencesnon-null)

Asserts that the given SegmentReferences are sorted.
Parameters:
Name Type Description
references Array.<shaka.media.SegmentReference>
Source:

forSingleSegment(startTime, duration, urisnon-null) → {shaka.media.SegmentIndex}

Create a SegmentIndex for a single segment of the given start time and duration at the given URIs.
Parameters:
Name Type Description
startTime number
duration number
uris Array.<string>
Source:
Returns:
Type
shaka.media.SegmentIndex

destroy() → {Promise}

SegmentIndex used to be an IDestroyable. Now it is an IReleasable. This method is provided for backward compatibility.
Deprecated:
  • Yes
Source:
Returns:
Type
Promise

evict(time)

Removes all SegmentReferences that end before the given time.
Parameters:
Name Type Description
time number The time in seconds.
Source:

find(time) → {number}

Finds the position of the segment for the given time, in seconds, relative to the start of the presentation. Returns the position of the segment with the largest end time if more than one segment is known for the given time.
Parameters:
Name Type Description
time number
Source:
Returns:
The position of the segment, or null if the position of the segment could not be determined.
Type
number

fit(windowStart, windowEndnullable)

Drops references that start after windowEnd, or end before windowStart, and contracts the last reference so that it ends at windowEnd. Do not call on the last period of a live presentation (unknown duration). It is okay to call on the other periods of a live presentation, where the duration is known and another period has been added.
Parameters:
Name Type Attributes Description
windowStart number
windowEnd number <nullable>
Source:

get(position) → {shaka.media.SegmentReference}

Gets the SegmentReference for the segment at the given position.
Parameters:
Name Type Description
position number The position of the segment as returned by find().
Source:
Returns:
The SegmentReference, or null if no such SegmentReference exists.
Type
shaka.media.SegmentReference

merge(referencesnon-null)

Merges the given SegmentReferences. Supports extending the original references only. Will not replace old references or interleave new ones. Used, for example, by the DASH and HLS parser, where manifests may not list all available references, so we must keep available references in memory to fill the availability window.
Parameters:
Name Type Description
references Array.<!shaka.media.SegmentReference> The list of SegmentReferences, which must be sorted first by their start times (ascending) and second by their end times (ascending).
Source:

offset(offset)

Offset all segment references by a fixed amount.
Parameters:
Name Type Description
offset number The amount to add to each segment's start and end times.
Source:

release()

Request that this object release all internal references.
Implements:
Source:

updateEvery(interval, updateCallback)

Updates the references every so often. Stops when the references list becomes empty.
Parameters:
Name Type Description
interval number The interval in seconds.
updateCallback function(): !Array.<shaka.media.SegmentReference>
Source: