public abstract class Timeline

Known direct subclasses
AbstractConcatenatedTimeline

Abstract base class for the concatenation of one or more Timelines.
FakeMultiPeriodLiveTimeline

A fake Timeline that produces a live window with periods according to the available time range.
FakeTimeline

Fake Timeline which can be setup to return custom TimelineWindowDefinitions.
ForwardingTimeline

An overridable Timeline implementation forwarding all methods to another timeline.
MaskingMediaSource.PlaceholderTimeline

A timeline with one dynamic window with a period of indeterminate duration.
SinglePeriodTimeline

A Timeline consisting of a single period and static window.
Timeline.RemotableTimeline

A concrete class of Timeline to restore a Timeline instance from a sent by another process via IBinder.
Known indirect subclasses
FakeMediaSource.InitialTimeline

A forwarding timeline to provide an initial timeline for fake multi window sources.
SinglePeriodAdTimeline

A Timeline for sources that have ads.
TimelineWithUpdatedMediaItem

A Timeline that overrides the MediaItem.

A flexible representation of the structure of media. A timeline is able to represent the structure of a wide variety of media, from simple cases like a single media file through to complex compositions of media such as playlists and streams with inserted ads. Instances are immutable. For cases where media is changing dynamically (e.g. live streams), a timeline provides a snapshot of the current state.

A timeline consists of Windows and Periods.

  • A Window usually corresponds to one playlist item. It may span one or more periods and it defines the region within those periods that's currently available for playback. The window also provides additional information such as whether seeking is supported within the window and the default position, which is the position from which playback will start when the player starts playing the window.
  • A Period defines a single logical piece of media, for example a media file. It may also define groups of ads inserted into the media, along with information about whether those ads have been loaded and played.

The following examples illustrate timelines for various use cases.

Single media file or on-demand stream

Example timeline for a single file

A timeline for a single media file or on-demand stream consists of a single period and window. The window spans the whole period, indicating that all parts of the media are available for playback. The window's default position is typically at the start of the period (indicated by the black dot in the figure above).

Playlist of media files or on-demand streams

Example timeline for a playlist of files

A timeline for a playlist of media files or on-demand streams consists of multiple periods, each with its own window. Each window spans the whole of the corresponding period, and typically has a default position at the start of the period. The properties of the periods and windows (e.g. their durations and whether the window is seekable) will often only become known when the player starts buffering the corresponding file or stream.

Live stream with limited availability

Example timeline for a live stream with limited availability

A timeline for a live stream consists of a period whose duration is unknown, since it's continually extending as more content is broadcast. If content only remains available for a limited period of time then the window may start at a non-zero position, defining the region of content that can still be played. The window will return true from isLive to indicate it's a live stream and isDynamic will be set to true as long as we expect changes to the live window. Its default position is typically near to the live edge (indicated by the black dot in the figure above).

Live stream with indefinite availability

Example timeline for a live stream with indefinite availability

A timeline for a live stream with indefinite availability is similar to the Live stream with limited availability case, except that the window starts at the beginning of the period to indicate that all of the previously broadcast content can still be played.

Live stream with multiple periods

Example timeline for a live stream with multiple periods

This case arises when a live stream is explicitly divided into separate periods, for example at content boundaries. This case is similar to the Live stream with limited availability case, except that the window may span more than one period. Multiple periods are also possible in the indefinite availability case.

On-demand stream followed by live stream

Example timeline for an on-demand stream followed by a live stream

This case is the concatenation of the Single media file or on-demand stream and Live stream with multiple periods cases. When playback of the on-demand stream ends, playback of the live stream will start from its default position near the live edge.

On-demand stream with mid-roll ads

Example timeline for an on-demand stream with mid-roll ad groups

This case includes mid-roll ad groups, which are defined as part of the timeline's single period. The period can be queried for information about the ad groups and the ads they contain.

Summary

Nested types
public final class Timeline.Period

Holds information about a period in a Timeline.

A concrete class of Timeline to restore a Timeline instance from a sent by another process via IBinder.
public final class Timeline.Window

Holds information about a window in a Timeline.

