com.google.android.exoplayer2.source

Class SinglePeriodTimeline

java.lang.Object

com.google.android.exoplayer2.Timeline

com.google.android.exoplayer2.source.SinglePeriodTimeline

public final class SinglePeriodTimeline
extends Timeline

A Timeline consisting of a single period and static window.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.android.exoplayer2.Timeline

Timeline.Period, Timeline.Window

Field Summary

Fields inherited from class com.google.android.exoplayer2.Timeline

EMPTY

Constructor Summary

Constructors

Constructor and Description
SinglePeriodTimeline(long durationUs, boolean isSeekable, boolean isDynamic) Creates a timeline containing a single period and a window that spans it.
SinglePeriodTimeline(long durationUs, boolean isSeekable, boolean isDynamic, java.lang.Object tag) Creates a timeline containing a single period and a window that spans it.
SinglePeriodTimeline(long periodDurationUs, long windowDurationUs, long windowPositionInPeriodUs, long windowDefaultStartPositionUs, boolean isSeekable, boolean isDynamic, java.lang.Object tag) Creates a timeline with one period, and a window of known duration starting at a specified position in the period.
SinglePeriodTimeline(long presentationStartTimeMs, long windowStartTimeMs, long periodDurationUs, long windowDurationUs, long windowPositionInPeriodUs, long windowDefaultStartPositionUs, boolean isSeekable, boolean isDynamic, java.lang.Object tag) Creates a timeline with one period, and a window of known duration starting at a specified position in the period.

Method Summary

Modifier and Type	Method and Description
int	getIndexOfPeriod(java.lang.Object uid) Returns the index of the period identified by its unique id, or C.INDEX_UNSET if the period is not in the timeline.
Timeline.Period	getPeriod(int periodIndex, Timeline.Period period, boolean setIds) Populates a Timeline.Period with data for the period at the specified index.
int	getPeriodCount() Returns the number of periods in the timeline.
java.lang.Object	getUidOfPeriod(int periodIndex) Returns the unique id of the period identified by its index in the timeline.
Timeline.Window	getWindow(int windowIndex, Timeline.Window window, boolean setTag, long defaultPositionProjectionUs) Populates a Timeline.Window with data for the window at the specified index.
int	getWindowCount() Returns the number of windows in the timeline.

Methods inherited from class com.google.android.exoplayer2.Timeline

getFirstWindowIndex, getLastWindowIndex, getNextPeriodIndex, getNextWindowIndex, getPeriod, getPeriodByUid, getPeriodPosition, getPeriodPosition, getPreviousWindowIndex, getWindow, getWindow, isEmpty, isLastPeriod

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SinglePeriodTimeline

public SinglePeriodTimeline(long durationUs,
                            boolean isSeekable,
                            boolean isDynamic)

Creates a timeline containing a single period and a window that spans it.

Parameters:

durationUs - The duration of the period, in microseconds.

isSeekable - Whether seeking is supported within the period.

isDynamic - Whether the window may change when the timeline is updated.

SinglePeriodTimeline

public SinglePeriodTimeline(long durationUs,
                            boolean isSeekable,
                            boolean isDynamic,
                            @Nullable
                            java.lang.Object tag)

Creates a timeline containing a single period and a window that spans it.

Parameters:

durationUs - The duration of the period, in microseconds.

isSeekable - Whether seeking is supported within the period.

isDynamic - Whether the window may change when the timeline is updated.

tag - A tag used for Timeline.Window#tag.

SinglePeriodTimeline

public SinglePeriodTimeline(long periodDurationUs,
                            long windowDurationUs,
                            long windowPositionInPeriodUs,
                            long windowDefaultStartPositionUs,
                            boolean isSeekable,
                            boolean isDynamic,
                            @Nullable
                            java.lang.Object tag)

Creates a timeline with one period, and a window of known duration starting at a specified position in the period.

Parameters:

periodDurationUs - The duration of the period in microseconds.

windowDurationUs - The duration of the window in microseconds.

windowPositionInPeriodUs - The position of the start of the window in the period, in microseconds.

windowDefaultStartPositionUs - The default position relative to the start of the window at which to begin playback, in microseconds.

isSeekable - Whether seeking is supported within the window.

isDynamic - Whether the window may change when the timeline is updated.

tag - A tag used for Timeline.Window#tag.

SinglePeriodTimeline

public SinglePeriodTimeline(long presentationStartTimeMs,
                            long windowStartTimeMs,
                            long periodDurationUs,
                            long windowDurationUs,
                            long windowPositionInPeriodUs,
                            long windowDefaultStartPositionUs,
                            boolean isSeekable,
                            boolean isDynamic,
                            @Nullable
                            java.lang.Object tag)

Creates a timeline with one period, and a window of known duration starting at a specified position in the period.

Parameters:

presentationStartTimeMs - The start time of the presentation in milliseconds since the epoch.

windowStartTimeMs - The window's start time in milliseconds since the epoch.

periodDurationUs - The duration of the period in microseconds.

windowDurationUs - The duration of the window in microseconds.

windowPositionInPeriodUs - The position of the start of the window in the period, in microseconds.

windowDefaultStartPositionUs - The default position relative to the start of the window at which to begin playback, in microseconds.

isSeekable - Whether seeking is supported within the window.

isDynamic - Whether the window may change when the timeline is updated.

tag - A tag used for Timeline.Window#tag.

Method Detail

getWindowCount

public int getWindowCount()

Description copied from class: Timeline

Returns the number of windows in the timeline.

Specified by:

getWindowCount in class Timeline

getWindow

public Timeline.Window getWindow(int windowIndex,
                                 Timeline.Window window,
                                 boolean setTag,
                                 long defaultPositionProjectionUs)

Description copied from class: Timeline

Populates a Timeline.Window with data for the window at the specified index.

Specified by:

getWindow in class Timeline

Parameters:

windowIndex - The index of the window.

window - The Timeline.Window to populate. Must not be null.

setTag - Whether Timeline.Window.tag should be populated. If false, the field will be set to null. The caller should pass false for efficiency reasons unless the field is required.

defaultPositionProjectionUs - A duration into the future that the populated window's default start position should be projected.

Returns:

The populated Timeline.Window, for convenience.

getPeriodCount

public int getPeriodCount()

Description copied from class: Timeline

Returns the number of periods in the timeline.

Specified by:

getPeriodCount in class Timeline

getPeriod

public Timeline.Period getPeriod(int periodIndex,
                                 Timeline.Period period,
                                 boolean setIds)

Description copied from class: Timeline

Populates a Timeline.Period with data for the period at the specified index.

Specified by:

getPeriod in class Timeline

Parameters:

periodIndex - The index of the period.

period - The Timeline.Period to populate. Must not be null.

setIds - Whether Timeline.Period.id and Timeline.Period.uid should be populated. If false, the fields will be set to null. The caller should pass false for efficiency reasons unless the fields are required.

Returns:

The populated Timeline.Period, for convenience.

getIndexOfPeriod

public int getIndexOfPeriod(java.lang.Object uid)

Description copied from class: Timeline

Returns the index of the period identified by its unique id, or C.INDEX_UNSET if the period is not in the timeline.

Specified by:

getIndexOfPeriod in class Timeline

Parameters:

uid - A unique identifier for a period.

Returns:

The index of the period, or C.INDEX_UNSET if the period was not found.

getUidOfPeriod

public java.lang.Object getUidOfPeriod(int periodIndex)

Description copied from class: Timeline

Returns the unique id of the period identified by its index in the timeline.

Specified by:

getUidOfPeriod in class Timeline

Parameters:

periodIndex - The index of the period.

Returns:

The unique id of the period.