SinglePeriodAdTimeline

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)
@UnstableApi
public final class SinglePeriodAdTimeline extends ForwardingTimeline

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

A Timeline for sources that have ads.

Summary

Public constructors
`SinglePeriodAdTimeline( Timeline contentTimeline, AdPlaybackState adPlaybackState )` Creates a new timeline with a single period containing ads.

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

Inherited Constants

From androidx.media3.common.Timeline

static final Timeline

EMPTY

An empty timeline.

Inherited fields

From androidx.media3.exoplayer.source.ForwardingTimeline

final Timeline

timeline

Inherited methods

From androidx.media3.exoplayer.source.ForwardingTimeline

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

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.
`abstract Timeline.Window`	`getWindow( int windowIndex, Timeline.Window window, long defaultPositionProjectionUs )` 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.

Public constructors

SinglePeriodAdTimeline

public SinglePeriodAdTimeline(
    Timeline contentTimeline,
    AdPlaybackState adPlaybackState
)

Creates a new timeline with a single period containing ads.

Parameters
`Timeline contentTimeline`	The timeline of the content alongside which ads will be played. It must have one window and one period.
`AdPlaybackState adPlaybackState`	The state of the period's ads.

Public methods

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.