Constants
static final Timeline

An empty timeline.

Protected constructors

Public methods
final Timeline

Returns a copy of this timeline containing just the single specified Window.
boolean
static Timeline

Restores a Timeline from a Bundle.
int
getFirstWindowIndex(boolean shuffleModeEnabled)

Returns the index of the first window in the playback order depending on whether shuffling is enabled.
abstract int

Returns the index of the period identified by its unique uid, or INDEX_UNSET if the period is not in the timeline.
int
getLastWindowIndex(boolean shuffleModeEnabled)

Returns the index of the last window in the playback order depending on whether shuffling is enabled.
final int
getNextPeriodIndex(
    int periodIndex,
    Timeline.Period period,
    Timeline.Window window,
    @Player.RepeatMode int repeatMode,
    boolean shuffleModeEnabled
)

Returns the index of the period after the period at index periodIndex depending on the repeatMode and whether shuffling is enabled.
int
getNextWindowIndex(
    int windowIndex,
    @Player.RepeatMode int repeatMode,
    boolean shuffleModeEnabled
)

Returns the index of the window after the window at index windowIndex depending on the repeatMode and whether shuffling is enabled.
final Timeline.Period
getPeriod(int periodIndex, Timeline.Period period)

Populates a Period with data for the period at the specified index.
abstract Timeline.Period
getPeriod(int periodIndex, Timeline.Period period, boolean setIds)

Populates a Period with data for the period at the specified index.
Timeline.Period
getPeriodByUid(Object periodUid, Timeline.Period period)

Populates a Period with data for the period with the specified unique identifier.
abstract int

Returns the number of periods in the timeline.
final Pair<Object, Long>
@UnstableApi
@InlineMe(replacement = "this.getPeriodPositionUs(window, period, windowIndex, windowPositionUs)")
getPeriodPosition(
    Timeline.Window window,
    Timeline.Period period,
    int windowIndex,
    long windowPositionUs
)

This method is deprecated.

Use getPeriodPositionUs instead.
final @Nullable Pair<Object, Long>
@UnstableApi
@InlineMe(replacement = "this.getPeriodPositionUs(" + "window, period, windowIndex, windowPositionUs, defaultPositionProjectionUs)")
getPeriodPosition(
    Timeline.Window window,
    Timeline.Period period,
    int windowIndex,
    long windowPositionUs,
    long defaultPositionProjectionUs
)

This method is deprecated.

Use getPeriodPositionUs instead.
final Pair<Object, Long>
getPeriodPositionUs(
    Timeline.Window window,
    Timeline.Period period,
    int windowIndex,
    long windowPositionUs
)

Calls getPeriodPositionUs with a zero default position projection.
final @Nullable Pair<Object, Long>
getPeriodPositionUs(
    Timeline.Window window,
    Timeline.Period period,
    int windowIndex,
    long windowPositionUs,
    long defaultPositionProjectionUs
)

Converts (windowIndex, windowPositionUs) to the corresponding (periodUid, periodPositionUs).
int
getPreviousWindowIndex(
    int windowIndex,
    @Player.RepeatMode int repeatMode,
    boolean shuffleModeEnabled
)

Returns the index of the window before the window at index windowIndex depending on the repeatMode and whether shuffling is enabled.
abstract Object
getUidOfPeriod(int periodIndex)

Returns the unique id of the period identified by its index in the timeline.
final Timeline.Window
getWindow(int windowIndex, Timeline.Window window)

Populates a Window with data for the window at the specified index.
abstract Timeline.Window
getWindow(
    int windowIndex,
    Timeline.Window window,
    long defaultPositionProjectionUs
)

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

Returns the number of windows in the timeline.
int
final boolean

Returns whether the timeline is empty.
final boolean
isLastPeriod(
    int periodIndex,
    Timeline.Period period,
    Timeline.Window window,
    @Player.RepeatMode int repeatMode,
    boolean shuffleModeEnabled
)

Returns whether the given period is the last period of the timeline depending on the repeatMode and whether shuffling is enabled.
final Bundle

Returns a Bundle representing the information stored in this object.

Constants

EMPTY

