SinglePeriodAdTimeline

@VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)
@UnstableApi
class SinglePeriodAdTimeline : ForwardingTimeline

kotlin.Any
   ↳ 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(
    contentTimeline: Timeline!,
    adPlaybackState: AdPlaybackState!
)

Creates a new timeline with a single period containing ads.

Public functions
Timeline.Period!
getPeriod(periodIndex: Int, period: Timeline.Period!, setIds: Boolean)

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

Inherited Constants
From androidx.media3.common.Timeline
const Timeline!

An empty timeline.

Inherited functions
From androidx.media3.exoplayer.source.ForwardingTimeline
Int
getFirstWindowIndex(shuffleModeEnabled: Boolean)

Returns the index of the first window in the playback order depending on whether shuffling is enabled.
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(shuffleModeEnabled: Boolean)

Returns the index of the last window in the playback order depending on whether shuffling is enabled.
Int
getNextWindowIndex(
    windowIndex: Int,
    @Player.RepeatMode repeatMode: Int,
    shuffleModeEnabled: Boolean
)

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

Returns the number of periods in the timeline.
Int
getPreviousWindowIndex(
    windowIndex: Int,
    @Player.RepeatMode repeatMode: Int,
    shuffleModeEnabled: Boolean
)

Returns the index of the window before the window at index windowIndex depending on the repeatMode and whether shuffling is enabled.
Any!
getUidOfPeriod(periodIndex: Int)

Returns the unique id of the period identified by its index in the timeline.
Timeline.Window!
getWindow(
    windowIndex: Int,
    window: Timeline.Window!,
    defaultPositionProjectionUs: Long
)

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

Returns the number of windows in the timeline.
From androidx.media3.common.Timeline
Timeline!

Returns a copy of this timeline containing just the single specified Window.
Boolean
equals(obj: Any?)
java-static Timeline!

Restores a Timeline from a Bundle.
Int
getNextPeriodIndex(
    periodIndex: Int,
    period: Timeline.Period!,
    window: Timeline.Window!,
    @Player.RepeatMode repeatMode: Int,
    shuffleModeEnabled: Boolean
)

Returns the index of the period after the period at index periodIndex depending on the repeatMode and whether shuffling is enabled.
Timeline.Period!
getPeriod(periodIndex: Int, period: Timeline.Period!)

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

Populates a Period with data for the period with the specified unique identifier.
Pair<Any!, Long!>!
@UnstableApi
@InlineMe(replacement = "this.getPeriodPositionUs(window, period, windowIndex, windowPositionUs)")
getPeriodPosition(
    window: Timeline.Window!,
    period: Timeline.Period!,
    windowIndex: Int,
    windowPositionUs: Long
)

This function is deprecated.

Use getPeriodPositionUs instead.
Pair<Any!, Long!>?
@UnstableApi
@InlineMe(replacement = "this.getPeriodPositionUs(" + "window, period, windowIndex, windowPositionUs, defaultPositionProjectionUs)")
getPeriodPosition(
    window: Timeline.Window!,
    period: Timeline.Period!,
    windowIndex: Int,
    windowPositionUs: Long,
    defaultPositionProjectionUs: Long
)

This function is deprecated.

Use getPeriodPositionUs instead.
Pair<Any!, Long!>!
getPeriodPositionUs(
    window: Timeline.Window!,
    period: Timeline.Period!,
    windowIndex: Int,
    windowPositionUs: Long
)

Calls getPeriodPositionUs with a zero default position projection.
Pair<Any!, Long!>?
getPeriodPositionUs(
    window: Timeline.Window!,
    period: Timeline.Period!,
    windowIndex: Int,
    windowPositionUs: Long,
    defaultPositionProjectionUs: Long
)

Converts (windowIndex, windowPositionUs) to the corresponding (periodUid, periodPositionUs).
Timeline.Window!
getWindow(windowIndex: Int, window: Timeline.Window!)

Populates a Window with data for the window at the specified index.
abstract Timeline.Window!
getWindow(
    windowIndex: Int,
    window: Timeline.Window!,
    defaultPositionProjectionUs: Long
)

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

Returns whether the timeline is empty.
Boolean
isLastPeriod(
    periodIndex: Int,
    period: Timeline.Period!,
    window: Timeline.Window!,
    @Player.RepeatMode repeatMode: Int,
    shuffleModeEnabled: Boolean
)

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

Returns a Bundle representing the information stored in this object.

Inherited properties
From androidx.media3.exoplayer.source.ForwardingTimeline
Timeline!

Public constructors

SinglePeriodAdTimeline

SinglePeriodAdTimeline(
    contentTimeline: Timeline!,
    adPlaybackState: AdPlaybackState!
)

Creates a new timeline with a single period containing ads.

Parameters
contentTimeline: Timeline!

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 functions

getPeriod

fun getPeriod(periodIndex: Int, period: Timeline.Period!, setIds: Boolean): Timeline.Period!

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

Parameters
periodIndex: Int

The index of the period.
period: Timeline.Period!

The Period to populate. Must not be null.
setIds: Boolean

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.