Fix documentation confusion in MediaChunkIterator subclasses

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=217505571
This commit is contained in:
eguven 2018-10-17 05:57:40 -07:00 committed by Oliver Woodman
parent 423a954e1b
commit 86fdcb08d8
4 changed files with 8 additions and 6 deletions

View File

@ -31,7 +31,7 @@ public abstract class BaseMediaChunkIterator implements MediaChunkIterator {
/** /**
* Creates base iterator. * Creates base iterator.
* *
* @param fromIndex The index at which the iterator will start. * @param fromIndex The first available index.
* @param toIndex The last available index. * @param toIndex The last available index.
*/ */
public BaseMediaChunkIterator(long fromIndex, long toIndex) { public BaseMediaChunkIterator(long fromIndex, long toIndex) {

View File

@ -578,12 +578,14 @@ public class DefaultDashChunkSource implements DashChunkSource {
* Creates iterator. * Creates iterator.
* *
* @param representation The {@link RepresentationHolder} to wrap. * @param representation The {@link RepresentationHolder} to wrap.
* @param segmentNum The number of the segment this iterator will be pointing to initially. * @param firstAvailableSegmentNum The number of the first available segment.
* @param lastAvailableSegmentNum The number of the last available segment. * @param lastAvailableSegmentNum The number of the last available segment.
*/ */
public RepresentationSegmentIterator( public RepresentationSegmentIterator(
RepresentationHolder representation, long segmentNum, long lastAvailableSegmentNum) { RepresentationHolder representation,
super(/* fromIndex= */ segmentNum, /* toIndex= */ lastAvailableSegmentNum); long firstAvailableSegmentNum,
long lastAvailableSegmentNum) {
super(/* fromIndex= */ firstAvailableSegmentNum, /* toIndex= */ lastAvailableSegmentNum);
this.representationHolder = representation; this.representationHolder = representation;
} }

View File

@ -631,7 +631,7 @@ import java.util.List;
* @param playlist The {@link HlsMediaPlaylist} to wrap. * @param playlist The {@link HlsMediaPlaylist} to wrap.
* @param startOfPlaylistInPeriodUs The start time of the playlist in the period, in * @param startOfPlaylistInPeriodUs The start time of the playlist in the period, in
* microseconds. * microseconds.
* @param chunkIndex The chunk index in the playlist at which the iterator will start. * @param chunkIndex The index of the first available chunk in the playlist.
*/ */
public HlsMediaPlaylistSegmentIterator( public HlsMediaPlaylistSegmentIterator(
HlsMediaPlaylist playlist, long startOfPlaylistInPeriodUs, int chunkIndex) { HlsMediaPlaylist playlist, long startOfPlaylistInPeriodUs, int chunkIndex) {

View File

@ -318,7 +318,7 @@ public class DefaultSsChunkSource implements SsChunkSource {
* *
* @param streamElement The {@link StreamElement} to wrap. * @param streamElement The {@link StreamElement} to wrap.
* @param trackIndex The track index in the stream element. * @param trackIndex The track index in the stream element.
* @param chunkIndex The chunk index at which the iterator will start. * @param chunkIndex The index of the first available chunk.
*/ */
public StreamElementIterator(StreamElement streamElement, int trackIndex, int chunkIndex) { public StreamElementIterator(StreamElement streamElement, int trackIndex, int chunkIndex) {
super(/* fromIndex= */ chunkIndex, /* toIndex= */ streamElement.chunkCount - 1); super(/* fromIndex= */ chunkIndex, /* toIndex= */ streamElement.chunkCount - 1);