public static final Timeline EMPTY

An empty timeline.

Protected constructors

Timeline

@UnstableApi
protected Timeline()

Public methods

copyWithSingleWindow

@UnstableApi
public final Timeline copyWithSingleWindow(int windowIndex)

Returns a copy of this timeline containing just the single specified Window.

The method returns the same instance if there is only one window.

Parameters
int windowIndex

The index of the Window to include in the copy.
Returns
Timeline

A Timeline with just the single specified Window.

equals

public boolean equals(@Nullable Object obj)

fromBundle

@UnstableApi
public static Timeline fromBundle(Bundle bundle)

Restores a Timeline from a Bundle.

getFirstWindowIndex

public int getFirstWindowIndex(boolean shuffleModeEnabled)

Returns the index of the first window in the playback order depending on whether shuffling is enabled.

Parameters
boolean shuffleModeEnabled

Whether shuffling is enabled.
Returns
int

The index of the first window in the playback order, or INDEX_UNSET if the timeline is empty.

getIndexOfPeriod

public abstract int getIndexOfPeriod(Object uid)

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

Parameters
Object uid

A unique identifier for a period.
Returns
int

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

getLastWindowIndex

public int getLastWindowIndex(boolean shuffleModeEnabled)

Returns the index of the last window in the playback order depending on whether shuffling is enabled.

Parameters
boolean shuffleModeEnabled

Whether shuffling is enabled.
Returns
int

The index of the last window in the playback order, or INDEX_UNSET if the timeline is empty.

getNextPeriodIndex

public final int getNextPeriodIndex(
    int periodIndex,
    Timeline.Period period,
    Timeline.Window window,
    @Player.RepeatMode int repeatMode,
    boolean shuffleModeEnabled
)

Returns the index of the period after the period at index periodIndex depending on the repeatMode and whether shuffling is enabled.

Parameters
int periodIndex

Index of a period in the timeline.
Timeline.Period period

A Period to be used internally. Must not be null.
Timeline.Window window

A Window to be used internally. Must not be null.
@Player.RepeatMode int repeatMode

A repeat mode.
boolean shuffleModeEnabled

Whether shuffling is enabled.
Returns
int

The index of the next period, or INDEX_UNSET if this is the last period.

getNextWindowIndex

public int getNextWindowIndex(
    int windowIndex,
    @Player.RepeatMode int repeatMode,
    boolean shuffleModeEnabled
)

Returns the index of the window after the window at index windowIndex depending on the repeatMode and whether shuffling is enabled.

Parameters
int windowIndex

Index of a window in the timeline.
@Player.RepeatMode int repeatMode

A repeat mode.
boolean shuffleModeEnabled

Whether shuffling is enabled.
Returns
int

The index of the next window, or INDEX_UNSET if this is the last window.

getPeriod

public final Timeline.Period getPeriod(int periodIndex, Timeline.Period period)

Populates a Period with data for the period at the specified index. id and uid will be set to null.

Parameters
int periodIndex

The index of the period.
Timeline.Period period

The Period to populate. Must not be null.
Returns
Timeline.Period

The populated Period, for convenience.

getPeriod

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

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

Parameters
int periodIndex

The index of the period.
Timeline.Period period

The Period to populate. Must not be null.
boolean setIds

Whether id and 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
Timeline.Period

The populated Period, for convenience.

getPeriodByUid

public Timeline.Period getPeriodByUid(Object periodUid, Timeline.Period period)

Populates a Period with data for the period with the specified unique identifier.

Parameters
Object periodUid

The unique identifier of the period.
Timeline.Period period

The Period to populate. Must not be null.
Returns
Timeline.Period

The populated Period, for convenience.

getPeriodCount

public abstract int getPeriodCount()

Returns the number of periods in the timeline.

getPeriodPosition

@UnstableApi
@InlineMe(replacement = "this.getPeriodPositionUs(window, period, windowIndex, windowPositionUs)")
public final Pair<Object, Long> getPeriodPosition(
    Timeline.Window window,
    Timeline.Period period,
    int windowIndex,
    long windowPositionUs
)

getPeriodPosition

