ForwardingTimeline

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public abstract class ForwardingTimeline extends Timeline

java.lang.Object
↳	androidx.media3.common.Timeline
	↳	androidx.media3.exoplayer.source.ForwardingTimeline

Known direct subclasses

FakeMediaSource.InitialTimeline, SinglePeriodAdTimeline, TimelineWithUpdatedMediaItem

`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`.

An overridable Timeline implementation forwarding methods to another timeline.

The following methods call through to super instead of the timeline delegate:

getPeriodByUid
equals
hashCode

Summary

Protected fields
`final Timeline`	`timeline`

Public constructors
`ForwardingTimeline(Timeline timeline)`

Public methods
`final boolean`	`equals(@Nullable Object obj)`
`int`	`getFirstWindowIndex(boolean shuffleModeEnabled)` Returns the index of the first window in the playback order depending on whether shuffling is enabled.
`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.
`int`	`getLastWindowIndex(boolean shuffleModeEnabled)` Returns the index of the last window in the playback order depending on 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.
`Timeline.Period`	`getPeriod(int periodIndex, Timeline.Period period, boolean setIds)` Populates a `Period` with data for the period at the specified index.
`final Timeline.Period`	`getPeriodByUid(Object periodUid, Timeline.Period period)` Populates a `Period` with data for the period with the specified unique identifier.
`int`	`getPeriodCount()` Returns the number of periods in the timeline.
`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.
`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, long defaultPositionProjectionUs )` Populates a `Window` with data for the window at the specified index.
`int`	`getWindowCount()` Returns the number of windows in the timeline.
`final int`	`hashCode()`

Inherited Constants

From androidx.media3.common.Timeline

static final Timeline

EMPTY

An empty timeline.

Inherited methods

From androidx.media3.common.Timeline

`final Timeline`	`@UnstableApi copyWithSingleWindow(int windowIndex)` Returns a copy of this timeline containing just the single specified `Window`.
`static Timeline`	`@UnstableApi fromBundle(Bundle bundle)` Restores a `Timeline` from a `Bundle`.
`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.
`final Timeline.Period`	`getPeriod(int periodIndex, Timeline.Period period)` Populates a `Period` with data for the period at the specified index.
`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)`.
`final Timeline.Window`	`getWindow(int windowIndex, Timeline.Window window)` Populates a `Window` with data for the window at the specified index.
`final boolean`	`isEmpty()` 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`	`@UnstableApi toBundle()` Returns a `Bundle` representing the information stored in this object.

Protected fields

timeline

protected final Timeline timeline

Public constructors

ForwardingTimeline

public ForwardingTimeline(Timeline timeline)

Public methods

equals

public final boolean equals(@Nullable Object obj)

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 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.

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 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 final 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 int getPeriodCount()

Returns the number of periods in the timeline.

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 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 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 int getWindowCount()

Returns the number of windows in the timeline.

hashCode

public final int hashCode()