@UnstableApi
@InlineMe(replacement = "this.getPeriodPositionUs("
              + "window, period, windowIndex, windowPositionUs, defaultPositionProjectionUs)")
public final @Nullable Pair<Object, Long> getPeriodPosition(
    Timeline.Window window,
    Timeline.Period period,
    int windowIndex,
    long windowPositionUs,
    long defaultPositionProjectionUs
)

getPeriodPositionUs

public final Pair<Object, Long> getPeriodPositionUs(
    Timeline.Window window,
    Timeline.Period period,
    int windowIndex,
    long windowPositionUs
)

Calls getPeriodPositionUs with a zero default position projection.

getPeriodPositionUs

public final @Nullable Pair<Object, Long> getPeriodPositionUs(
    Timeline.Window window,
    Timeline.Period period,
    int windowIndex,
    long windowPositionUs,
    long defaultPositionProjectionUs
)

Converts (windowIndex, windowPositionUs) to the corresponding (periodUid, periodPositionUs). The returned periodPositionUs is constrained to be non-negative, and to be less than the containing period's duration if it is known.

Parameters
Timeline.Window window

A Window that may be overwritten.
Timeline.Period period

A Period that may be overwritten.
int windowIndex

The window index.
long windowPositionUs

The window time, or TIME_UNSET to use the window's default start position.
long defaultPositionProjectionUs

If windowPositionUs is TIME_UNSET, the duration into the future by which the window's position should be projected.
Returns
@Nullable Pair<Object, Long>

The corresponding (periodUid, periodPositionUs), or null if #windowPositionUs is TIME_UNSET, defaultPositionProjectionUs is non-zero, and the window's position could not be projected by defaultPositionProjectionUs.

getPreviousWindowIndex

public int getPreviousWindowIndex(
    int windowIndex,
    @Player.RepeatMode int repeatMode,
    boolean shuffleModeEnabled
)

Returns the index of the window before the window at index windowIndex depending on the repeatMode and whether shuffling is enabled.

Parameters
int windowIndex

Index of a window in the timeline.
@Player.RepeatMode int repeatMode

A repeat mode.
boolean shuffleModeEnabled

Whether shuffling is enabled.
Returns
int

The index of the previous window, or INDEX_UNSET if this is the first window.

getUidOfPeriod

public abstract Object getUidOfPeriod(int periodIndex)

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

Parameters
int periodIndex

The index of the period.
Returns
Object

The unique id of the period.

getWindow

public final Timeline.Window getWindow(int windowIndex, Timeline.Window window)

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

Parameters
int windowIndex

The index of the window.
Timeline.Window window

The Window to populate. Must not be null.
Returns
Timeline.Window

The populated Window, for convenience.

getWindow

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

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

Parameters
int windowIndex

The index of the window.
Timeline.Window window

The Window to populate. Must not be null.
long defaultPositionProjectionUs

A duration into the future that the populated window's default start position should be projected.
Returns
Timeline.Window

The populated Window, for convenience.

getWindowCount

public abstract int getWindowCount()

Returns the number of windows in the timeline.

hashCode

public int hashCode()

isEmpty

public final boolean isEmpty()

Returns whether the timeline is empty.

isLastPeriod

public final boolean isLastPeriod(
    int periodIndex,
    Timeline.Period period,
    Timeline.Window window,
    @Player.RepeatMode int repeatMode,
    boolean shuffleModeEnabled
)

Returns whether the given period is the last period of the timeline depending on the repeatMode and whether shuffling is enabled.

Parameters
int periodIndex

A period index.
Timeline.Period period

A Period to be used internally. Must not be null.
Timeline.Window window

A Window to be used internally. Must not be null.
@Player.RepeatMode int repeatMode

A repeat mode.
boolean shuffleModeEnabled

Whether shuffling is enabled.
Returns
boolean

Whether the period of the given index is the last period of the timeline.

toBundle

@UnstableApi
public final Bundle toBundle()

Returns a Bundle representing the information stored in this object.

The getWindow windows} and periods of an instance restored by fromBundle may have missing fields as described in toBundle and toBundle.